This directory contains the source files needed to build the:
-Ethereal User's guide
+Wireshark User's guide
and the:
-Ethereal Developer's Guide (in an early state, currently very win32 related).
+Wireshark Developer's Guide (in an early state).
To build both Guide's, just do 'make', but see requirements below.
java -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
to:
java -Xmx256m -cp "%LOCALCLASSPATH%" org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
+This should be added automatically on unixish systems.
HTML help compiler (for chm file generation only)
-------------------------------------------------
hhc compiler from Microsoft:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
+Packages for Suse 9.3
+---------------------
+Tool/File Package
+--------- -------
+xsltproc: libxslt
+xmllint: libxml2
+fop: fop
+docbook.xsl: docbook-xsl-stylesheets
+chunk.xsl: docbook-xsl-stylesheets
+htmlhelp.xsl: docbook-xsl-stylesheets
+docbookx.dtd: docbook_4
+jimi: N/A - build yourself - see above
+
+Packages for Gentoo
+-------------------
+Like with all packages do...
+Check dependencies: emerge -p <package>
+Install it: emerge <package>
+
+Tool/File Package Opt./Mand. Comments
+--------- ------- ---------- --------
+xsltproc: libxslt M XSLT processer. A very fast processor writtin in C.
+xmllint: libxml2 O Xml Validator. You probably want to install that.
+fop: fop O Only needed to generate PDFs. Has a lot of JAVA dependencies.
+docbook.xsl: docbook-xsl-stylesheets M Necessary docbook catalogs are built automatically by portage in /etc/xml and /etc/sgml
+chunk.xsl: docbook-xsl-stylesheets M using "/usr/bin/build-docbook-catalog".
+htmlhelp.xsl: docbook-xsl-stylesheets M So docbook runs out of the box on Gentoo.
+docbookx.dtd: docbook-xml-dtd M
+jimi: sun-jimi O Jimi is a class library for managing images. Used by fop.
+Quanta+ quanta or kdewebdev O Nice HTML/XML/SGML and Docbook editor with Syntaxhighlighting, Autocompletion, etc.
+
+Tip: The actual DTD version of Gentoo is 4.4, but wireshark docs still use 4.2.
+ To be able to generate the docs, change the version in the second line of developer-guide.xml
+ or install an older version of the DTD.
+ See into the Gentoo handbook howto unmask old versions.
+
+Packages for Fedora Core
+------------------------
+TODO
+
+Packages for Debian
+-------------------
+Tool/File Package
+--------- -------
+xsltproc: libxslt
+xmllint: libxml2-utils
+fop: fop
+docbook.xsl: docbook-xsl
+chunk.xsl: docbook-xsl
+htmlhelp.xsl: docbook-xsl
+docbookx.dtd: docbook-xml
+jimi: N/A - build yourself - see above
Makefile:
---------
all
Will generate both guide's in all available output formats (see below).
-make eug
-Will generate Ethereal User's Guide in all available output formats.
+make wsug
+Will generate Wireshark User's Guide in all available output formats.
-make eug_html
+make wsug_html
The HTML file is generated using xsltproc and the XSL stylesheets from
Norman Walsh. This is a conversion into a single HTML page.
-output: eug_html
+output: wsug_html
-make eug_htmlchunk
+make wsug_html_chunked
The HTML files are generated using xsltproc and the XSL stylesheets from
Norman Walsh. This is a conversion into chunked (multiple) HTML pages.
-output: eug_html_chunked
+output: wsug_html_chunked
-make eug_pdf_us
-make eug_pdf_a4
+make wsug_pdf_us
+make wsug_pdf_a4
The PDF is generated using an intermediate format named XSL-FO (XSL
formatting objects). xsltproc converts the XML to a FO file, and then fop
(apache's formatting object processor) is used to generate the PDF document,
in US letter or A4 paper format.
-TIPP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf,
+TIP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf,
but conversation works just fine.
-output: user-guide.pdf
+output: user-guide-us.pdf user-guide-a4.pdf
-make eug_chm
+make wsug_chm
On Win32 platforms, the "famous" HTML help format can be generated by using a
special HTML chunked conversion and then use the htmlhelp compiler from
Microsoft.
output: htmlhelp.chm
-Using the prefix edg_ instead of eug_ will build the same targets but for the
-Ethereal Developer's Guide.
+Using the prefix wsdg_ instead of wsug_ will build the same targets but for the
+Wireshark Developer's Guide.
-The makefile is written to be run with gmake on unix/linux platforms. Win32
+The makefile is written to be run with gmake on UNIX/Linux platforms. Win32
platforms have to use the cygwin environment (Microsoft nmake is not
supported).
FO Parameter Reference
by Norman Walsh
http://docbook.sourceforge.net/release/xsl/current/doc/fo/
+
git.samba.org / obnox / wireshark / wip.git / blobdiff