aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/README.txt
diff options
context:
space:
mode:
authorjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>2006-06-06 23:08:58 +0000
committerjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>2006-06-06 23:08:58 +0000
commitaca778f882c3c5efc4704915f55fdbeb92308659 (patch)
treefc49824b23c7bf06f6de3bff32056fdf585dfbe7 /docbook/README.txt
parenta2df599ae0926114d0c128b3e629338909ac7770 (diff)
edg -> wsdg
-This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@18368 f5534014-38df-0310-8fa8-9805f1628bb7
Diffstat (limited to 'docbook/README.txt')
-rw-r--r--docbook/README.txt28
1 files changed, 19 insertions, 9 deletions
diff --git a/docbook/README.txt b/docbook/README.txt
index 67c1f44d21..1c64bf668a 100644
--- a/docbook/README.txt
+++ b/docbook/README.txt
@@ -2,11 +2,11 @@ $Id$
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.
@@ -98,7 +98,16 @@ TODO
Packages for Debian
-------------------
-TODO
+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:
---------
@@ -110,7 +119,7 @@ all
Will generate both guide's in all available output formats (see below).
make wsug
-Will generate Ethereal User's Guide in all available output formats.
+Will generate Wireshark User's Guide in all available output formats.
make wsug_html
The HTML file is generated using xsltproc and the XSL stylesheets from
@@ -128,9 +137,9 @@ 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 wsug_chm
On Win32 platforms, the "famous" HTML help format can be generated by using a
@@ -138,10 +147,10 @@ special HTML chunked conversion and then use the htmlhelp compiler from
Microsoft.
output: htmlhelp.chm
-Using the prefix edg_ instead of wsug_ 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).
@@ -165,3 +174,4 @@ http://www.codeproject.com/winhelp/docbook_howto.asp
FO Parameter Reference
by Norman Walsh
http://docbook.sourceforge.net/release/xsl/current/doc/fo/
+