diff options
| author | Ulf Lamping <ulf.lamping@web.de> | 2004-10-16 11:32:07 +0000 |
|---|---|---|
| committer | Ulf Lamping <ulf.lamping@web.de> | 2004-10-16 11:32:07 +0000 |
| commit | a3340a4c2e8d297902e301ab9eedf517e05e27a6 (patch) | |
| tree | 0059211c1e657d0a333266ebc7f24a3dce1dc684 /docbook | |
| parent | 8912ad524b04a9a234f1aea9325004df37fda64c (diff) | |
update to the current state of the art
svn path=/trunk/; revision=12317
Diffstat (limited to 'docbook')
| -rw-r--r-- | docbook/README.txt | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docbook/README.txt b/docbook/README.txt index 00d9b2d737..da414a5490 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -2,14 +2,13 @@ $Id$ This directory contains the source files needed to build the: -Ethereal User's guide (almost ready to release, has to be reviewed) +Ethereal User's guide and the: -Ethereal Developer's Guide (long time unchanged still a very early state). +Ethereal Developer's Guide (in an early state, currently very win32 related). -To build the User's Guide, just do 'make', but see requirements below. -The Developer's Guide is currently not generated, as it has no content. +To build both Guide's, just do 'make', but see requirements below. The guides are written in Docbook/XML (formerly Docbook/SGML). This format is @@ -23,8 +22,8 @@ The current Makefile is running under Win32 in the cygwin environment, so it use GNU make and such. It should be pretty easy to use it in UNIX environments too. Using Microsoft make (nmake) is not supported. -By default the Makefile generates HTML in single page and multiple (chunked) formats. -Optional output formats are PDF and CHM. +By default the Makefile generates HTML in single page and multiple (chunked) formats +and PDF. The optional output format CHM has to be enabled in the Makefile. Requirements: @@ -83,7 +82,10 @@ description of the way the makefile targets are doing things and which output files required for a release in that format. all -Will generate all output formats (see below). +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 eug_html The HTML file is generated using xsltproc and the XSL stylesheets from @@ -111,6 +113,9 @@ 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. + 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). |