forked from osmocom/wireshark
181 lines
6.7 KiB
Makefile
181 lines
6.7 KiB
Makefile
#
|
|
# Make the "Ethereal User's Guide" in several formats.
|
|
# See the Readme.txt file for instructions.
|
|
#
|
|
# $Id$
|
|
#
|
|
|
|
# formatting objects processor
|
|
# Additional options to fop.
|
|
# This needs to contain at least the argument '-Xmx256m'
|
|
FOP_OPTS=-Xmx256m
|
|
# (comment this out, if you don't want pdf or don't have fop installed)
|
|
# for win32 (cygwin) environments (as of fop-0.20 the cygwin script does
|
|
# not use $FOP_OPTS)
|
|
FOP=FOP_OPTS="$(FOP_OPTS)" fop-0.20.5/fop.bat
|
|
# for unix like environments (if you have problems with fop, try to use an absolute path here)
|
|
#FOP="/usr/share/fop-0.20.5/fop.sh"
|
|
# One SUSE 9.1 and 9.2 uncomment the following line (make sure you have at least fop-0.20.5-71.2)
|
|
#FOP=FOP_OPTS="$(FOP_OPTS)" fop
|
|
|
|
# html help compiler (Win32 only)
|
|
# (comment this out, if you don't want chm or don't have hhc installed)
|
|
HHC="/cygdrive/c/Program Files/HTML Help Workshop/hhc.exe"
|
|
#HHC="true"
|
|
|
|
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
|
|
|
|
# the XSL processor
|
|
XSLTPROC="xsltproc"
|
|
|
|
# the XML validator (from the xsltproc package)
|
|
XMLLINT="xmllint"
|
|
|
|
all: eug edg
|
|
|
|
clean:
|
|
rm -f *.html
|
|
rm -f htmlhelp.*
|
|
rm -f *.hhc
|
|
rm -f *.hhp
|
|
rm -f *.fo
|
|
rm -f *.pdf
|
|
rm -f *.chm
|
|
rm -f svn_version.xml
|
|
rm -rf eug_html
|
|
rm -rf eug_html_chunked
|
|
rm -rf eug_chm
|
|
rm -rf edg_html
|
|
rm -rf edg_html_chunked
|
|
rm -rf edg_chm
|
|
|
|
|
|
eug: eug_validate eug_pdf_a4 eug_pdf_us eug_html eug_html_chunked eug_chm
|
|
|
|
#
|
|
# on every build, record the working copy revision string
|
|
#
|
|
# FORCE is the portable version of .PHONY
|
|
FORCE:
|
|
|
|
svn_version.xml: FORCE
|
|
echo -n '<!ENTITY SvnVersion "' > svn_version.xml
|
|
svnversion -n . >> svn_version.xml
|
|
echo '">' >> svn_version.xml
|
|
|
|
# validate the content
|
|
eug_validate: svn_version.xml
|
|
@ echo --- VALIDATING XML ---
|
|
$(XMLLINT) --valid --noout user-guide.xml
|
|
|
|
# create html single page file
|
|
eug_html: svn_version.xml
|
|
@ 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 http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl user-guide.xml > eug_html/user-guide.html
|
|
|
|
# create html chunked page files
|
|
eug_html_chunked: svn_version.xml
|
|
@ 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 http://docbook.sourceforge.net/release/xsl/current/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: svn_version.xml
|
|
ifdef FOP
|
|
@ echo --- PDF US PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type letter --nonet custom_layer_pdf.xsl user-guide.xml > user-guide-us.fo
|
|
$(FOP) user-guide-us.fo user-guide-us.pdf
|
|
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: svn_version.xml
|
|
ifdef FOP
|
|
@ echo --- PDF A4 PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl user-guide.xml > user-guide-a4.fo
|
|
$(FOP) user-guide-a4.fo user-guide-a4.pdf
|
|
endif
|
|
|
|
# create MS html help file (through html chunked pages)
|
|
eug_chm: svn_version.xml
|
|
ifdef 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 http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl user-guide.xml
|
|
-$(HHC) htmlhelp.hhp
|
|
-mv htmlhelp.chm user-guide.chm
|
|
-rm -r htmlhelp.hhp
|
|
-rm -r toc.hhc
|
|
endif
|
|
|
|
|
|
edg: edg_validate edg_html_chunked edg_pdf_a4 edg_pdf_us edg_html edg_chm
|
|
|
|
# validate the content
|
|
edg_validate: svn_version.xml
|
|
@ echo --- VALIDATING XML ---
|
|
$(XMLLINT) --valid --noout developer-guide.xml
|
|
|
|
# create html single page file
|
|
edg_html: svn_version.xml
|
|
@ echo --- HTML SINGLE PAGE ---
|
|
mkdir -p edg_html
|
|
mkdir -p edg_html/edg_graphics
|
|
cp ./edg_graphics/*.* edg_html/edg_graphics
|
|
$(XSLTPROC) --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl developer-guide.xml > edg_html/developer-guide.html
|
|
|
|
# create html chunked page files
|
|
edg_html_chunked: svn_version.xml
|
|
@ echo --- HTML CHUNKED ---
|
|
mkdir -p edg_html_chunked
|
|
mkdir -p edg_html_chunked/edg_graphics
|
|
cp ./edg_graphics/*.* edg_html_chunked/edg_graphics
|
|
$(XSLTPROC) --stringparam base.dir edg_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path edg_graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl developer-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
|
|
edg_pdf_us: svn_version.xml
|
|
ifdef FOP
|
|
@ echo --- PDF US PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type letter --nonet custom_layer_pdf.xsl developer-guide.xml > developer-guide-us.fo
|
|
$(FOP) developer-guide-us.fo developer-guide-us.pdf
|
|
endif
|
|
|
|
# create pdf file (through XSL-FO), portrait pages on A4 paper
|
|
# you will get lot's of errors, but that's ok
|
|
edg_pdf_a4: svn_version.xml
|
|
ifdef FOP
|
|
@ echo --- PDF A4 PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl developer-guide.xml > developer-guide-a4.fo
|
|
$(FOP) developer-guide-a4.fo developer-guide-a4.pdf
|
|
endif
|
|
|
|
# create MS html help file (through html chunked pages)
|
|
edg_chm: svn_version.xml
|
|
ifdef HHC
|
|
@ echo --- MICROSOFT HTML HELP ---
|
|
mkdir -p edg_chm
|
|
mkdir -p edg_chm/edg_graphics
|
|
cp ./edg_graphics/*.* edg_chm/edg_graphics
|
|
$(XSLTPROC) --stringparam base.dir edg_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path edg_graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl developer-guide.xml
|
|
-$(HHC) htmlhelp.hhp
|
|
-mv htmlhelp.chm developer-guide.chm
|
|
-rm -r htmlhelp.hhp
|
|
-rm -r toc.hhc
|
|
endif
|
|
|