aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user/README
blob: 85e8743f9d8e10f56763c644dc5f962df17a123e (plain) (blame)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Directory lout/doc/user

This directory contains the Lout source files for the User's Guide
to the Lout Document Formatting System.  To produce the Guide,
type the command

	lout -r6 all > user.ps

in this directory.  The -r6 flag causes Lout to run over the
document six times.  This is needed to completely resolve all
cross references, although a readable PostScript file would be
produced after one run if -r was omitted.  Auxiliary files with
.li and .ld suffixes will be created in this directory.  Six runs
is an unusually large number; it is owing to some unfortunate page
breaks in the early runs that so many runs are needed.

The first run will produce a large number of error messages,
nearly all beginning with "unresolved cross reference".  These
should gradually go away on later runs.  The following shows the
error message output on the last run for A4 size printing:

lout:
        : lout -r beginning run 6:
lout file "str_indx" (from "str" line 16, from "all" line 38):
    54,1: 0.3c object too high for 0.1c space; will try elsewhere
lout file "gra_summ" (from "gra" line 44, from "all" line 46):
    10,1: 24.1c object too high for 23.6c space; @Scale inserted
lout file "prg_tabs" (from "prg" line 141, from "all" line 48):
   66,23: prg2lout 2,1: program text ended within comment
   68,35: prg2lout 2,1: program text ended within comment

The first warning is about a footnote that did not fit onto the
first available page.  The next is about a large table that had to be
scaled down slightly to fit on the page.  The last two warnings point
to two places where a C program text ended inside a comment, which in
these cases was deliberate.  If you set the document in Letter size
paper, you will get a somewhat different set of warning messages.

Optimal page breaking has been turned off for this document owing to
repeated failure to converge, caused by footnotes and floating figures
close to large unbreakable displays.

A copy of the final PostScript output file (A4 paper size) is
stored at "ftp://ftp.it.usyd.edu.au/jeff/lout/lout-3.33.user.ps.gz".

Jeffrey H. Kingston
14 November 2006