diff options
author | Jaap Keuter <jaap.keuter@xs4all.nl> | 2009-12-20 14:49:49 +0000 |
---|---|---|
committer | Jaap Keuter <jaap.keuter@xs4all.nl> | 2009-12-20 14:49:49 +0000 |
commit | b4a185a32504550b672770f94c9dbaba8f7ec3d0 (patch) | |
tree | 626a2f3da54b3e973e65dfe3080e45b20635f9d0 /docbook | |
parent | 0e6059ec0644f84ba016ce553abb99bf3bafdbae (diff) |
Clean up the docbook source code, apply proper tags, update references.
Update readme information, add some editing information for authors.
svn path=/trunk/; revision=31326
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/README.txt | 117 | ||||
-rw-r--r-- | docbook/developer-guide.xml | 5 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_quick_setup.xml | 177 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_sources.xml | 93 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_tools.xml | 137 |
5 files changed, 286 insertions, 243 deletions
diff --git a/docbook/README.txt b/docbook/README.txt index 4a6b3f6306..c8a50c6b6d 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -20,7 +20,7 @@ To get HTML, PDF or other output formats, conversions are done using XSL stylesheets, which provides a flexible way for these conversions. By default the Makefile generates HTML in single page and multiple (chunked) -formats and PDF. +formats and two PDF's. Win32 only: The optional output format CHM has to be enabled by setting HHC_EXE in ..\config.nmake. @@ -30,13 +30,13 @@ Settings: --------- Unix only: Makefile and catalog.xml ------------------------------------------------ +----------------------------------- You have to edit the settings in these files, to point to the DTD/XSL files -and fop. (Makefile.auto.am is currently experimental and will probably NOT +and FOP. (Makefile.auto.am is currently experimental and will probably NOT work - any progress on this would be appreciated!) Win32 only: ..\config.nmake ---------------------------------------- +--------------------------- Settings moved to: ..\config.nmake. @@ -47,23 +47,23 @@ DocBook XML DTD --------------- DocBook "official" XML DTD V4.2: http://www.oasis-open.org/docbook/xml/ -(available as a package for Linux / cygwin) +(available as a package for Linux / Cygwin) DocBook XSL ----------- The "official" XSL stylesheets from Norman Walsh: http://docbook.sourceforge.net/ -(available as a package for Linux / cygwin) +(available as a package for Linux / Cygwin) xsltproc -------- The XSL processor xsltproc. -(available as a package for Linux / cygwin) +(available as a package for Linux / Cygwin) xmllint ------- Needed to validate if the .xml files conform to the Docbook/XML DTD. -(available as a package for Linux / cygwin) +(available as a package for Linux / Cygwin) FOP processor (for PDF generation only) --------------------------------------- @@ -80,28 +80,29 @@ by adding " -Xmx256m" to the FOP_OPTS environment variable. The Windows makefile does this by default. Hyphenation Patterns ------------------------------- +-------------------- Hyphenation patterns for FOP can be found at http://offo.sourceforge.net/hyphenation/. Different pattern files have different licenses. The English patterns may have restrictions on commercial use. -JIMI (for PDF generation with fop 0.20.5 only) ------------------------------- +JIMI (for PDF generation) +------------------------- Jimi is a JAVA class library for managing images. In addition to FOP, be sure to also have installed JAI and/or jimi to be able -to use/convert the png graphics files. The fop release note webpage tells how +to use/convert the PNG graphics files. The FOP release note webpage tells how to do it: download jimi from: http://java.sun.com/products/jimi/ -then extract the archive, then copy JimiProClasses.zip to FOP's lib dir and rename it to jimi-1.0.jar. +then extract the archive, then copy JimiProClasses.zip to FOP's lib dir and +rename it to jimi-1.0.jar. Win32 only: HTML help compiler (for .chm generation only) --------------------------------------------------------- -hhc compiler (hhc.exe) from Microsoft: +HTML Help Compiler (hhc.exe) from Microsoft: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp -lynx +Lynx ---- Text based web browser used to convert release_notes.html into plain text format. @@ -119,7 +120,7 @@ xsl stylesheets: Doc/docbook-xsl M docbook.xsl, chunk.xsl a docbookx.dtd: Doc/docbook_xml42 M lynx: Web/lynx M fop: - O URL: http://xml.apache.org/fop/ - install it into docbook\fop-0.95 to keep defaults from config.nmake -jimi: - O (fop 0.20.5 only) URL: http://java.sun.com/products/jimi/ - see above +jimi: - O URL: http://java.sun.com/products/jimi/ - see above hhc: - O URL: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp zip: Archive/zip O @@ -133,7 +134,7 @@ xmllint: libxml2 M xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk.xsl docbookx.dtd: docbook_4 M fop: fop O -jimi: - O (fop 0.20.5 only) get it from http://java.sun.com/products/jimi/ - see above +jimi: - O get it from http://java.sun.com/products/jimi/ - see above Packages for Gentoo @@ -152,12 +153,12 @@ xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk. So docbook runs out of the box on Gentoo. docbookx.dtd: docbook-xml-dtd M fop: fop O Has a lot of JAVA dependencies. -jimi: sun-jimi O (fop 0.20.5 ony) Used by fop. +jimi: sun-jimi O Used by fop. Quanta+ quanta or kdewebdev O Nice HTML/XML/SGML and Docbook editor with Syntaxhighlighting, Autocompletion, etc. Tip: The actual DTD version of Gentoo is 4.4, but wireshark docs still use 4.2. - To be able to generate the docs, change the version in the second line of developer-guide.xml - or install an older version of the DTD. + To be able to generate the docs, change the version in the second line of + developer-guide.xml or install an older version of the DTD. See into the Gentoo handbook howto unmask old versions. @@ -171,24 +172,25 @@ xsl stylesheets: docbook-style-xsl M docbook.xsl and chunk.xs docbookx.dtd: docbook-dtds M provides v4.1, v4.2, v4.3, v4.4 DTDs fop: fop O See above -jimi: - O (fop 0.20.5 ony) get it from http://java.sun.com/products/jimi/ - see above +jimi: - O get it from http://java.sun.com/products/jimi/ - see above Note: There are required dependencies (such as xml-common and sgml-common); - yum is your friend for doing package installs including required dependencies. + yum is your friend for doing package installs including required + dependencies. Packages for Debian ------------------- -Tool/File Package ---------- ------- -xsltproc: libxslt -xmllint: libxml2-utils -xsl stylesheets: docbook-xsl -chunk.xsl: docbook-xsl -htmlhelp.xsl: docbook-xsl -docbookx.dtd: docbook-xml -fop: fop -jimi: (fop 0.20.5 ony) http://java.sun.com/products/jimi/ - see above +Tool/File Package Opt./Mand. Comments +--------- ------- ---------- -------- +xsltproc: libxslt M +xmllint: libxml2-utils M +xsl stylesheets: docbook-xsl M +chunk.xsl: docbook-xsl M +htmlhelp.xsl: docbook-xsl M +docbookx.dtd: docbook-xml M +fop: fop O See above +jimi: - O http://java.sun.com/products/jimi/ - see above @@ -217,11 +219,11 @@ output: wsug_html_chunked 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, +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. -TIP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf, -but conversation works just fine. +Tip: You will get lot's of INFO/WARNING/ERROR messages when generating PDF, +but the conversion works just fine. output: user-guide-us.pdf user-guide-a4.pdf make wsug_chm @@ -233,14 +235,47 @@ output: htmlhelp.chm 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 -platforms have to use the cygwin environment (Microsoft nmake is not -supported). +The makefile is written to be run with make on UNIX/Linux platforms. +Win32 platforms have to use nmake -f Makefile.nmake + + +Notes to authors +---------------- +The docbook DTD provides you with all tags required to mark up a documents +structure. Please have a look at the existing XML files to see what these +structural tags are, and look at the DocBook web references below. +To maintain a consistent look and feel in the documents please use the +following tags for the indicated purposes. + +Tag Purpose +--- ------- +<application> to mark application names, like Wireshark. +<filename> to mark an individual file or path. +<command> to mark a command, with parameters. +<prompt> to mark a prompt before user input. +<userinput> to mark an example of user input, like an actual command line. +<function> to mark a function name, ending with parenthesis. +<parameter> to mark (function) parameters. +<varname> to mark (environment) variables. +<literal> to mark some literal value. + +These are all tags for inline text. Wrap literal text output in a CDATA block, +like so: + + <programlisting> +<![CDATA[#include <epan/tap.h> +... +]]> + </programlisting> + +Make sure the CDATA clause is at column 1, because prefixed whitespace will be +present in the verbatim output as well. Docbook web references: ----------------------- -Some web references to further documentation about Docbook/XML and Docbook XSL conversions: +Some web references to further documentation about Docbook/XML and Docbook XSL +conversions: DocBook: The Definitive Guide by Norman Walsh and Leonard Muellner @@ -252,7 +287,7 @@ http://www.sagehill.net/docbookxsl/index.html Documention with DocBook on Win32 by Jim Crafton -http://www.codeproject.com/winhelp/docbook_howto.asp +http://www.codeproject.com/KB/winhelp/docbook_howto.aspx FO Parameter Reference by Norman Walsh diff --git a/docbook/developer-guide.xml b/docbook/developer-guide.xml index c10e4c0bc0..f128a3ca95 100644 --- a/docbook/developer-guide.xml +++ b/docbook/developer-guide.xml @@ -48,13 +48,14 @@ Wireshark Info <!ENTITY WiresharkCurrentVersion "1.2"> <!ENTITY WiresharkWebSite "http://www.wireshark.org"> <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/"> - <!ENTITY WiresharkAuthorsPage "http://anonsvn.wireshark.org/wireshark/trunk/AUTHORS"> + <!ENTITY WiresharkAuthorsPage "&WiresharkRepositorySite;/wireshark/trunk/AUTHORS"> <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html"> <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org"> <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/"> <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/"> <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org"> - <!ENTITY WiresharkBugsSite "http://bugs.wireshark.org"> + <!ENTITY WiresharkBugsSite "https://bugs.wireshark.org"> + <!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org"> <!-- Gnu info diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.xml b/docbook/wsdg_src/WSDG_chapter_quick_setup.xml index 0e7fde1a84..fcfb44b821 100644 --- a/docbook/wsdg_src/WSDG_chapter_quick_setup.xml +++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.xml @@ -48,9 +48,9 @@ --> </orderedlist></para> <para>Install MSVC the usual way. Don't forget to install - vcvars32.bat or call it manually before building Wireshark. - vcvars32.bat will set some required environment (e.g. the - PATH) settings.</para> + <filename>vcvars32.bat</filename> or call it manually before building Wireshark. + <filename>vcvars32.bat</filename> will set some required environment (e.g. the + <varname>PATH</varname>) settings.</para> <tip> <title>You can use other Microsoft C compiler variants!</title> <para>It's possible to compile Wireshark with a wide range @@ -59,7 +59,7 @@ </tip> <warning> <title>Don't use Cygwin's gcc!</title> - <para>Using cygwin's gcc is not recommended and will + <para>Using Cygwin's gcc is not recommended and will certainly not work (at least without a lot of advanced tweaking). For further details on this topic, see <xref linkend="ChToolsGNUChain" />.</para> @@ -72,7 +72,7 @@ these in, for example <programlisting> - <![CDATA[@echo off +<![CDATA[@echo off echo Adding things to the path... set PATH=%PATH%;. set PATH=%PATH%;c:\cygwin\bin @@ -94,7 +94,7 @@ title Command Prompt (VC++ 2008)]]> <title>Install Cygwin</title> <para> <ulink url="http://www.cygwin.com/setup.exe"> - Download</ulink> the cygwin installer and start it.</para> + Download</ulink> the Cygwin installer and start it.</para> <para>At the "Select Packages" page, you'll need to select some additional packages, which are not installed by default. Navigate to the required Category/Package row and click on @@ -130,9 +130,9 @@ title Command Prompt (VC++ 2008)]]> </section> <section id="ChSetupPython"> <title>Install Python</title> - <para>Get the python 2.6 installer from: + <para>Get the Python 2.6 installer from: <ulink url="http://python.org/download/" /> and install Python - into the default location (C:/Python26).</para> + into the default location (C:\Python26).</para> <para>Why this is recommended: Cygwin's Python package doesn't work on some machines, so the Win32 native package is recommended.</para> @@ -180,7 +180,7 @@ title Command Prompt (VC++ 2008)]]> <orderedlist> <listitem> <para>Download sources : Download Wireshark sources into: - C:\wireshark using TortoiseSVN</para> + <filename>C:\wireshark</filename> using TortoiseSVN</para> <para> <orderedlist> <listitem> @@ -201,7 +201,7 @@ title Command Prompt (VC++ 2008)]]> </listitem> <listitem> <para>Checkout directory: - "C:\wireshark"</para> + <filename>C:\wireshark</filename></para> </listitem> </orderedlist> </para> @@ -211,13 +211,12 @@ title Command Prompt (VC++ 2008)]]> directory - say yes</para> </listitem> <listitem> - <para>TortoiseSVN starts downloading the - sources</para> + <para>TortoiseSVN starts downloading the sources</para> </listitem> <listitem> <para>if the download fails you may be behind a restrictive firewall, see - <xref linkend="ChSrcObtain" />for alternative + <xref linkend="ChSrcObtain" /> for alternative download methods</para> </listitem> </orderedlist> @@ -225,30 +224,33 @@ title Command Prompt (VC++ 2008)]]> </listitem> <listitem> <para>Edit config.nmake: edit the settings in - C:\wireshark\config.nmake, especially:</para> + <filename>C:\wireshark\config.nmake</filename>, especially:</para> <para> <orderedlist> <listitem> - <para>VERSION_EXTRA : Give Wireshark your "private" + <para><varname>VERSION_EXTRA</varname> : Give Wireshark your "private" version info, e.g.: -myprotocol123 - to distinguish it from an official release!</para> </listitem> <listitem> - <para>PROGRAM_FILES : Where your programs reside, - usually just keep the default: C:/Program Files + <para><varname>PROGRAM_FILES</varname> : Where your programs reside, + usually just keep the default: <filename>C:\Program Files</filename> <superscript>2</superscript></para> </listitem> <listitem> - <para>MSVC_VARIANT : Make sure the variant for your compiler is uncommented, and that all others are commented out. For example, if you're using Visual C++ 2008 Express Edition, find the line + <para><varname>MSVC_VARIANT</varname> : Make sure the variant for + your compiler is + uncommented, and that all others are commented out. For example, + if you're using Visual C++ 2008 Express Edition, find the line <programlisting> - <![CDATA[#MSVC_VARIANT=MSVC2008EE]]> +<![CDATA[#MSVC_VARIANT=MSVC2008EE]]> </programlisting> and remove the comment character (#) from the beginning of the line. Then, find the line <programlisting> - <![CDATA[MSVC_VARIANT=MSVC2008]]> +<![CDATA[MSVC_VARIANT=MSVC2008]]> </programlisting> - and comment it out. + and comment it out, by prefixing a hash (#). <superscript>1</superscript></para> </listitem> </orderedlist> @@ -262,15 +264,15 @@ title Command Prompt (VC++ 2008)]]> <para> <superscript>2</superscript>International Windows might use different values here, e.g. a German version uses - C:/Programme - take this also in account where C:\Program - Files appears elsewhere</para> + <filename>C:\Programme</filename> - take this also in account where + <filename>C:\Program Files</filename> appears elsewhere.</para> </section> <section id="ChSetupPrepareCommandCom"> <title>Prepare cmd.exe</title> - <para>Prepare cmd.exe - set environment and current dir. + <para>Prepare <filename>cmd.exe</filename> - set environment and current dir. <orderedlist> <listitem> - <para>start cmd.exe</para> + <para>start <command>cmd.exe</command></para> </listitem> <!-- <listitem> @@ -281,13 +283,13 @@ title Command Prompt (VC++ 2008)]]> </listitem> --> <listitem> - <para>call <command>C:\Program Files\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat</command> to set environment variables of - Visual C++ 2008 Express Edition + <para>call <command>C:\Program Files\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat</command> + to set environment variables of Visual C++ 2008 Express Edition. <superscript>1,2</superscript></para> </listitem> <listitem> - <para><command>cd C:\wireshark to jump into the source - directory</command></para> + <para><command>cd C:\wireshark</command> to jump into the source + directory</para> </listitem> </orderedlist> <superscript>1</superscript>Compiler dependent: This step @@ -298,35 +300,32 @@ title Command Prompt (VC++ 2008)]]> <para> <superscript>2</superscript>International Windows might use different values here, e.g. a German version uses - C:/Programme - take this also in account where C:\Program - Files appears elsewhere. Note: You need to repeat steps 1 - 4 - each time you open a new cmd.exe!</para> + <filename>C:\Programme</filename> - take this also in account where + <filename>C:\Program Files</filename> appears elsewhere. Note: You need + to repeat steps 1 - 4 each time you open a new cmd.exe!</para> </section> <section id="ChToolsWin32Verify"> <title>Verify installed tools</title> <para>After you've installed the Wireshark sources (see <xref linkend="ChSrcObtain" />), you can check the correct - installation of all tools by using the verify_tools target of - the - <filename>Makefile.nmake</filename> from the source - package.</para> + installation of all tools by using the <parameter>verify_tools</parameter> + target of the + <filename>Makefile.nmake</filename> from the source package.</para> <warning> <title>Warning!</title> <para>You will need the Wireshark sources and some tools (nmake, bash) installed, before this verification is able to work.</para> </warning> - <para>Enter at the command line (cmd.exe, not Cygwin's - bash!):</para> + <para>Enter at the command line (cmd.exe, not Cygwin's bash!):</para> <para> <prompt>></prompt> <userinput>nmake -f Makefile.nmake verify_tools</userinput> </para> - <para>This will check for the various tools needed to build - Wireshark:</para> + <para>This will check for the various tools needed to build Wireshark:</para> <para> <programlisting> - <![CDATA[Checking for required applications: +<![CDATA[Checking for required applications: cl: /cygdrive/c/Programme/Microsoft Visual Studio 8/VC/BIN/cl link: /cygdrive/c/Programme/Microsoft Visual Studio 8/VC/BIN/link nmake: /cygdrive/c/Programme/Microsoft Visual Studio 8/VC/BIN/nmake @@ -342,32 +341,32 @@ title Command Prompt (VC++ 2008)]]> sed: /usr/bin/sed unzip: /usr/bin/unzip wget: /usr/bin/wget]]> -</programlisting> + </programlisting> </para> <para>If you have problems with all the first three items (cl, link, nmake), - check if you called vcvars32/SetEnv as mentioned in + check if you called <literal>vcvars32/SetEnv</literal> as mentioned in <xref linkend="ChSetupPrepareCommandCom" /> (which will "fix" - your PATH settings). However, the exact text will be slightly + your <varname>PATH</varname> settings). However, the exact text will be slightly different depending on the MSVC version used.</para> <para>Unfortunately, the link command is defined both in - cygwin and in MSVC each with completely different functionality; + Cygwin and in MSVC each with completely different functionality; you'll need the MSVC link. If your link command looks - something like: /usr/bin/link, the link command of cygwin + something like: <command>/usr/bin/link</command>, the link command of Cygwin takes precedence over the MSVC one. To fix this, you can - change your PATH environment setting or simply rename the - link.exe in cygwin. If you rename it, make sure to remember - that a cygwin update may provide a new version of it.</para> + change your <varname>PATH</varname> environment setting or simply rename the + <filename>link.exe</filename> in Cygwin. If you rename it, make sure to remember + that a Cygwin update may provide a new version of it.</para> </section> <section> <title>Install Libraries</title> <orderedlist> <listitem> - <para>If you've closed cmd.exe in the meantime, prepare - cmd.exe again</para> + <para>If you've closed <command>cmd.exe</command> in the meantime, + prepare <command>cmd.exe</command> again.</para> </listitem> <listitem> - <para>nmake -f Makefile.nmake setup downloads libraries - using wget and installs them - this may take a while + <para><command>nmake -f Makefile.nmake</command> setup downloads libraries + using <command>wget</command> and installs them - this may take a while ...</para> </listitem> <listitem> @@ -380,17 +379,17 @@ title Command Prompt (VC++ 2008)]]> <section> <title>Distclean Sources</title> <para>The released Wireshark sources contain files that are - prepared for a UNIX build (e.g. config.h).</para> + prepared for a UNIX build (e.g. <filename>config.h</filename>).</para> <para>You must distclean your sources before building the first time! <orderedlist> <listitem> - <para>If you've closed cmd.exe in the meantime, prepare - cmd.exe again</para> + <para>If you've closed <command>cmd.exe</command> in the meantime, + prepare <command>cmd.exe</command> again</para> </listitem> <listitem> - <para>nmake -f Makefile.nmake distclean to cleanup the - Wireshark sources</para> + <para><command>nmake -f Makefile.nmake distclean</command> + to cleanup the Wireshark sources</para> </listitem> </orderedlist></para> </section> @@ -399,92 +398,90 @@ title Command Prompt (VC++ 2008)]]> <para>Now it's time to build Wireshark ... <orderedlist> <listitem> - <para>If you've closed cmd.exe in the meantime, prepare - cmd.exe again</para> + <para>If you've closed <command>cmd.exe</command> in the meantime, + prepare <command>cmd.exe</command> again</para> </listitem> <listitem> - <para>nmake -f Makefile.nmake all to build - Wireshark</para> + <para><command>nmake -f Makefile.nmake all</command> + to build Wireshark</para> </listitem> <listitem> <para>wait for Wireshark to compile - this may take a while!</para> </listitem> <listitem> - <para>run C:\wireshark\wireshark-gtk2\wireshark.exe and - check if it starts</para> + <para>run <command>C:\wireshark\wireshark-gtk2\wireshark.exe</command> + and check if it starts</para> </listitem> <listitem> <para>check Help/About if it shows your "private" program - version, e.g.: Version 0.99.4-myprotocol123 - you might - run a release version previously installed!</para> + version, e.g.: Version &WiresharkCurrentVersion;.x-myprotocol123 + - you might run a release version previously installed!</para> </listitem> </orderedlist>Tip: If compilation fails for suspicious - reasons after you changed some source files try to distclean + reasons after you changed some source files try to "distclean" the sources and make "all" again</para> </section> <section> <title>Debug Environment Setup (XXX)</title> <para>XXX - debug needs to be written, e.g. an idea is the - create a simple MSVC 6 workspace/project(s) to ease Visual + create a simple MSVC workspace/project(s) to ease Visual Studio debugging</para> </section> <section> <title>Optional: Create User's and Developer's Guide</title> - <para>Detailed information to build these guides can be found - in the file docbook/README.txt in the Wireshark - sources.</para> + <para>Detailed information to build these guides can be found in the file + <filename>docbook/README.txt</filename> in the Wireshark sources.</para> </section> <section> <title>Optional: Create a Wireshark Installer</title> <para>Note: You should have successfully built Wireshark before doing the following!</para> - <para>If you want to build your own wireshark-setup.exe, + <para>If you want to build your own + <filename>wireshark-win32-&WiresharkCurrentVersion;.x-myprotocol123.exe</filename>, you'll need NSIS. <orderedlist> <listitem> <para>NSIS: <ulink url="http://nsis.sourceforge.net"> Download</ulink> and install NSIS</para> - <para>You may check the MAKENSIS setting in the file - <filename>config.nmake</filename> of the Wireshark - sources.</para> + <para>You may check the <varname>MAKENSIS</varname> setting in the file + <filename>config.nmake</filename> of the Wireshark sources.</para> </listitem> <listitem> - <para>vcredist_x86.exe : + <para><filename>vcredist_x86.exe</filename> : <ulink url="http://www.microsoft.com/downloads/details.aspx?FamilyId=32BC1BEE-A3F9-4C13-9C99-220B62A191EE&displaylang=en"> Download</ulink> the C-Runtime redistributable for Visual - C++ 2008 Express Edition (vcredist_x86.exe) and copy it - into C:\wireshark-win32-libs + C++ 2008 Express Edition (<filename>vcredist_x86.exe</filename>) + and copy it into <filename>C:\wireshark-win32-libs</filename> <superscript>1</superscript> <warning> <title>Beware of Visual Studio Service Packs!</title> <para>If you have installed the Visual Studio Service - Pack 1, you need a different vcredist_x86.exe version! - See - <xref linkend="ChToolsMSChain" />for details!</para> + Pack 1, you need a different + <filename>vcredist_x86.exe</filename> version! See + <xref linkend="ChToolsMSChain" /> for details!</para> </warning></para> </listitem> <listitem> - <para>If you've closed cmd.exe in the meantime, prepare - cmd.exe again</para> + <para>If you've closed <command>cmd.exe</command> in the meantime, + prepare <command>cmd.exe</command> again</para> </listitem> <listitem> - <para>nmake -f Makefile.nmake packaging build Wireshark - installer</para> + <para><command>nmake -f Makefile.nmake packaging</command> + build Wireshark installer</para> </listitem> <listitem> <para>run - C:\wireshark\packaging\nsis\wireshark-setup-<version>.exe - and test it - it's a good idea to test also on a - different machine than the developer machine.</para> + <command>C:\wireshark\packaging\nsis\wireshark-win32-&WiresharkCurrentVersion;.x-myprotocol123.exe</command> + and test it - it's a good idea to test also on a different machine + than the developer machine.</para> </listitem> </orderedlist> <superscript>1</superscript>Compiler dependent: This step depends on the compiler variant used, for other variants than the recommended Visual C++ 2008 Express Edition see the table - at - <xref linkend="ChToolsMSChain" />!</para> + at <xref linkend="ChToolsMSChain" />!</para> </section> </section> </chapter> diff --git a/docbook/wsdg_src/WSDG_chapter_sources.xml b/docbook/wsdg_src/WSDG_chapter_sources.xml index 7563f869c2..e4be5d1f3c 100644 --- a/docbook/wsdg_src/WSDG_chapter_sources.xml +++ b/docbook/wsdg_src/WSDG_chapter_sources.xml @@ -109,14 +109,14 @@ you will only need a Web browser. </para> <para> - A <command>simple view</command> on the latest developer version can be + A <literal>simple view</literal> on the latest developer version can be found at: </para> <para> <ulink url="http://anonsvn.wireshark.org/wireshark/trunk/"/>. </para> <para> - A <command>comprehensive view</command> of all source versions + A <literal>comprehensive view</literal> of all source versions (e.g. including the capability to show differences between versions) is available at: </para> @@ -127,10 +127,10 @@ Of special interest might be the subdirectories: <itemizedlist> <listitem><para> - trunk - the very latest source files + <filename>trunk</filename> - the very latest source files </para></listitem> <listitem><para> - releases - the source files of all released versions + <filename>releases</filename> - the source files of all released versions </para></listitem> </itemizedlist> </para> @@ -177,7 +177,7 @@ You can use a Subversion client to download the source code from Wireshark's anonymous Subversion repository. The URL for the repository trunk is: - <ulink url="http://anonsvn.wireshark.org/wireshark/trunk/"/>. + <ulink url="&WiresharkRepositorySite;/wireshark/trunk/"/>. </para> <para> See <xref linkend="ChToolsSubversion"/> on how to install a Subversion client. @@ -188,7 +188,7 @@ </para> <para> <prompt>$</prompt> - <userinput>svn checkout http://anonsvn.wireshark.org/wireshark/trunk wireshark</userinput> + <userinput>svn checkout &WiresharkRepositorySite;/wireshark/trunk wireshark</userinput> </para> <para> The checkout has to be only done once. This will copy all the sources of @@ -209,7 +209,7 @@ <para> The entire source tree of the Subversion repository is available via a web interface at: - <ulink url="http://anonsvn.wireshark.org/viewvc/viewvc.cgi/"/>. + <ulink url="&WiresharkRepositorySite;/viewvc/viewvc.cgi/"/>. You can view each revision of a particular file, as well as diffs between different revisions. You can also download individual files but not entire directories. @@ -367,11 +367,11 @@ make </programlisting> </para> <para> - If you need to build with a GTK 1.x version, you have to use: + If you need to build with a non-standard configuration, you can use: <programlisting> -./configure --disable-gtk2 +./configure --help </programlisting> - instead of just ./configure. + to see what options you have. </para> </section> @@ -388,16 +388,16 @@ make <para> Many of the file and directory names used in the build process go past the old 8.3 naming limitations. - As a result, you should use the "cmd.exe" command interpreter instead of the - old "command.com". + As a result, you should use the <command>cmd.exe</command> command interpreter + instead of the old <command>command.com</command>. </para> <para> Be sure that your command-line environment is set up to compile and link with MSVC++. When installing MSVC++, you can have your system's environment set up to always allow compiling from the command line, or you can invoke the vcvars32.bat script, which can - usually be found in the "VC98\Bin" subdirectory of the directory in - which Visual Studio was installed. + usually be found in the <filename>VC98\Bin</filename> subdirectory of the + directory in which Visual Studio was installed. </para> <para> You should then cleanup any intermediate files, which are shipped for @@ -445,10 +445,10 @@ make </para> <para> In order to run the Wireshark from the build directory set the environment - variable <command>WIRESHARK_RUN_FROM_BUILD_DIRECTORY</command> and run + variable <varname>WIRESHARK_RUN_FROM_BUILD_DIRECTORY</varname> and run Wireshark. If your platform is properly setup, your build directory and - current working directory are not in your PATH, so the commandline to - launch Wireshark would be: + current working directory are not in your <varname>PATH</varname>, so the + commandline to launch Wireshark would be: <command>WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 ./wireshark</command>. </para> <para> @@ -483,7 +483,7 @@ make (ddd) instead of GNU debugger (gdb). </para> <para> - Additional traps can be set on GLib by setting the <command>G_DEBUG</command> + Additional traps can be set on GLib by setting the <varname>G_DEBUG</varname> environment variable:<command>G_DEBUG=fatal_criticals libtool --mode=execute ddd wireshark</command>. See <ulink url="http://library.gnome.org/devel/glib/stable/glib-running.html"/> @@ -520,8 +520,8 @@ make </para> <tip><title>Tip!</title> <para> - <command>Ask the developer mailing list before you really start a new - development task.</command> + <literal>Ask the developer mailing list before you really start a new + development task.</literal> If you have an idea what you want to add/change, it's a good idea to contact the developer mailing list (see <xref linkend="ChIntroMailingLists"/>) @@ -590,7 +590,9 @@ make </para> <para> Here is a small example of a patch for <filename>file.h</filename> that - makes the second argument in <function>cf_continue_tail()</function> <type>volatile</type>. It was created using <command>svn diff</command>, described below: + makes the second argument in <function>cf_continue_tail()</function> + <type>volatile</type>. It was created using <command>svn diff</command>, + described below: <programlisting> <![CDATA[ Index: file.h @@ -673,10 +675,12 @@ Index: file.h When you create the diff file, it will include any difference TortoiseSVN finds in files in and under the directory you have right-clicked on, and nothing else. This means that changes you might have made for your - specific configuration - like modifying "config.nmake" so that it uses + specific configuration - like modifying <filename>config.nmake</filename> + so that it uses your lib directory - will also be included, and you will need to remove these lines from the diff file. It also means that only changes will be - recorded, i.e. if you have created new files -say, a new packet-xxx for a + recorded, i.e. if you have created new files -say, a new + <filename>packet-xxx.c</filename> for a new protocol dissector- it will not be included in the diff, you need to add it separately. And, of course, if you have been working separately in two different patches, the .diff file will include both topics, which is @@ -692,7 +696,7 @@ Index: file.h do a diff, you should have two source trees on your computer, one with your working copy (containing your changes), and one with the "official" source tree - (hopefully the latest SVN files) from www.wireshark.org. + (hopefully the latest SVN files) from &WiresharkWebSite;. </para> <para> If you have only changed a single file, you could type something like @@ -888,7 +892,7 @@ Index: file.h </para> <para> To submit a patch, open a new ticket in the Wireshark bug database at <ulink - url="http://bugs.wireshark.org/bugzilla/enter_bug.cgi?product=Wireshark"/>. + url="&WiresharkBugsSite;/bugzilla/enter_bug.cgi?product=Wireshark"/>. You must first create a bug, then attach your patch or patches. <itemizedlist> <listitem><para> @@ -909,6 +913,7 @@ Index: file.h </para></listitem> </itemizedlist> </para> + <!-- <tip><title>Tip!</title> <para> Setting the <command>review_for_checkin</command> is important. @@ -916,6 +921,7 @@ Index: file.h patch request queue</ulink>. </para> </tip> + --> <para> You might get one of the following responses to your patch request: <itemizedlist> @@ -962,10 +968,12 @@ Index: file.h <section id="ChSrcPatchUse"> <title>Using patch</title> <para> - Given the file "new.diff" containing a unified diff, the right way to - call the patch tool depends on what the pathnames in "new.diff" look like. + Given the file <filename>new.diff</filename> containing a unified diff, + the right way to call the patch tool depends on what the pathnames in + <filename>new.diff</filename> look like. If they're relative to the top-level source directory - for example, if a - patch to "prefs.c" just has "prefs.c" as the file name - you'd run it as: + patch to <filename>prefs.c</filename> just has <filename>prefs.c</filename> + as the file name - you'd run it as: </para> <para> <userinput>patch -p0 <new.diff</userinput> @@ -973,23 +981,26 @@ Index: file.h <para> If they're relative to a higher-level directory, you'd replace 0 with the number of higher-level directories in the path, e.g. if the names are - "wireshark.orig/prefs.c" and "wireshark.mine/prefs.c", you'd run it with: + <filename>wireshark.orig/prefs.c</filename> and + <filename>wireshark.mine/prefs.c</filename>, you'd run it with: </para> <para> <userinput>patch -p1 <new.diff</userinput> </para> <para> - If they're relative to a <command>subdirectory</command> of the top-level - directory, you'd run "patch" in <command>that</command> directory and run - it with "-p0". + If they're relative to a <literal>subdirectory</literal> of the top-level + directory, you'd run <command>patch</command> in <literal>that</literal> + directory and run it with <parameter>-p0</parameter>. </para> <para> - If you run it without "-p" at all, the patch tool flattens path names, so - that if you - have a patch file with patches to "Makefile.am" and "wiretap/Makefile.am", - it'll try to apply the first patch to the top-level "Makefile.am" and then - apply the "wiretap/Makefile.am" patch to the top-level "Makefile.am" as - well. + If you run it without <parameter>-p</parameter> at all, the patch tool + flattens path names, so that if you + have a patch file with patches to <filename>Makefile.am</filename> and + <filename>wiretap/Makefile.am</filename>, + it'll try to apply the first patch to the top-level + <filename>Makefile.am</filename> and then apply the + <filename>wiretap/Makefile.am</filename> patch to the top-level + <filename>Makefile.am</filename> as well. </para> <para> At which position in the filesystem should the patch tool be called? @@ -1000,12 +1011,12 @@ Index: file.h directory. </para> <para> - If they're relative to a <command>subdirectory</command> - for example, + If they're relative to a <literal>subdirectory</literal> - for example, if somebody did a patch to "packet-ip.c" and ran "diff" or "svn diff" in the "epan/dissectors" directory - you'd run it in that subdirectory. - It is preferred that people <command>NOT</command> submit patches like + It is preferred that people <literal>NOT</literal> submit patches like that - especially if they're only patching files that exist in multiple - directories, such as "Makefile.am". + directories, such as <filename>Makefile.am</filename>. </para> </section> <section id="ChSrcPatchCvs"> diff --git a/docbook/wsdg_src/WSDG_chapter_tools.xml b/docbook/wsdg_src/WSDG_chapter_tools.xml index d4ba4c6aa3..1d663485a4 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.xml +++ b/docbook/wsdg_src/WSDG_chapter_tools.xml @@ -142,11 +142,11 @@ </para> <para>should result in something like: <programlisting> - <![CDATA[gcc (GCC) 3.4.4 (cygwin special) (gdc 0.12, using dmd 0.125) +<![CDATA[gcc (GCC) 3.4.4 (cygwin special) (gdc 0.12, using dmd 0.125) Copyright (C) 2004 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsGDB"> <title>gdb (GNU project debugger)</title> @@ -167,14 +167,14 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[GNU gdb 6.5.50.20060706-cvs (cygwin-special) +<![CDATA[GNU gdb 6.5.50.20060706-cvs (cygwin-special) Copyright 2003 Free Software Foundation, Inc. GDB is free software, covered by the GNU General Public License, and you are welcome to change it and/or distribute copies of it under certain conditions. Type "show copying" to see the conditions. There is absolutely no warranty for GDB. Type "show warranty" for details. This GDB was configured as "i686-pc-cygwin".]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsDDD"> <title>ddd (GNU Data Display Debugger)</title> @@ -208,12 +208,12 @@ This GDB was configured as "i686-pc-cygwin".]]> </para> <para>should result in something like: <programlisting> - <![CDATA[GNU Make 3.81 +<![CDATA[GNU Make 3.81 Copyright (C) 2006 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> </section> <section id="ChToolsMSChain"> @@ -222,31 +222,31 @@ PARTICULAR PURPOSE.]]> compiler, you'll need:</para> <orderedlist> <listitem> - <para>C compiler (cl.exe)</para> + <para>C compiler (<filename>cl.exe</filename>)</para> </listitem> <listitem> - <para>Linker (link.exe)</para> + <para>Linker (<filename>link.exe</filename>)</para> </listitem> <listitem> - <para>Make (nmake.exe)</para> + <para>Make (<filename>nmake.exe</filename>)</para> </listitem> <listitem> - <para>C runtime headers and libraries (e.g. stdio.h, - msvcrt.lib)</para> + <para>C runtime headers and libraries (e.g. <filename>stdio.h, + msvcrt.lib</filename>)</para> </listitem> <listitem> <para>Windows platform headers and libraries (e.g. - windows.h, WSock32.lib)</para> + <filename>windows.h, WSock32.lib</filename>)</para> </listitem> <listitem> - <para>HTML help headers and libraries (htmlhelp.h, - htmlhelp.lib)</para> + <para>HTML help headers and libraries (<filename>htmlhelp.h, + htmlhelp.lib</filename>)</para> </listitem> </orderedlist> <section> <title>Toolchain Package Alternatives</title> <para>The official Wireshark 1.0.x releases are compiled using Microsoft - Visual C++ 6.0. The 1.1.x development releases are compiled using + Visual C++ 6.0. The subsequent releases are compiled using Microsoft Visual C++ 2008 SP1. Using the release compilers is recommended for Wireshark development work. Visual C++ 2008 Express Edition SP1 may be used for the development branch, but it cannot create PortableApps @@ -586,14 +586,16 @@ PARTICULAR PURPOSE.]]> install it and don't even need to call a separate environment setting batch file for the Platform SDK!</para> <para> - <superscript>3</superscript>vcredist_x86.exe (3MB free - download) is required to build Wireshark-setup.exe. The - version of vcredist_x86.exe MUST match the version for - your compiler.</para> + <superscript>3</superscript><filename>vcredist_x86.exe</filename> + (3MB free download) is required to build + <filename>Wireshark-win32-&WiresharkCurrentVersion;.x.exe</filename>. + The version of <filename>vcredist_x86.exe</filename> MUST match + the version for your compiler.</para> <para> - <superscript>4</superscript>Wireshark-setup.exe cannot be - created with this package, as msvcr*.dll is not available or - not redistributable!</para> + <superscript>4</superscript> + <filename>Wireshark-win32-&WiresharkCurrentVersion;.x.exe</filename> + cannot be created with this package, as <filename>msvcr*.dll</filename> + is not available or not redistributable!</para> <para> <superscript>5</superscript>MSDN remarks that the corresponding .NET runtime is required. It's currently @@ -611,7 +613,7 @@ PARTICULAR PURPOSE.]]> <para>Please note: The following is not legal advice - ask your preferred lawyer instead! It's the authors view, but this view might be wrong!</para> - <para>The myriad of  + <para>The myriad of <ulink url="http://anonsvn.wireshark.org/wireshark-win32-libs/tags/"> Win32 support lib</ulink> port projects all seem to believe there are legal issues involved in using newer versions of @@ -623,7 +625,7 @@ PARTICULAR PURPOSE.]]> <para>Unfortunately, it is believed by many that the Microsoft Visual Studio 2003 EULA explicitly forbids linking with GPL'ed programs. This belief is probably due - to an improper interpretation of the  + to an improper interpretation of the <ulink url="http://msdn.microsoft.com/visualc/vctoolkit2003/eula.aspx"> Visual Studio 2003 Toolkit EULA</ulink>, which places redistribution restrictions only on SOURCE CODE SAMPLES @@ -634,7 +636,7 @@ PARTICULAR PURPOSE.]]> forbids using Visual Studio 2003, since one of the required support libraries (MSVCR71.DLL) does not ship with the Windows operating system. This is also a - wrongful interpretation, and the  + wrongful interpretation, and the <ulink url="http://www.gnu.org/licenses/gpl-faq.html#WindowsRuntimeAndGPL"> GPL FAQ</ulink> explicitly addresses this issue.</para> </listitem> @@ -782,11 +784,11 @@ PARTICULAR PURPOSE.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[Microsoft (R) 32-bit C/C++ Optimizing Compiler Version 12.00.8804 for 80x86 +<![CDATA[Microsoft (R) 32-bit C/C++ Optimizing Compiler Version 12.00.8804 for 80x86 Copyright (C) Microsoft Corp 1984-1998. All rights reserved. usage: cl [ option... ] filename... [ /link linkoption... ]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsNMake"> <title>nmake.exe (Make)</title> @@ -808,12 +810,12 @@ usage: cl [ option... ] filename... [ /link linkoption... ]]> </para> <para>should result in something like: <programlisting> - <![CDATA[Microsoft (R) Program Maintenance Utility Version 6.00.9782.0 +<![CDATA[Microsoft (R) Program Maintenance Utility Version 6.00.9782.0 Copyright (C) Microsoft Corp 1988-1998. All rights reserved. NMAKE : fatal error U1064: MAKEFILE not found and no target specified Stop.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> <para>Documentation on nmake can be found at <ulink url="http://msdn2.microsoft.com/en-us/library/dd9y37ha(VS.71).aspx"> Microsoft MSDN</ulink></para> @@ -829,7 +831,7 @@ Stop.]]> this view might be wrong!</para> <para>Depending on the Microsoft compiler version you use, some binary files coming from Microsoft might - be required to be installed on Windows machine to run + be required to be installed on Windows machine to run Wireshark. On a developer machine, the compiler setup installs these files so they are available - but they might not be available on a user machine!</para> @@ -888,17 +890,17 @@ Stop.]]> <para>"Visual Studio .NET (2002)" - comes with this dll and it's mentioned in redist.txt.</para> <para>".NET Framework SDK 1.0" doesn't even come with this - dll. XXX - Is this file available with the .NET 1.0 + dll. XXX - Is this file available with the .NET 1.0 runtime (dotnetfx.exe) - so it could be shipped instead?!? Do we want it that way?</para> </section> <section> <title>msvcr71.dll - Version 7.1 (2003)</title> - <para>"Visual Studio .NET 2003" comes with this dll + <para>"Visual Studio .NET 2003" comes with this dll and it's mentioned in redist.txt.</para> <para>".NET Framework SDK 1.1" comes with this dll, but it's NOT mentioned in redist.txt. XXX - Is this file - available with the .NET 1.1 runtime + available with the .NET 1.1 runtime (dotnetfx.exe) - so it could be shipped instead ?!? Do we want it that way?</para> </section> @@ -985,7 +987,7 @@ Stop.]]> </section> <section> <title>Windows (Platform) SDK</title> - <para>The Windows Platform SDK (PSDK) is a free (as in + <para>The Windows Platform SDK (PSDK) is a free (as in beer) download and contains platform specific headers and libraries (e.g. windows.h, WSock32.lib, ...). As new Windows features evolve in time, updated PSDK's become available that @@ -1001,8 +1003,8 @@ Stop.]]> directory.</para> <para>BTW: "Windows SDK" seems to be the new name of the Platform SDK for Vista. The current SDK name is misleading: - "Microsoft® Windows® Software Development Kit for - Windows Vista™ and .NET Framework 3.0 Runtime + "Microsoft Windows Software Development Kit for + Windows Vista and .NET Framework 3.0 Runtime Components" - translated this means: the Windows SDK for Windows Vista and Platforms (like WinXP) that have the .NET 3.0 runtime installed.</para> @@ -1012,12 +1014,12 @@ Stop.]]> <para>The HTML Help is used to create the User's and Developer's Guide in .chm format and to show the User's Guide as the Wireshark "Online Help".</para> - <para>Both features are currently optional, but might be + <para>Both features are currently optional, but might be mandatory in future versions.</para> <section> <title>HTML Help Compiler (hhc.exe)</title> - <para>This compiler is used to generate a .chm file - from a bunch of HTML files - in our case to generate + <para>This compiler is used to generate a .chm file + from a bunch of HTML files - in our case to generate the User's and Developer's Guide in .chm format.</para> <para>The compiler is only available as the free (as in beer) "HTML Help Workshop" download. If you want to compile @@ -1034,7 +1036,7 @@ Stop.]]> "online help".</para> <para>Both files are part of the Platform SDK (standalone PSDK or MSVC since 2002). If you still use MSVC 6, you - can get them from the "HTML Help Workshop" mentioned + can get them from the "HTML Help Workshop" mentioned above.</para> <para>The related settings in config.nmake depend on the MSVC variant you use:</para> @@ -1103,9 +1105,9 @@ Stop.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[GNU bash, version 3.1.17(6)-release (i686-pc-cygwin) +<![CDATA[GNU bash, version 3.1.17(6)-release (i686-pc-cygwin) Copyright (C) 2005 Free Software Foundation, Inc.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Bash"> <title>Win32 native: -</title> @@ -1158,8 +1160,8 @@ Copyright (C) 2005 Free Software Foundation, Inc.]]> </para> <para>The output should look something like: <programlisting> - <![CDATA[Python 2.6]]> -</programlisting>However, the version string may vary.</para> +<![CDATA[Python 2.6]]> + </programlisting>However, the version string may vary.</para> </section> </section> <section id="ChToolsPerl"> @@ -1185,7 +1187,7 @@ Copyright (C) 2005 Free Software Foundation, Inc.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[This is perl, v5.8.7 built for cygwin-thread-multi-64int +<![CDATA[This is perl, v5.8.7 built for cygwin-thread-multi-64int (with 1 registered patch, see perl -V for more detail) Copyright 1987-2005, Larry Wall @@ -1196,7 +1198,7 @@ GNU General Public License, which may be found in the Perl 5 source kit. Complete documentation for Perl, including FAQ lists, should be found on this system using `man perl' or `perldoc perl'. If you have access to the Internet, point your browser at http://www.perl.com/, the Perl Home Page.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Perl"> <title>Win32 native: perl</title> @@ -1211,16 +1213,15 @@ Internet, point your browser at http://www.perl.com/, the Perl Home Page.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[This is perl, v5.8.0 built for MSWin32-x86-multi-thread +<![CDATA[This is perl, v5.8.0 built for MSWin32-x86-multi-thread (with 1 registered patch, see perl -V for more detail) Copyright 1987-2002, Larry Wall Binary build 805 provided by ActiveState Corp. http://www.ActiveState.com Built 18:08:02 Feb 4 2003 - ...]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> </section> <section id="ChToolsSed"> @@ -1245,12 +1246,12 @@ Built 18:08:02 Feb 4 2003 </para> <para>should result in something like: <programlisting> - <![CDATA[GNU sed version 4.1.5 +<![CDATA[GNU sed version 4.1.5 Copyright (C) 2003 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, to the extent permitted by law.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Sed"> <title>Win32 native: sed</title> @@ -1278,13 +1279,13 @@ to the extent permitted by law.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[bison (GNU Bison) 2.3 +<![CDATA[bison (GNU Bison) 2.3 Written by Robert Corbett and Richard Stallman. Copyright (C) 2006 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Yacc"> <title>Win32 native: bison</title> @@ -1312,8 +1313,8 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[flex version 2.5.4]]> -</programlisting>However, the version string may vary.</para> +<![CDATA[flex version 2.5.4]]> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Lexx"> <title>Win32 native: flex</title> @@ -1355,15 +1356,14 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[svn, version 1.0.5 (r9954) +<![CDATA[svn, version 1.0.5 (r9954) compiled Jun 20 2004, 23:28:30 Copyright (C) 2000-2004 CollabNet. Subversion is open source software, see http://subversion.tigris.org/ This product includes software developed by CollabNet (http://www.Collab.Net/). - ...]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32SVN"> <title>Win32 native: svn</title> @@ -1380,11 +1380,11 @@ This product includes software developed by CollabNet (http://www.Collab.Net/). </para> <para>should result in something like: <programlisting> - <![CDATA[svn, Version 1.4.0 (r21228) +<![CDATA[svn, Version 1.4.0 (r21228) Copyright (C) 2000-2006 CollabNet. ...]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> </section> <section id="ChToolsSubversionGUI"> @@ -1447,14 +1447,14 @@ Copyright (C) 2000-2006 CollabNet. </para> <para>should result in something like: <programlisting> - <![CDATA[diff (GNU diffutils) 2.8.7 +<![CDATA[diff (GNU diffutils) 2.8.7 Written by Paul Eggert, Mike Haertel, David Hayes, Richard Stallman, and Len Tower. Copyright (C) 2004 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Diff"> <title>Win32 native: diff</title> @@ -1501,7 +1501,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]> </para> <para>should result in something like: <programlisting> - <![CDATA[patch 2.5.8 +<![CDATA[patch 2.5.8 Copyright (C) 1988 Larry Wall Copyright (C) 2002 Free Software Foundation, Inc. @@ -1511,7 +1511,7 @@ under the terms of the GNU General Public License. For more information about these matters, see the file named COPYING. written by Larry Wall and Paul Eggert]]> -</programlisting>However, the version string may vary.</para> + </programlisting>However, the version string may vary.</para> </section> <section id="ChToolsWin32Patch"> <title>Win32 native: patch</title> @@ -1548,8 +1548,7 @@ written by Larry Wall and Paul Eggert]]> For example, if you are behind proxy.com which is listening on port 8080, you have to set it to something like:</para> <para> - <programlisting>set - HTTP_PROXY=http://proxy.com:8080/</programlisting> + <programlisting>set HTTP_PROXY=http://proxy.com:8080/</programlisting> </para> <para>If you are unsure about the settings, you might ask your system administrator.</para> @@ -1572,11 +1571,11 @@ written by Larry Wall and Paul Eggert]]> <section id="ChToolsNSIS"> <title>Win32: NSIS (optional)</title> <para>The NSIS (Nullsoft Scriptable Install System) is used to - generate a wireshark-setup-<version>.exe from all the - files needed to be installed, including all required DLL's and + generate <filename>wireshark-win32-&WiresharkCurrentVersion;.x.exe</filename> + from all the files needed to be installed, including all required DLL's and such.</para> <para>To install it, simply download the latest released - version (currently: 2.28) from + version (currently: 2.45) from <ulink url="http://nsis.sourceforge.net" /> and start the downloaded installer. You will need NSIS version 2 final or higher.</para> |