5df8df8bcb7b5c4ec07f1fa7880c5f05068460e7
[dwarf-doc.git] / dwarf5 / latexdoc / README
1
2 On undefined references while building the document: In
3 early latex passes forward references tend to be reported as
4 'undefined'.   An example is:
5
6 LaTeX Warning: Reference `chap:generaldescription' on page
7 3 undefined on input line 59.
8
9 Because the side-files latex generates help resolve those in
10 later passes the simple existence of 'undefined' in a 'make'
11 on a 'clean' directory should not be alarming as these will
12 usually be from an early pass.  Run a second 'make' without
13 doing a 'make clean' (thus using the side-files from the first
14 'make') and if all is well the second 'make' will not generate
15 any messages about 'undefined'.
16
17 ============================
18
19 On Linux:
20 On modern linux, here is the set of steps to build a pdf.
21 While pdflatex might seem simpler to use (than the following)
22 it will not correctly generate a pdf as complex as this one.
23
24         latex dwarf5.tex
25         latex dwarf5.tex
26         makeindex dwarf5
27         latex dwarf5.tex
28         latex dwarf5.tex
29         dvips dwarf5.dvi -o dwarf5.ps
30         ps2pdf dwarf5.ps dwarf5.pdf
31
32
33
34 On Windows:
35 To Be added
36
37
38 On Mac OS X:
39 Install the MacTeX distribution from http://www.tug.org/mactex/ 
40 All of the necessary tools will be installed in a directory like
41 /usr/local/texlive/2012/bin/x86_64-darwin/
42
43 The same instructions for Linux will now work.
44
45
46
47
48 The DWARF5 latex document was first added here May 10, 2012.
49 The plan is to achieve a complete (insofar as is possible)
50 identical-to-DWARF4 document (which is referred to as DWARF
51 4.1).  Mark that with a git tag.   Then proceed to change
52 the document with DWARF5 changes.