aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2006-05-30 21:34:56 +0000
committerGerald Combs <gerald@wireshark.org>2006-05-30 21:34:56 +0000
commit6deb90af7b1eee58fe564ebeaee57066bca508e2 (patch)
treef4454704ecae5fd1a516eaf1b8e6f30aef1d5275 /docbook
parentc510c6118efcbb4fb91c64dcb1559008fb2ce457 (diff)
eug -> wsug
svn path=/trunk/; revision=18259
Diffstat (limited to 'docbook')
-rw-r--r--docbook/Makefile46
-rw-r--r--docbook/Makefile.auto.am60
-rw-r--r--docbook/README.txt18
3 files changed, 62 insertions, 62 deletions
diff --git a/docbook/Makefile b/docbook/Makefile
index b45e4527e2..2286ee7541 100644
--- a/docbook/Makefile
+++ b/docbook/Makefile
@@ -221,9 +221,9 @@ CLEANFILES = \
edg_chm \
edg_html \
edg_html_chunked \
- eug_chm \
- eug_html \
- eug_html_chunked \
+ wsug_chm \
+ wsug_html \
+ wsug_html_chunked \
htmlhelp.* \
release_notes_chm \
release-notes.html \
@@ -231,7 +231,7 @@ CLEANFILES = \
svn_version.xml \
-all: eug.validated edg.validated release_notes.validated eug edg release_notes
+all: wsug.validated edg.validated release_notes.validated wsug edg release_notes
clean:
rm -rf $(CLEANFILES)
@@ -250,10 +250,10 @@ svn_version.xml: FORCE
echo '">' >> svn_version.xml
-eug: eug_html_chunked user-guide.html user-guide-a4.pdf user-guide-us.pdf user-guide.chm
+wsug: wsug_html_chunked user-guide.html user-guide-a4.pdf user-guide-us.pdf user-guide.chm
# validate the content
-eug.validated: $(WSUG_SOURCE)
+wsug.validated: $(WSUG_SOURCE)
@ echo --- WSUG - VALIDATING XML ---
$(XMLLINT) --valid --noout $<
touch $@
@@ -261,22 +261,22 @@ eug.validated: $(WSUG_SOURCE)
# create html single page file
user-guide.html: $(WSUG_SOURCE)
@ echo --- WSUG - HTML SINGLE PAGE ---
- mkdir -p eug_html/graphics/toolbar
- cp graphics/*.* eug_html/graphics
- cp graphics/toolbar/* eug_html/graphics/toolbar
- cp ws.css eug_html
- $(XSLTPROC) --stringparam base.dir eug_html/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< > eug_html/$@
- -chmod -R og+rX eug_html
+ mkdir -p wsug_html/graphics/toolbar
+ cp graphics/*.* wsug_html/graphics
+ cp graphics/toolbar/* wsug_html/graphics/toolbar
+ cp ws.css wsug_html
+ $(XSLTPROC) --stringparam base.dir wsug_html/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< > wsug_html/$@
+ -chmod -R og+rX wsug_html
# create html chunked page files
-eug_html_chunked: $(WSUG_SOURCE)
+wsug_html_chunked: $(WSUG_SOURCE)
@ echo --- WSUG - HTML CHUNKED ---
- mkdir -p eug_html_chunked/graphics/toolbar
- cp graphics/*.* eug_html_chunked/graphics
- cp graphics/toolbar/* eug_html_chunked/graphics/toolbar
- cp ws.css eug_html_chunked
- $(XSLTPROC) --stringparam base.dir eug_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl $<
- -chmod -R og+rX eug_html_chunked
+ mkdir -p wsug_html_chunked/graphics/toolbar
+ cp graphics/*.* wsug_html_chunked/graphics
+ cp graphics/toolbar/* wsug_html_chunked/graphics/toolbar
+ cp ws.css wsug_html_chunked
+ $(XSLTPROC) --stringparam base.dir wsug_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl $<
+ -chmod -R og+rX wsug_html_chunked
# create pdf file (through XSL-FO), portrait pages on US letter paper (the default)
# you will get lot's of errors, but that's ok
@@ -298,10 +298,10 @@ endif
user-guide.chm: $(WSUG_SOURCE)
ifdef HHC
@ echo --- WSUG - MICROSOFT HTML HELP ---
- mkdir -p eug_chm/graphics/toolbar
- -cp graphics/*.* eug_chm/graphics/
- -cp graphics/toolbar/* eug_chm/graphics/toolbar/
- $(XSLTPROC) --stringparam base.dir eug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
+ mkdir -p wsug_chm/graphics/toolbar
+ -cp graphics/*.* wsug_chm/graphics/
+ -cp graphics/toolbar/* wsug_chm/graphics/toolbar/
+ $(XSLTPROC) --stringparam base.dir wsug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
-$(HHC) htmlhelp.hhp
-mv htmlhelp.chm $@
-rm -r htmlhelp.hhp
diff --git a/docbook/Makefile.auto.am b/docbook/Makefile.auto.am
index 6470107a5f..70d6035355 100644
--- a/docbook/Makefile.auto.am
+++ b/docbook/Makefile.auto.am
@@ -15,10 +15,10 @@ DOCBOOKXSL="/usr/share/xml/docbook/stylesheet/nwalsh/1.65.1"
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
-# as eug_chm will stop with an error, make sure it's the last in this dependency list
-all: eug edg
+# as wsug_chm will stop with an error, make sure it's the last in this dependency list
+all: wsug edg
-eug: eug_validate eug_pdf_a4 eug_html eug_html_chunked eug_chm
+wsug: wsug_validate wsug_pdf_a4 wsug_html wsug_html_chunked wsug_chm
clean:
rm -f *.html
@@ -28,9 +28,9 @@ clean:
rm -f *.fo
rm -f *.pdf
rm -f *.chm
- rm -rf eug_html
- rm -rf eug_html_chunked
- rm -rf eug_chm
+ rm -rf wsug_html
+ rm -rf wsug_html_chunked
+ rm -rf wsug_chm
rm -rf edg_html
rm -rf edg_html_chunked
rm -rf edg_chm
@@ -42,33 +42,33 @@ images:
cp $(DOCBOOKXSL)/images/warning.png ./graphics
# validate the content
-eug_validate:
+wsug_validate:
@ echo --- VALIDATING XML ---
$(XMLLINT) --valid --noout user-guide.xml
# create html single page file
-eug_html:
+wsug_html:
@ echo --- HTML SINGLE PAGE ---
- mkdir -p eug_html
- mkdir -p eug_html/graphics
- mkdir -p eug_html/graphics/toolbar
- cp ./graphics/*.* eug_html/graphics
- cp ./graphics/toolbar/*.* eug_html/graphics/toolbar
- $(XSLTPROC) --nonet $(DOCBOOKXSL)/html/docbook.xsl user-guide.xml > eug_html/user-guide.html
+ mkdir -p wsug_html
+ mkdir -p wsug_html/graphics
+ mkdir -p wsug_html/graphics/toolbar
+ cp ./graphics/*.* wsug_html/graphics
+ cp ./graphics/toolbar/*.* wsug_html/graphics/toolbar
+ $(XSLTPROC) --nonet $(DOCBOOKXSL)/html/docbook.xsl user-guide.xml > wsug_html/user-guide.html
# create html chunked page files
-eug_html_chunked: images
+wsug_html_chunked: images
@ echo --- HTML CHUNKED ---
- mkdir -p eug_html_chunked
- mkdir -p eug_html_chunked/graphics
- mkdir -p eug_html_chunked/graphics/toolbar
- cp ./graphics/*.* eug_html_chunked/graphics
- cp ./graphics/toolbar/*.* eug_html_chunked/graphics/toolbar
- $(XSLTPROC) --stringparam base.dir eug_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/html/chunk.xsl user-guide.xml
+ mkdir -p wsug_html_chunked
+ mkdir -p wsug_html_chunked/graphics
+ mkdir -p wsug_html_chunked/graphics/toolbar
+ cp ./graphics/*.* wsug_html_chunked/graphics
+ cp ./graphics/toolbar/*.* wsug_html_chunked/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir wsug_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/html/chunk.xsl user-guide.xml
# create pdf file (through XSL-FO), portrait pages on US letter paper (the default)
# you will get lot's of errors, but that's ok
-eug_pdf_us: images
+wsug_pdf_us: images
if HAVE_FOP
@ echo --- PDF US PAPER ---
$(XSLTPROC) --nonet custom_layer_pdf.xsl $(DOCBOOKXSL)/fo/docbook.xsl user-guide.xml > user-guide.fo
@@ -77,7 +77,7 @@ endif
# create pdf file (through XSL-FO), portrait pages on A4 paper
# you will get lot's of errors, but that's ok
-eug_pdf_a4: images
+wsug_pdf_a4: images
if HAVE_FOP
@ echo --- PDF A4 PAPER ---
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl user-guide.xml > user-guide.fo
@@ -85,15 +85,15 @@ if HAVE_FOP
endif
# create MS html help file (through html chunked pages)
-eug_chm: images
+wsug_chm: images
if HAVE_HHC
@ echo --- MICROSOFT HTML HELP ---
- mkdir -p eug_chm
- mkdir -p eug_chm/graphics
- mkdir -p eug_chm/graphics/toolbar
- cp ./graphics/*.* eug_chm/graphics
- cp ./graphics/toolbar/*.* eug_chm/graphics/toolbar
- $(XSLTPROC) --stringparam base.dir eug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/htmlhelp/htmlhelp.xsl user-guide.xml
+ mkdir -p wsug_chm
+ mkdir -p wsug_chm/graphics
+ mkdir -p wsug_chm/graphics/toolbar
+ cp ./graphics/*.* wsug_chm/graphics
+ cp ./graphics/toolbar/*.* wsug_chm/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir wsug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/htmlhelp/htmlhelp.xsl user-guide.xml
-$(HHC) htmlhelp.hhp
mv htmlhelp.chm user-guide.chm
rm -r htmlhelp.hhp
diff --git a/docbook/README.txt b/docbook/README.txt
index afb440cc41..67c1f44d21 100644
--- a/docbook/README.txt
+++ b/docbook/README.txt
@@ -109,21 +109,21 @@ files required for a release in that format.
all
Will generate both guide's in all available output formats (see below).
-make eug
+make wsug
Will generate Ethereal 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_html_chunked
+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,
@@ -132,13 +132,13 @@ TIPP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf,
but conversation works just fine.
output: user-guide.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
+Using the prefix edg_ instead of wsug_ 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