Add the recent fix for CID 105.
[obnox/wireshark/wip.git] / docbook / README.txt
1 $Id$
2
3 This directory contains the source files needed to build the:
4
5 Ethereal User's guide
6
7 and the:
8
9 Ethereal Developer's Guide  (in an early state, currently very win32 related).
10
11 To build both Guide's, just do 'make', but see requirements below.
12
13
14 The guides are written in Docbook/XML (formerly Docbook/SGML). This format is 
15 now used by many other documentation projects, e.g. "the linux documentation 
16 project" uses it too.
17
18 To get HTML, PDF or other output formats, conversions are done using XSL 
19 stylesheets, which provides a flexible way for these conversions.
20
21 The current Makefile is running under Win32 in the cygwin environment, so it uses 
22 GNU make and such. It should be pretty easy to use it in UNIX environments too.
23 Using Microsoft make (nmake) is not supported.
24
25 By default the Makefile generates HTML in single page and multiple (chunked) formats 
26 and PDF. The optional output format CHM has to be enabled in the Makefile.
27
28
29 Requirements:
30 -------------
31
32 Settings in Makefile and catalog.xml
33 ------------------------------------
34 You have to edit the settings in these files, to point to the DTD/XSL files, fop (and possibly hhc).
35
36 DocBook XML DTD
37 ---------------
38 DocBook "official" XML DTD V4.2 from:
39 http://www.oasis-open.org/docbook/xml/
40 (or using cygwin package docbook-xml42)
41
42 DocBook XSL
43 -----------
44 The "official" XSL stylesheets from Norman Walsh:
45 http://docbook.sourceforge.net/
46 (or using cygwin package docbook-xsl)
47
48 xsltproc
49 --------
50 The XSL processor xsltproc. 
51 (it seems to be packages libxml2 and libxslt, ... please give comments)
52
53 FOP processor (for PDF generation only)
54 ---------------------------------------
55 FOP processor from the apache project:
56 http://xml.apache.org/fop/
57 FOP is a JAVA program, so you need to have a JAVA environment installed.
58 I have put the fop-0.20.5 dir right into the sources dir. If you have it somewhere else,
59 you'll have to change the setting in the Makefile.
60
61 Be sure to also have installed JAI and/or jimi to be able to use/convert the png graphics files.
62 The fop release note webpage tells how to do it: 
63 download jimi from:
64 http://java.sun.com/products/jimi/
65 then extract the archive, then copy JimiProClasses.zip to FOP's lib dir and rename it to jimi-1.0.jar.
66
67 As I got OutOfMemoryException when running fop, I had to insert -Xmx256m into the last line of the fop.bat file from:
68 java -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
69 to:
70 java -Xmx256m -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
71 This should be added automatically on unixish systems.
72
73 HTML help compiler (for chm file generation only)
74 -------------------------------------------------
75 hhc compiler from Microsoft:
76 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp 
77
78 Packages for Suse 9.3
79 ---------------------
80 Tool/File       Package
81 ---------       -------
82 xsltproc:       libxslt
83 xmllint:        libxml2
84 fop:            fop
85 docbook.xsl:    docbook-xsl-stylesheets
86 chunk.xsl:      docbook-xsl-stylesheets
87 htmlhelp.xsl:   docbook-xsl-stylesheets
88 docbookx.dtd:   docbook_4
89 jimi:           N/A - build yourself - see above
90
91 Packages for Gentoo
92 -------------------
93 TODO
94
95 Packages for Fedora Core
96 ------------------------
97 TODO
98
99 Packages for Debian
100 -------------------
101 TODO
102
103 Makefile:
104 ---------
105 There are several ways and tools to do these conversion, following is a short 
106 description of the way the makefile targets are doing things and which output 
107 files required for a release in that format.
108
109 all
110 Will generate both guide's in all available output formats (see below).
111
112 make eug
113 Will generate Ethereal User's Guide in all available output formats.
114
115 make eug_html
116 The HTML file is generated using xsltproc and the XSL stylesheets from 
117 Norman Walsh. This is a conversion into a single HTML page.
118 output: eug_html
119
120 make eug_html_chunked
121 The HTML files are generated using xsltproc and the XSL stylesheets from 
122 Norman Walsh. This is a conversion into chunked (multiple) HTML pages.
123 output: eug_html_chunked
124
125 make eug_pdf_us
126 make eug_pdf_a4
127 The PDF is generated using an intermediate format named XSL-FO (XSL 
128 formatting objects). xsltproc converts the XML to a FO file, and then fop 
129 (apache's formatting object processor) is used to generate the PDF document, 
130 in US letter or A4 paper format.
131 TIPP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf, 
132 but conversation works just fine.
133 output: user-guide.pdf
134
135 make eug_chm
136 On Win32 platforms, the "famous" HTML help format can be generated by using a 
137 special HTML chunked conversion and then use the htmlhelp compiler from 
138 Microsoft.
139 output: htmlhelp.chm
140
141 Using the prefix edg_ instead of eug_ will build the same targets but for the 
142 Ethereal Developer's Guide.
143
144 The makefile is written to be run with gmake on unix/linux platforms. Win32 
145 platforms have to use the cygwin environment (Microsoft nmake is not 
146 supported).
147
148
149 Docbook web references:
150 -----------------------
151 Some web references to further documentation about Docbook/XML and Docbook XSL conversions:
152
153 DocBook: The Definitive Guide
154 by Norman Walsh and Leonard Muellner
155 http://www.docbook.org/tdg/en/html/docbook.html
156
157 DocBook XSL: The Complete Guide
158 by Bob Stayton
159 http://www.sagehill.net/docbookxsl/index.html
160
161 Documention with DocBook on Win32
162 by Jim Crafton
163 http://www.codeproject.com/winhelp/docbook_howto.asp
164
165 FO Parameter Reference
166 by Norman Walsh
167 http://docbook.sourceforge.net/release/xsl/current/doc/fo/