1 02/05/85  format_string, fstr
 2 
 3 Syntax as a command:  fstr {-control_args} text
 4 
 5 
 6 Syntax as an active function:  [fstr {-control_args} text]
 7 
 8 
 9 Function: uses format_document_$string to fill and optionally adjust a
10 text string.  As a command, it prints the filled and adjusted text; as
11 an active function, it requotes the return value.
12 
13 
14 Arguments:
15 text
16    is the text strings to be filled.  If you give more than one, they
17    are concatenated, separated by a space.  All arguments that do not
18    begin with a minus and are not an operand of a preceding control
19    argument are treated as text strings, and so are all arguments
20    following the first text string encountered, whether or not they
21    begin with a minus.
22 
23 
24 Control arguments:
25 -adjust, -adj
26    left- and right-justifies text.
27 -break_word
28    to prevent line length from being exceeded, arbitrarily breaks into
29    two or more parts words that are longer than the current line length
30    and that cannot be hyphenated (when you use -hyphenate).  (Default)
31 -column N, -col N
32    formats text as if N-1 characters already appeared on the first
33    line.  The output begins at column N.  (Default: 1)
34 -hyphenate {N}, -hph {N}
35    changes the default hyphenation mode from OFF to ON.  The optional
36    parameter N is the length of the smallest separated word part; its
37    default value is 2.
38 
39 
40 -indent N, -ind N
41    indents output N spaces from the left margin.  (Default: 0)
42 -line_length N, -ll N
43    sets the line length to N characters.  (Default: 65)
44 -no_adjust, -nadj
45    turns off justification.  (Default)
46 -no_break_word
47    does not brake words longer than the line length; instead, it
48    returns a line longer than the given line length.
49 -no_hyphenate, -nhph
50    turns off hyphenation.  (Default)
51 
52 
53 -string text, -str text
54    treats all remaining arguments as part of the text to be formatted.
55 -undent N, -und N
56    undents the first line by N characters.  If N is negative, the first
57    line is indented (with respect to the -indent value) by N
58    characters.