1LOUT(1)                     General Commands Manual                    LOUT(1)
2
3
4

NAME

6       lout - prepare Lout document for printing
7

SYNOPSIS

9       lout [ options ] file...
10

DESCRIPTION

12       Invoke  the  Basser  Lout interpreter on the concatenation of the named
13       files, producing a PostScript file  on  standard  output  suitable  for
14       printing  on  PostScript printers using lpr(1).  If no files are named,
15       stdin is used instead.  The special file name `-' may be used to denote
16       standard  input.  White space between flags and their associated option
17       values is optional.
18
19       An optional .lt suffix may be used for Lout source and  include  files.
20       When invoking files ending in this suffix the suffix may be omitted.
21

OPTIONS

23   Output
24       -o filename
25              Direct output to filename instead of to stdout.
26
27       -e filename
28              Direct error messages to filename instead of to stderr.
29
30       -a     Use  "filename:linenum:colnum:message" alternative error message
31              format (useful with Emacs compilation mode and other tools).
32
33   Output format
34       -EPS   Produce output in the form of an EPS  (Encapsulated  PostScript)
35              file,  suitable  for inclusion in another document.  Useful with
36              stand-alone illustrations.
37
38       -p     Produce plain text output instead of PostScript.
39
40       -P     Like -p, but with a form-feed character between pages.
41
42       -Z     Produce Adobe  Portable  Document  Format  (PDF)  output.   This
43              includes  links, but the more advanced graphics packages of Lout
44              are not supported.
45
46       -PDF   Synonym for -Z.
47
48       -t     Ignore texture-changing options; everything that would otherwise
49              have  been  printed  using  a  texture  will be printed in solid
50              colour.
51
52   Cross-reference database
53       -s     Suppress all reading and writing of the  cross  reference  data‐
54              base; other databases are not affected.  Useful when many simple
55              documents that don't do any cross referencing are stored in  one
56              directory.
57
58       -l     Use  ASCII  order  when  sorting index entries etc.; the default
59              depends on the COLLATE compilation option (use -V option to find
60              out your default value).
61
62       -L     Use  your  locale's  order  when sorting index entries etc.; the
63              default depends on the COLLATE compilation option (use -V option
64              to find out your default value).
65
66   Execution of filters
67       -S     Safe  execution: disable all calls to system(3), instead echoing
68              the commands that would have been executed.  Although this makes
69              the  Lout run certainly safe, the PostScript output file may not
70              be.
71
72       -U     Unsafe execution: allow calls to system(3).  This is usually the
73              default  behavior, but it is possible to make safe execution the
74              default during installation (use -V option to find  out  whether
75              this was done or not), hence the need for this flag.
76
77   Changing document setup options
78       --option{value}
79              Set setup file option to value, overriding any value assigned to
80              option in the setup file.  For example, --@PageType{Letter} will
81              set the @PageType setup file option to Letter.  The value may be
82              a sequence of words but not an arbitrary Lout object.  If  there
83              are spaces you must ensure that it is passed to Lout as a single
84              option; the usual way to do this is to enclose it in quotes.
85
86   Searching for files
87       -i filename
88              Search the directories of the include file path (see below)  for
89              filename  or  filename.lt and include it.  There may be multiple
90              -i options.
91
92       -I dirname
93              Add dirname to the list of  directories  searched  for  @Include
94              files  and  -i  option files.  There may be multiple -I options.
95              @Include first searches the current directory, then searches the
96              -I  directories  in  the  order  given, and finally searches the
97              default include file directory (see below).  @SysInclude and the
98              -i option omit the search of the current directory.
99
100       -C dirname
101              Add dirname to the list of directories searched for Lout charac‐
102              ter mapping (.LCM) files.  There may be multiple -C options; the
103              directories  are  searched  in  the order given, and finally the
104              default character mappings directory is searched (see below).
105
106       -F dirname
107              Add dirname to the list of directories searched for font metrics
108              (formerly  .AFM)  files.   There may be multiple -F options; the
109              directories are searched in the order  given,  and  finally  the
110              default font metrics directory is searched (see below).
111
112       -H dirname
113              Add  dirname to the list of directories searched for hyphenation
114              patterns files, both unpacked (.lh) and packed (.lp).  There may
115              be  multiple  -H  options;  the  directories are searched in the
116              order given, and finally the default  hyphenation  directory  is
117              searched (see below).
118
119       -D dirname
120              Add  dirname  to the list of directories searched for Lout data‐
121              base files.   There  may  be  multiple  -D  options.   @Database
122              searches  the  current directory, then the -D directories in the
123              order given, and finally searches the default  databases  direc‐
124              tory  (see below).  @SysDatabase omits the search of the current
125              directory.
126
127   Miscellaneous options
128       -r num Run Lout num times, producing output only on the last run.  Use‐
129              ful for bringing cross references up to date quickly.
130
131       -x     Initializing  run, not for ordinary use: read and check all font
132              files mentioned in font definitions, read and check all  hyphen‐
133              ation  files  mentioned  in  language definitions and build com‐
134              pressed versions, read and check all database files mentioned in
135              database clauses and build index files.
136
137       -u     Print usage information on stderr and exit.
138
139       -V     Print version information on stderr and exit.
140
141       -M     Use  less  memory and run more slowly (the cross reference data‐
142              base index will be kept in a file rather than in memory).
143
144       -w     Show the total number of non-empty words printed in  the  output
145              file.  This includes words and numbers in page headers and foot‐
146              ers; section numbers and other numbers; every punctuation  char‐
147              acter in a font different from its adjacent word; and every lit‐
148              tle fragment of every equation; so it will always somewhat over‐
149              estimate the true number.
150

FILES AND ENVIRONMENT VARIABLE

152       Default include file directory:   LOUTLIB/include
153       Default databases directory:      LOUTLIB/data
154       Default font metrics directory:   LOUTLIB/font
155       Default hyphenation directory:    LOUTLIB/hyph
156       Default character mappings dir.:  LOUTLIB/maps
157       Default locales directory:        LOUTLIB/locale
158
159       The  default  library  directory,  usually  /usr/local/lib/lout, can be
160       changed by setting  environment  variable  LOUTLIB  to  an  alternative
161       directory name.
162

SEE ALSO

164       prg2lout(1), lpr(1), ghostview(1)
165

REFERENCES

167       Jeffrey  H.  Kingston,  “A User's Guide to the Lout Document Formatting
168       System”, and “An Expert's Guide to the Lout  Document  Formatting  Sys‐
169       tem”.
170

AUTHOR

172       Jeffrey H. Kingston
173
174
175
176                                                                       LOUT(1)
Impressum