aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user/README
blob: 86f6ce27ad4c199cb1a805b01cd9699ef55bcc22 (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
48
49
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 all > op

in this directory.  Owing to some unfortunate page breaks in the
early runs, this must be done six times to completely resolve
all cross references, although the PostScript file op is printable
after the first run.  Auxiliary files with .li and .ld suffixes
will be created in this directory.

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 later runs for A4 size printing:

lout file "typ_repo" (from "typ" line 19, from "all" line 38):
    38,1: 1.0c object too high for 0.2c space; will try elsewhere
lout file "typ_over" (from "typ" line 21, from "all" line 38):
     8,1: 1.0c object too high for 0.0c space; will try elsewhere
lout file "gra_summ" (from "gra" line 44, from "all" line 45):
     8,1: 23.6c object too high for 23.6c space; @Scale inserted
lout file "prg_tabs" (from "prg" line 108, from "all" line 46):
   58,23: prg2lout 2,1: program text ended within comment
   60,35: prg2lout 2,1: program text ended within comment

The first two warnings are about footnotes whose first lines did not
fit on the bottom of the current page, so had to begin on the following
page.  The third warning is about a large table that had to be scaled
down very slightly to fit on the page (lengths are printed to one
decimal place, which in this case gives the misleading impression
that the table did actually fit to begin with).  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.cs.su.oz.au/jeff/lout/lout-3.26.user.ps.gz".

Jeffrey H. Kingston
16 October 2002