#DOXYGEN="$(PROGRAM_FILES)/doxygen/bin/doxygen.exe"
#
-# Recommended: Build compressed html help format .chm and use it as online help format.
-# You will have to download and install the html help compiler from:
+# Recommended: Use the compressed html help format .chm as the Wireshark integrated help.
+#
+# The required htmlhelp.h and htmlhelp.lib should be included in MSVC_VARIANT > MSVC6.
+#
+# For MSVC_VARIANT == MSVC6 you will have to download and install the html help workshop from:
#
# http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html
# /hwMicrosoftHTMLHelpDownloads.asp
HHC_DIR="$(PROGRAM_FILES)/HTML Help Workshop/"
-
##### Flags, PATHs and Miscellaneous #####
# Compiler flags:
+##### Advanced: Docbook/XML documentation (e.g. User's Guide) generation #####
+# If you want to generate the Docbook/XML docs (User's, Developer's Guide, ...),
+# you'll need some additional tools / libraries compared to the rest of the build
+# process.
+#
+# FOR DETAILED INSTRUCTIONS SEE THE FILE: docbook\readme.txt.
+#
+# If you don't call the Makefile.nmake in the docbook dir to generate the guides,
+# the following settings will have no effect.
+
+# formatting objects processor executable
+# Commented this out if you don't have fop installed or you
+# don't want PDF documentation.
+#
+# (as of fop-0.20 the cygwin script does not use $FOP_OPTS)
+!IFNDEF FOP
+FOP=fop-0.20.5\fop.bat
+!ENDIF
+
+# Additional options to fop.
+# This needs to contain at least the argument '-Xmx256m'
+FOP_OPTS=-Xmx256m
+
+# html help compiler
+# Commented this out if you don't have hhc.exe or you don't want .chm documentation.
+#
+# Beware: hhc.exe is NOT part of the MSVC packages as mentioned in HHC_DIR above,
+# so you'll need to install the HTML Help Workshop for this.
+HHC_EXE=$(HHC_DIR)\hhc.exe
+
+# html to text converter for text version of release notes, e.g. elinks.
+# This could also be "lynx", or "true" if neither elinks nor lynx is installed
+# (cygwin: lynx works, elinks not available, links and true doesn't produce output)
+#HTML2TXT=elinks -dump -dump-width 72
+#HTML2TXT=links -dump -width 72
+HTML2TXT=lynx -dump -width=72 -nolist -stdin
+#HTML2TXT="true"
+
+# the XSL processor (part of cygwin's libxslt package)
+XSLTPROC="xsltproc"
+
+# the XML validator (part of cygwin's libxml2 package)
+XMLLINT="xmllint"
+
+
##############################################################################
#
# $Id$
#
-# formatting objects processor
-# Additional options to fop.
-# This needs to contain at least the argument '-Xmx256m'
-FOP_OPTS=-Xmx256m
-
-# fop executable
-# Leave these commented out if you don't have fop installed or you
-# don't want PDF documentation.
-#
-# (as of fop-0.20 the cygwin script does not use $FOP_OPTS)
-!IFNDEF FOP
-FOP=fop-0.20.5\fop.bat
-!ENDIF
-
-# html help compiler
-# Leave these commented out if you don't have HHC installed or you
-# don't want CHM documentation.
-HHC="C:\Program Files\HTML Help Workshop\hhc.exe"
-
-# html to text converter for text version of release notes, e.g. elinks.
-# This could also be "lynx", or "true" if neither elinks nor lynx is installed
-# (cygwin: lynx works, elinks not available, links and true doesn't produce output)
-#HTML2TXT=elinks -dump -dump-width 72
-#HTML2TXT=links -dump -width 72
-HTML2TXT=lynx -dump -width=72 -nolist -stdin
-#HTML2TXT="true"
-
-# the XSL processor
-XSLTPROC="xsltproc"
-
-# the XML validator (from the xsltproc package)
-XMLLINT="xmllint"
-
-
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
include ..\config.nmake
# create MS html help file (through html chunked pages)
user-guide.chm: $(WSUG_SOURCE)
-!ifdef HHC
+!ifdef HHC_EXE
@ echo --- WSUG - MICROSOFT HTML HELP ---
if not exist wsug_chm\wsug_graphics\toolbar md wsug_chm\wsug_graphics\toolbar
-cp wsug_graphics/*.* wsug_chm/wsug_graphics/
-cp wsug_graphics/toolbar/* wsug_chm/wsug_graphics/toolbar/
$(XSLTPROC) --stringparam base.dir wsug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path wsug_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 user-guide.xml
- -$(HHC) htmlhelp.hhp
+ -$(HHC_EXE) htmlhelp.hhp
-mv htmlhelp.chm $@
-rm -r htmlhelp.hhp
-rm -r toc.hhc
# create MS html help file (through html chunked pages)
developer-guide.chm: $(WSDG_SOURCE)
-!ifdef HHC
+!ifdef HHC_EXE
@ echo --- WSDG - MICROSOFT HTML HELP ---
if not exist wsdg_chm\wsdg_graphics md wsdg_chm\wsdg_graphics
cp wsdg_graphics/* wsdg_chm/wsdg_graphics
$(XSLTPROC) --stringparam base.dir wsdg_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path wsdg_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 developer-guide.xml
- -$(HHC) htmlhelp.hhp
+ -$(HHC_EXE) htmlhelp.hhp
-mv htmlhelp.chm $@
-rm -r htmlhelp.hhp
-rm -r toc.hhc
# create MS html help file (through html chunked pages)
release-notes.chm: $(RELEASE_NOTES_SOURCE)
-!ifdef HHC
+!ifdef HHC_EXE
@ echo --- RELEASE NOTES - MICROSOFT HTML HELP ---
$(XSLTPROC) --stringparam base.dir release_notes_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path wsug_graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl release-notes.xml
- -$(HHC) htmlhelp.hhp
+ -$(HHC_EXE) htmlhelp.hhp
-mv htmlhelp.chm $@
-rm -r htmlhelp.hhp
-rm -r toc.hhc
git.samba.org / metze / wireshark / wip.git / commitdiff