File: set_margin.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (28 lines) | stat: -rw-r--r-- 870 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
\DOC set_margin

\TYPE {set_margin : (int -> int)}

\SYNOPSIS
Changes the limit on the width of the output produced by the pretty-printer.

\DESCRIBE
{set_margin i} sets the limit on the width of the output produced by the
pretty-printer to the integer {i}. The pretty-printer will try to avoid
exceeding this limit by breaking the text into multiple lines. However it can
only break at points specified by the functions that send text to it. The
result of a call to {set_margin} is the value to which the margin was
previously set.

\FAILURE
Never fails.

\USES
Obtaining readable output when using a text window of non-standard width.
It is a good idea to set the margin to a few characters less than the actual
width of the window; for example the default is 72 for an 80 character wide
display.

\SEEALSO
print_begin, print_end, print_newline, print_break.

\ENDDOC