31b5ec7e404e5f664eeae8f53181473896eee641
[rrq/maintain_lilo.git] / doc / README
1 Generating the README
2 =====================
3
4 In order to (re)generate the plain ASCII documentation that is found in
5 lilo/README, Perl 4 or 5 must be installed on your system.
6 Just type
7
8 make ../README
9
10 to perform the conversion. Note that fairly large amounts of virtual memory
11 (16 MB or more) are allocated during the process.
12
13
14 Printing the documentation
15 ==========================
16
17 You need the following programs to generate a printable file from the
18 LaTeX and FIG sources:
19
20   - LaTeX
21   - fig2dev from the transfig package (optional)
22
23 The LaTeX translations of the FIG files are already included in the
24 distribution, so you can print the documentation without fig2dev.
25 WARNING: 'make distclean'  removes those pre-built LaTeX files.
26
27 You can also omit all drawings by typing  make dummies . The drawings
28 are only necessary when processing the technical overview document.
29
30 To run LaTeX just type
31
32 make
33
34 LaTeX issues many "Overfull \hbox" warnings. They can be safely ignored.
35 LaTeX will be run repeatedly until it stops issuing the message
36 LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.
37
38 Finally, you have to convert the device-independent file doc.dvi to
39 something your printer understands. The actual command to perform this
40 depends on your local installation. Example:
41
42 dvips user | lpr
43
44 (Another way is to use GhostScript. To generate HP DeskJet output by
45 converting the DVI file to PostScript as an intermediate step, use this
46 command
47
48 dvips -r1 -f1 user | gs -q -sDEVICE=deskjet -sOutputFile=/dev/lp1 -
49
50 gs -h  lists all configured drivers.)
51
52 If you don't have access to LaTeX but if you can print PostScript, you
53 should get the file(s) lilo.<part>.<version>.ps.gz from the same place
54 where you've obtained lilo.<version>.tar.gz  That file contains the
55 document user.tex (<part> = u) or tech.tex (<part> = t) already translated
56 to PostScript.