#
-# Make the "Ethereal User's Guide" in several formats.
+# Make the "Wireshark User Guide" and "Wireshark Developer Guide"
+# in several formats.
# See the Readme.txt file for instructions.
#
# $Id$
# Automatically generate .pdf files from .fo files
.fo.pdf:
FOP_OPTS="$(FOP_OPTS)" $(FOP) $< $@
+# On Debian use this line
+# JAVA_OPTS="$(FOP_OPTS)" $(FOP) $< $@
WSUG_FILES = \
wsug_src/WSUG_app_files.xml \
graphics/wireshark-logo.png \
graphics/wireshark-main.png
-EDG_FILES = \
- edg_src/EDG_chapter_build_intro.xml \
- edg_src/EDG_chapter_capture.xml \
- edg_src/EDG_chapter_dissection.xml \
- edg_src/EDG_chapter_env_intro.xml \
- edg_src/EDG_chapter_libraries.xml \
- edg_src/EDG_chapter_sources.xml \
- edg_src/EDG_chapter_tools.xml \
- edg_src/EDG_chapter_userinterface.xml \
- edg_src/EDG_chapter_works.xml \
- edg_src/EDG_meta_info.xml \
- edg_src/EDG_preface.xml
-
-EDG_GRAPHICS = \
- edg_graphics/ethereal-capture-sync.dia \
- edg_graphics/ethereal-capture-sync.png \
- edg_graphics/ethereal-capture_internals.dia \
- edg_graphics/ethereal-capture_internals.png \
- edg_graphics/ethereal-function-blocks.dia \
- edg_graphics/ethereal-function-blocks.png \
- edg_graphics/wireshark-logo.png \
- edg_graphics/note.png \
- edg_graphics/tip.png \
- edg_graphics/warning.png
+WSDG_FILES = \
+ wsdg_src/EDG_chapter_build_intro.xml \
+ wsdg_src/EDG_chapter_capture.xml \
+ wsdg_src/EDG_chapter_dissection.xml \
+ wsdg_src/EDG_chapter_env_intro.xml \
+ wsdg_src/EDG_chapter_libraries.xml \
+ wsdg_src/EDG_chapter_sources.xml \
+ wsdg_src/EDG_chapter_tools.xml \
+ wsdg_src/EDG_chapter_userinterface.xml \
+ wsdg_src/EDG_chapter_works.xml \
+ wsdg_src/EDG_meta_info.xml \
+ wsdg_src/EDG_preface.xml
+
+WSDG_GRAPHICS = \
+ wsdg_graphics/ethereal-capture-sync.dia \
+ wsdg_graphics/ethereal-capture-sync.png \
+ wsdg_graphics/ethereal-capture_internals.dia \
+ wsdg_graphics/ethereal-capture_internals.png \
+ wsdg_graphics/ethereal-function-blocks.dia \
+ wsdg_graphics/ethereal-function-blocks.png \
+ wsdg_graphics/wireshark-logo.png \
+ wsdg_graphics/note.png \
+ wsdg_graphics/tip.png \
+ wsdg_graphics/warning.png
# user-guide.xml must be first in the list (to match $<)
WSUG_SOURCE = \
$(WSUG_GRAPHICS)
# developer-guide.xml must be first in the list (to match $<)
-EDG_SOURCE = \
+WSDG_SOURCE = \
developer-guide.xml \
svn_version.xml \
- $(EDG_FILES) \
- $(EDG_GRAPHICS)
+ $(WSDG_FILES) \
+ $(WSDG_GRAPHICS)
RELEASE_NOTES_SOURCE = \
release-notes.xml \
*.hhp \
*.pdf \
*.validated \
- edg_chm \
- edg_html \
- edg_html_chunked \
+ wsdg_chm \
+ wsdg_html \
+ wsdg_html_chunked \
wsug_chm \
wsug_html \
wsug_html_chunked \
svn_version.xml \
-all: wsug.validated edg.validated release_notes.validated wsug edg release_notes
+all: wsug.validated wsdg.validated release_notes.validated wsug wsdg release_notes
clean:
rm -rf $(CLEANFILES)
endif
-edg: edg_html_chunked developer-guide.html developer-guide-a4.pdf developer-guide-us.pdf developer-guide.chm
+wsdg: wsdg_html_chunked developer-guide.html developer-guide-a4.pdf developer-guide-us.pdf developer-guide.chm
# validate the content
-edg.validated: $(EDG_SOURCE)
- @ echo --- EDG - VALIDATING XML ---
+wsdg.validated: $(WSDG_SOURCE)
+ @ echo --- WSDG - VALIDATING XML ---
$(XMLLINT) --valid --noout $<
touch $@
# create html single page file
-developer-guide.html: $(EDG_SOURCE)
- @ echo --- EDG - HTML SINGLE PAGE ---
- mkdir -p edg_html/edg_graphics
- cp edg_graphics/* edg_html/edg_graphics
- cp ws.css edg_html
- $(XSLTPROC) --stringparam base.dir edg_html/ --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 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< > edg_html/$@
- -chmod -R og+rX edg_html
+developer-guide.html: $(WSDG_SOURCE)
+ @ echo --- WSDG - HTML SINGLE PAGE ---
+ mkdir -p wsdg_html/wsdg_graphics
+ cp wsdg_graphics/* wsdg_html/wsdg_graphics
+ cp ws.css wsdg_html
+ $(XSLTPROC) --stringparam base.dir wsdg_html/ --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/html/docbook.xsl $< > wsdg_html/$@
+ -chmod -R og+rX wsdg_html
# create html chunked page files
-edg_html_chunked: $(EDG_SOURCE)
- @ echo --- EDG - HTML CHUNKED ---
- mkdir -p edg_html_chunked
- mkdir -p edg_html_chunked/edg_graphics
- cp edg_graphics/* edg_html_chunked/edg_graphics
- cp ws.css edg_html_chunked
- $(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 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl $<
- -chmod -R og+rX edg_html_chunked
+wsdg_html_chunked: $(WSDG_SOURCE)
+ @ echo --- WSDG - HTML CHUNKED ---
+ mkdir -p wsdg_html_chunked
+ mkdir -p wsdg_html_chunked/wsdg_graphics
+ cp wsdg_graphics/* wsdg_html_chunked/wsdg_graphics
+ cp ws.css wsdg_html_chunked
+ $(XSLTPROC) --stringparam base.dir wsdg_html_chunked/ --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/html/chunk.xsl $<
+ -chmod -R og+rX wsdg_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
-developer-guide-us.fo: $(EDG_SOURCE)
+developer-guide-us.fo: $(WSDG_SOURCE)
ifdef FOP
- @ echo --- EDG - PDF US PAPER ---
+ @ echo --- WSDG - PDF US PAPER ---
$(XSLTPROC) --stringparam paper.type letter --nonet custom_layer_pdf.xsl $< > $@
endif
# create pdf file (through XSL-FO), portrait pages on A4 paper
# you will get lot's of errors, but that's ok
-developer-guide-a4.fo: $(EDG_SOURCE)
+developer-guide-a4.fo: $(WSDG_SOURCE)
ifdef FOP
- @ echo --- EDG - PDF A4 PAPER ---
+ @ echo --- WSDG - PDF A4 PAPER ---
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl $< > $@
endif
# create MS html help file (through html chunked pages)
-developer-guide.chm: $(EDG_SOURCE)
+developer-guide.chm: $(WSDG_SOURCE)
ifdef HHC
- @ echo --- EDG - MICROSOFT HTML HELP ---
- 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 --stringparam html.stylesheet ws.css --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
+ @ echo --- WSDG - MICROSOFT HTML HELP ---
+ mkdir -p 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 $<
-$(HHC) htmlhelp.hhp
-mv htmlhelp.chm $@
-rm -r htmlhelp.hhp
#
-# Make the "Ethereal User Guide" and "Ethereal Developer Guide"
+# Make the "Wireshark User Guide" and "Wireshark Developer Guide"
# in several formats.
# See the Readme.txt file for instructions.
#
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
# as wsug_chm will stop with an error, make sure it's the last in this dependency list
-all: wsug edg
+all: wsug wsdg
wsug: wsug_validate wsug_pdf_a4 wsug_html wsug_html_chunked wsug_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
+ rm -rf wsdg_html
+ rm -rf wsdg_html_chunked
+ rm -rf wsdg_chm
images:
endif
-edg: edg_validate edg_html_chunked edg_pdf_a4 edg_html edg_chm
+wsdg: wsdg_validate wsdg_html_chunked wsdg_pdf_a4 wsdg_html wsdg_chm
# validate the content
-edg_validate:
+wsdg_validate:
@ echo --- VALIDATING XML ---
$(XMLLINT) --valid --noout developer-guide.xml
# create html single page file
-edg_html:
+wsdg_html:
@ echo --- HTML SINGLE PAGE ---
- mkdir -p edg_html
- mkdir -p edg_html/graphics
- mkdir -p edg_html/graphics/toolbar
- cp ./graphics/*.* edg_html/graphics
- cp ./graphics/toolbar/*.* edg_html/graphics/toolbar
- $(XSLTPROC) --nonet $(DOCBOOKXSL)/html/docbook.xsl developer-guide.xml > edg_html/developer-guide.html
+ mkdir -p wsdg_html
+ mkdir -p wsdg_html/graphics
+ mkdir -p wsdg_html/graphics/toolbar
+ cp ./graphics/*.* wsdg_html/graphics
+ cp ./graphics/toolbar/*.* wsdg_html/graphics/toolbar
+ $(XSLTPROC) --nonet $(DOCBOOKXSL)/html/docbook.xsl developer-guide.xml > wsdg_html/developer-guide.html
# create html chunked page files
-edg_html_chunked: images
+wsdg_html_chunked: images
@ echo --- HTML CHUNKED ---
- mkdir -p edg_html_chunked
- mkdir -p edg_html_chunked/graphics
- mkdir -p edg_html_chunked/graphics/toolbar
- cp ./graphics/*.* edg_html_chunked/graphics
- cp ./graphics/toolbar/*.* edg_html_chunked/graphics/toolbar
- $(XSLTPROC) --stringparam base.dir edg_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 developer-guide.xml
+ mkdir -p wsdg_html_chunked
+ mkdir -p wsdg_html_chunked/graphics
+ mkdir -p wsdg_html_chunked/graphics/toolbar
+ cp ./graphics/*.* wsdg_html_chunked/graphics
+ cp ./graphics/toolbar/*.* wsdg_html_chunked/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir wsdg_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 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: images
+wsdg_pdf_us: images
if HAVE_FOP
@ echo --- PDF US PAPER ---
$(XSLTPROC) --nonet custom_layer_pdf.xsl $(DOCBOOKXSL)/fo/docbook.xsl developer-guide.xml > developer-guide.fo
# 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: images
+wsdg_pdf_a4: images
if HAVE_FOP
@ echo --- PDF A4 PAPER ---
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl developer-guide.xml > developer-guide.fo
endif
# create MS html help file (through html chunked pages)
-edg_chm: images
+wsdg_chm: images
if HAVE_HHC
@ echo --- MICROSOFT HTML HELP ---
- mkdir -p edg_chm
- mkdir -p edg_chm/graphics
- mkdir -p edg_chm/graphics/toolbar
- cp ./graphics/*.* edg_chm/graphics
- cp ./graphics/toolbar/*.* edg_chm/graphics/toolbar
- $(XSLTPROC) --stringparam base.dir edg_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 developer-guide.xml
+ mkdir -p wsdg_chm
+ mkdir -p wsdg_chm/graphics
+ mkdir -p wsdg_chm/graphics/toolbar
+ cp ./graphics/*.* wsdg_chm/graphics
+ cp ./graphics/toolbar/*.* wsdg_chm/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir wsdg_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 developer-guide.xml
-$(HHC) htmlhelp.hhp
mv htmlhelp.chm developer-guide.chm
rm -r htmlhelp.hhp
This directory contains the source files needed to build the:
-Ethereal User's guide
+Wireshark User's guide
and the:
-Ethereal Developer's Guide (in an early state, currently very win32 related).
+Wireshark Developer's Guide (in an early state).
To build both Guide's, just do 'make', but see requirements below.
Packages for Debian
-------------------
-TODO
+Tool/File Package
+--------- -------
+xsltproc: libxslt
+xmllint: libxml2-utils
+fop: fop
+docbook.xsl: docbook-xsl
+chunk.xsl: docbook-xsl
+htmlhelp.xsl: docbook-xsl
+docbookx.dtd: docbook-xml
+jimi: N/A - build yourself - see above
Makefile:
---------
Will generate both guide's in all available output formats (see below).
make wsug
-Will generate Ethereal User's Guide in all available output formats.
+Will generate Wireshark User's Guide in all available output formats.
make wsug_html
The HTML file is generated using xsltproc and the XSL stylesheets from
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.
-TIPP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf,
+TIP: You will get lot's of INFO/WARNING/ERROR messages when generating pdf,
but conversation works just fine.
-output: user-guide.pdf
+output: user-guide-us.pdf user-guide-a4.pdf
make wsug_chm
On Win32 platforms, the "famous" HTML help format can be generated by using a
Microsoft.
output: htmlhelp.chm
-Using the prefix edg_ instead of wsug_ will build the same targets but for the
-Ethereal Developer's Guide.
+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
+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).
FO Parameter Reference
by Norman Walsh
http://docbook.sourceforge.net/release/xsl/current/doc/fo/
+
-Use this section to encode all document information
-->
- <!ENTITY DocumentTitle "<application>Ethereal</application> Developer's Guide">
- <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &EtherealCurrentVersion;">
- <!ENTITY DocumentTitleAbbreviation "EDG">
+ <!ENTITY DocumentTitle "<application>Wireshark</application> Developer's Guide">
+ <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
+ <!ENTITY DocumentTitleAbbreviation "WSDG">
<!ENTITY DocumentCopyrightHolder "Ulf Lamping">
- <!ENTITY DocumentCopyrightYear "2004-2005">
+ <!ENTITY DocumentCopyrightYear "2004-2006">
<!ENTITY DocumentEdition "Draft">
- <!ENTITY DocumentVersion "Draft 0.0.2">
- <!ENTITY DocumentPubDate "2005">
+ <!ENTITY DocumentVersion "Draft 0.0.3">
+ <!ENTITY DocumentPubDate "2006">
<!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
%SvnVersionFile;
<!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
<!--
-Ethereal Info
+Wireshark Info
-->
- <!ENTITY EtherealCurrentVersion "0.10.14">
- <!ENTITY EtherealWebSite "http://www.wireshark.org">
- <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
- <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
- <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
- <!ENTITY EtherealDevMailList "wireshark-dev[AT]wireshark.org">
- <!ENTITY EtherealDevsGuidePage "&EtherealWebSite;/docs">
- <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs">
- <!ENTITY EtherealWikiSite "http://wiki.wireshark.org">
- <!ENTITY EtherealBugsSite "http://bugs.wireshark.org">
+ <!ENTITY WiresharkCurrentVersion "0.99.0">
+ <!ENTITY WiresharkWebSite "http://www.wireshark.org">
+ <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download.html">
+ <!ENTITY WiresharkAuthorsPage "&WiresharkWebSite;/introduction.html#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">
<!--
Gnu info
<!-- These refer to graphics files and figures contained in the document -->
- <!ENTITY EtherealLogo SYSTEM "./edg_graphics/wireshark-logo.png" NDATA PNG>
- <!ENTITY EtherealFunctionBlocks SYSTEM "./edg_graphics/ethereal-function-blocks.png" NDATA PNG>
+ <!ENTITY WiresharkLogo SYSTEM "./edg_graphics/wireshark-logo.png" NDATA PNG>
+ <!ENTITY WiresharkFunctionBlocks SYSTEM "./edg_graphics/ethereal-function-blocks.png" NDATA PNG>
<!-- These are the actual files that make up the document -->
- <!ENTITY BookMetaInformation SYSTEM "edg_src/EDG_meta_info.xml">
- <!ENTITY Preface SYSTEM "edg_src/EDG_preface.xml">
- <!ENTITY EnvIntroduction SYSTEM "edg_src/EDG_chapter_env_intro.xml">
- <!ENTITY Tools SYSTEM "edg_src/EDG_chapter_tools.xml">
- <!ENTITY Libraries SYSTEM "edg_src/EDG_chapter_libraries.xml">
- <!ENTITY Sources SYSTEM "edg_src/EDG_chapter_sources.xml">
+ <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
+ <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
+ <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
+ <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
+ <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
+ <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
- <!ENTITY BuildIntroduction SYSTEM "edg_src/EDG_chapter_build_intro.xml">
- <!ENTITY HowEtherealWorks SYSTEM "edg_src/EDG_chapter_works.xml">
- <!ENTITY Capture SYSTEM "edg_src/EDG_chapter_capture.xml">
- <!ENTITY Dissection SYSTEM "edg_src/EDG_chapter_dissection.xml">
- <!ENTITY UserInterface SYSTEM "edg_src/EDG_chapter_userinterface.xml">
+ <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
+ <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
+ <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
+ <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
+ <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
<!ENTITY AppGPL SYSTEM "GPL_appendix.xml">
&BookMetaInformation;
&Preface;
<part id="PartEnvironment" label="I">
-<title>Ethereal Build Environment</title>
+<title>Wireshark Build Environment</title>
<partintro>
<para>
-<command>Part I. Ethereal Build Environment</command>
+<command>Part I. Wireshark Build Environment</command>
</para>
<para>
<command>The first part describes how to set up the tools, libraries and
-source needed to generate Ethereal, and how to do some typical development
+source needed to generate Wireshark, and how to do some typical development
tasks.</command>
</para>
<para>
-Part II. Ethereal Development
+Part II. Wireshark Development
</para>
<para>
The second part describes how the Wireshark sources are structured and how
&Sources;
</part>
<part id="PartDevelopment" label="II">
-<title>Ethereal Development (incomplete)</title>
+<title>Wireshark Development (incomplete)</title>
<partintro>
<!--<para>
This is the second of two parts:
</para>-->
<para>
-Part I. Ethereal Build Environment
+Part I. Wireshark Build Environment
</para>
<para>
The first part describes how to set up the tools, libraries and source needed
-to generate Ethereal, and how to do some typical development tasks.
+to generate Wireshark, and how to do some typical development tasks.
</para>
<para>
-<command>Part II. Ethereal Development</command>
+<command>Part II. Wireshark Development</command>
</para>
<para>
<command>The second part describes how the Wireshark sources are structured and how
to change the sources (e.g. adding a new dissector).</command>
</para>
</partintro>
-&HowEtherealWorks;
+&HowWiresharkWorks;
&BuildIntroduction;
&Capture;
&Dissection;
-<!-- EDG Chapter Build Introduction -->
+<!-- WSDG Chapter Build Introduction -->
<!-- $Id$ -->
<chapter id="ChapterBuildIntro">
<section id="ChCodeOverview">
<title>Source overview</title>
<para>
- Ethereal consists of the following major parts:
+ Wireshark consists of the following major parts:
<itemizedlist>
<listitem><para>
Packet dissection - in the / and /epan directory
</para></listitem>
<listitem><para>
- File I/O - using Ethereal's own wiretap library
+ File I/O - using Wireshark's own wiretap library
</para></listitem>
<listitem><para>
Capture - using the libpcap/winpcap library
</para>
<para>
GLib contains lot's of useful things for platform independant development.
- See XXX for details about GLib.
+ See <ulink url="http://developer.gnome.org/doc/API/2.0/glib/index.html"/>
+ for details about GLib.
</para>
</section>
</chapter>
-<!-- End of EDG Chapter Build Introduction -->
+<!-- End of WSDG Chapter Build Introduction -->
-<!-- EDG Chapter Capture -->
+<!-- WSDG Chapter Capture -->
<!-- $Id$ -->
<chapter id="ChapterCapture">
<para>
The following is an excerpt from a developer mailing list mail, about
adding ISO 9141 and 14230 (simple serial line car diagnostics) to
- Ethereal:
+ Wireshark:
</para>
<para>
For libpcap, the first thing you'd need to do would be to get DLT_ values
routine, so that the user can select the appropriate link-layer type.
</para>
<para>
- For Ethereal, you'd add support for those DLT_ values to wiretap/libpcap.c,
+ For Wireshark, you'd add support for those DLT_ values to wiretap/libpcap.c,
which might mean adding one or more WTAP_ENCAP types to wtap.h and to the
encap_table[] table in wiretap/wtap.c. You'd then have to write a
dissector or dissectors for the link-layer protocols or protocols and have
-<!-- EDG Chapter Dissection -->
+<!-- WSDG Chapter Dissection -->
<!-- $Id$ -->
<chapter id="ChapterDissection">
void proto_reg_handoff_foo();
void dissect_foo(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
-/* Define version if we are not building ethereal statically */
+/* Define version if we are not building Wireshark statically */
#ifndef ENABLE_STATIC
G_MODULE_EXPORT const gchar version[] = "0.0";
#endif
{ 1, "Initialise" },
{ 2, "Terminate" },
{ 3, "Data" },
- { 0, NULL },
+ { 0, NULL }
};
]]>
</programlisting></example>
</section>
</chapter>
-<!-- End of EDG Chapter Dissection -->
+<!-- End of WSDG Chapter Dissection -->
-<!-- EDG Chapter Introduction -->
+<!-- WSDG Chapter Introduction -->
<!-- $Id$ -->
<chapter id="ChapterIntroduction">
<section id="ChIntroIntro">
<title>Introduction</title>
<para>
- This chapter will provide you with information about Ethereal
+ This chapter will provide you with information about Wireshark
development in general.
</para>
</section>
<section id="ChIntroWhatIs">
- <title>What is <application>Ethereal?</application></title>
+ <title>What is <application>Wireshark?</application></title>
<para>
- Well, if you want to start Ethereal development, you might already
+ Well, if you want to start Wireshark development, you might already
know what Wireshark is doing. If not, please have a look at the
- <ulink url="&EtherealUsersGuidePage;">Ethereal User's Guide</ulink>,
+ <ulink url="&WiresharkUsersGuidePage;">Wireshark User's Guide</ulink>,
which will provide a lot of general information about it.
</para>
</section>
<section id="ChIntroPlatforms">
- <title>Platforms Ethereal runs on</title>
+ <title>Platforms Wireshark runs on</title>
<para>
- Ethereal currently runs on most UNIX platforms and various Windows
+ Wireshark currently runs on most UNIX platforms and various Windows
platforms. It requires GTK+, GLib, libpcap and some other libraries in
order to run.
</para>
<para>
If a binary package is not available for your platform, you should
download the source and try to build it. Please report your experiences
- to <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>.
+ to <ulink url="mailto:&WiresharkDevMailList;">&WiresharkDevMailList;</ulink>.
</para>
<para>
Binary packages are available for at least the following platforms:
differences will be notified where appropriate. All Windows platforms
referred to as Win32, Win or Windows may be used with the same meaning.
As Windows CE differs a lot compared to the other Windows platforms
- mentioned, Ethereal will not run on Windows CE and there are no plans to
+ mentioned, Wireshark will not run on Windows CE and there are no plans to
support it.
<itemizedlist>
<listitem><para>Windows Me / 98 / 95</para></listitem>
<section id="ChIntroDevelopment">
<title>
- Development and maintenance of <application>Ethereal</application>
+ Development and maintenance of <application>Wireshark</application>
</title>
<para>
- Ethereal was initially developed by Gerald Combs. Ongoing development
+ Wireshark was initially developed by Gerald Combs. Ongoing development
and maintenance of Wireshark is handled by the Wireshark team, a loose
group of individuals who fix bugs and provide new functionality.
</para>
<para>
There have also been a large number of people who have contributed
- protocol dissectors to Ethereal, and it is expected that this will
+ protocol dissectors to Wireshark, and it is expected that this will
continue. You can find a list of the people who have contributed
- code to Ethereal by checking the about dialog box of Ethereal, or have
- a look at the <ulink url="&EtherealAuthorsPage;"/> page on the Wireshark
+ code to Wireshark by checking the about dialog box of Wireshark, or have
+ a look at the <ulink url="&WiresharkAuthorsPage;"/> page on the Wireshark
web site.
</para>
<para>
</para>
<para>
It is strongly recommended to join the developer mailing list, if you
- are going to do any Ethereal development. See
- <xref linkend="ChIntroMailingLists"/> about the different Ethereal
+ are going to do any Wireshark development. See
+ <xref linkend="ChIntroMailingLists"/> about the different Wireshark
mailing lists available.
</para>
Almost any part of Wireshark is implemented in plain ANSI C.
</para>
<para>
- The typical task for a new Ethereal developer is to extend an existing,
+ The typical task for a new Wireshark developer is to extend an existing,
or write a new dissector for a specific network protocol. As (almost) any
dissector is written in plain old ANSI C, a good knowledge about ANSI C
will be sufficient for Wireshark development in almost any case.
</para>
<para>
- So unless you are going to change the development process of Ethereal
+ So unless you are going to change the development process of Wireshark
itself, you won't come in touch with any other programming language than
ANSI C (such as perl or python, which are used only in the Wireshark build
process).
<para>
Beside the usual tools for developing a program in C (compiler, make, ...),
the build process uses some additional helper tools (Perl, Python, Sed,
- ...), which are needed for the build process and in the case Ethereal
+ ...), which are needed for the build process and in the case Wireshark
should be installed from the released source packages. If Wireshark is
installed from a binary package, none of these helper tools are needed on
the target system.
<para>
Wireshark is an open source software project, and is released under
the <ulink url="&GPLWebsite;">GNU General Public Licence</ulink> (GPL).
- You can freely use Ethereal on any number of computers you like, without
+ You can freely use Wireshark on any number of computers you like, without
worrying about license keys or fees or such. In addition, all source
code is freely available under the GPL. Because of that, it is very easy
- for people to add new protocols to Ethereal, either as plugins, or built
+ for people to add new protocols to Wireshark, either as plugins, or built
into the source, and they often do!
</para>
<para>
You are welcome to
- modify Ethereal to suit your own needs, and it would be appreciated
+ modify Wireshark to suit your own needs, and it would be appreciated
if you contribute your improvements back to the Wireshark team.
</para>
<para>
<para>
Other people who find your contributions useful will appreciate
them, and you will know that you have helped people in the
- same way that the developers of Ethereal have helped people.
+ same way that the developers of Wireshark have helped people.
</para>
</listitem>
<listitem>
<para>
- The developers of Ethereal might improve your changes even more,
+ The developers of Wireshark might improve your changes even more,
as there's always room for improvements. Or they may implement some
advanced things on top of your code, which can be useful for yourself
too.
</listitem>
<listitem>
<para>
- The maintainers and developers of Ethereal will maintain your
+ The maintainers and developers of Wireshark will maintain your
code as well, fixing it when API changes or other changes are
made, and generally keeping it in tune with what is happening
- with Ethereal. So if Wireshark is updated (which is done often),
- you can get a new Ethereal version from the website and your changes
+ with Wireshark. So if Wireshark is updated (which is done often),
+ you can get a new Wireshark version from the website and your changes
will already be included without any effort for you.
</para>
</listitem>
<para>
The Wireshark source code and binary kits for some platforms are all
available on the download page of the Wireshark website:
- <ulink url="&EtherealDownloadPage;">&EtherealDownloadPage;</ulink>.
+ <ulink url="&WiresharkDownloadPage;">&WiresharkDownloadPage;</ulink>.
</para>
</section>
<title>Releases and distributions</title>
<para>
The officially released files can be found at: <ulink
- url="&EtherealDownloadPage;"/>. A new Ethereal version is released, after
+ url="&WiresharkDownloadPage;"/>. A new Wireshark version is released, after
significant changes compared to the last release were completed or a
serious security issue was encountered. The typical release schedule is
about every 4-8 weeks (although this may vary).
</para>
</listitem>
</itemizedlist>
- However, if you want to start developing with Ethereal, the binary
+ However, if you want to start developing with Wireshark, the binary
distributions won't be much helpful, as you need the source files, of
course.
</para>
files) these days.
</para>
<para>
- You should use the released sources if you want to build Ethereal from
+ You should use the released sources if you want to build Wireshark from
source on your platform for productive use. However, if you going to
develop changes to the Wireshark sources, it might be better to use the
latest SVN sources. For details about the different ways to get the
- Ethereal source code see <xref linkend="ChSrcObtain"/>.
+ Wireshark source code see <xref linkend="ChSrcObtain"/>.
</para>
<para>
- Before building Ethereal from a source distribution, make sure you have
+ Before building Wireshark from a source distribution, make sure you have
all the tools and libraries required to build. The following chapters will
describe the required tools and libraries in detail.
</para>
<section id="ChIntroHelp">
<title>Reporting problems and getting help</title>
<para>
- If you have problems, or need help with Ethereal, there are several
+ If you have problems, or need help with Wireshark, there are several
places that may be of interest to you (well, beside this guide of
course).
</para>
<section id="ChIntroHomepage"><title>Website</title>
<para>
You will find lot's of useful information on the Wireshark homepage at
- <ulink url="&EtherealWebSite;">&EtherealWebSite;</ulink>.
+ <ulink url="&WiresharkWebSite;">&WiresharkWebSite;</ulink>.
</para>
</section>
<section id="ChIntroWiki"><title>Wiki</title>
<para>
The Wireshark Wiki at <ulink
- url="&EtherealWikiSite;">&EtherealWikiSite;</ulink> provides a wide range
- of information related to Ethereal and packet capturing in general.
+ url="&WiresharkWikiSite;">&WiresharkWikiSite;</ulink> provides a wide range
+ of information related to Wireshark and packet capturing in general.
You will find a lot of information not part of this developer's guide. For
example, there is an explanation how to capture on a switched network,
an ongoing effort to build a protocol reference and a lot more.
subscribed to the mailing lists).
</para>
</note>
- You will find the FAQ inside Ethereal by clicking the menu item
+ You will find the FAQ inside Wireshark by clicking the menu item
Help/Contents and selecting the FAQ page in the upcoming dialog.
</para>
<para>
- An online version is available at the ethereal website:
- <ulink url="&EtherealFAQPage;">&EtherealFAQPage;</ulink>. You might
+ An online version is available at the Wireshark website:
+ <ulink url="&WiresharkFAQPage;">&WiresharkFAQPage;</ulink>. You might
prefer this online version, as it's typically more up to date and the HTML
format is easier to use.
</para>
<section id="ChIntroMailingLists"><title>Mailing Lists</title>
<para>
- There are several mailing lists of specific Ethereal topics available:
+ There are several mailing lists of specific Wireshark topics available:
<variablelist>
<varlistentry><term><command>wireshark-announce</command></term>
<listitem>
<varlistentry><term><command>wireshark-users</command></term>
<listitem>
<para>
- This list is for users of Ethereal. People post
- questions about building and using Ethereal, others (hopefully)
+ This list is for users of Wireshark. People post
+ questions about building and using Wireshark, others (hopefully)
provide answers.
</para>
</listitem>
<listitem>
<para>
This list is for Wireshark developers. People post questions about
- the development of Ethereal, others (hopefully) provide answers.
+ the development of Wireshark, others (hopefully) provide answers.
If you want to start developing a protocol dissector, join this list.
</para>
</listitem>
</varlistentry>
</variablelist>
You can subscribe to each of these lists from the Wireshark web site:
- <ulink url="&EtherealWebSite;">&EtherealWebSite;</ulink>. Simply
+ <ulink url="&WiresharkWebSite;">&WiresharkWebSite;</ulink>. Simply
select the <command>mailing lists</command> link on the left hand
side of the site. The lists are archived at the Wireshark web site
as well.
<section id="ChIntroBugDatabase"><title>Bug database</title>
<para>
The Etereal community started collecting bug reports in a Bugzilla database at
- <ulink url="&EtherealBugsSite;">&EtherealBugsSite;</ulink>.
+ <ulink url="&WiresharkBugsSite;">&WiresharkBugsSite;</ulink>.
This database is filled with manually filed bug reports, usually after some
discussion on wireshark-dev, and bug reports from the QA build tooling.
</para>
<note><title>Note!</title>
<para>
Before reporting any problems, please make sure you have installed the
- latest version of Ethereal.
+ latest version of Wireshark.
</para>
</note>
<para>
information as possible. In general, just think about what
you would need to find that problem, if someone else sends you such a
problem report. Also keep in mind, that people uses a lot of different
- platforms to compile/run Ethereal on.
+ platforms to compile/run Wireshark on.
</para>
<para>
- When reporting problems with Ethereal, it is helpful if you supply the
+ When reporting problems with Wireshark, it is helpful if you supply the
following information:
<orderedlist>
<listitem>
<para>
- The version number of Ethereal and the dependent libraries linked with
+ The version number of Wireshark and the dependent libraries linked with
it, eg GTK+, etc. You can obtain this with the command
- <command>ethereal -v</command>.
+ <command>wireshark -v</command>.
</para>
</listitem>
<listitem>
<para>
- Information about the platform you run Ethereal on.
+ Information about the platform you run Wireshark on.
</para>
</listitem>
<listitem>
<section><title>Reporting Crashes on UNIX/Linux platforms</title>
<para>
- When reporting crashes with Ethereal, it is helpful if you supply the
+ When reporting crashes with Wireshark, it is helpful if you supply the
traceback information (besides the information mentioned in
<xref linkend="ChIntroReportProblems"/>).
</para>
You can obtain this traceback information with the following commands:
<programlisting>
<![CDATA[
-$ gdb `whereis ethereal | cut -f2 -d: | cut -d' ' -f2` core >& bt.txt
+$ gdb `whereis wireshark | cut -f2 -d: | cut -d' ' -f2` core >& bt.txt
backtrace
^D
$
</para>
<para>
You should mail the traceback to the
- <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>
+ <ulink url="mailto:&WiresharkDevMailList;">&WiresharkDevMailList;</ulink>
mailing list, or append it to your bug report.
</para>
</section>
</section>
</chapter>
-<!-- End of EDG Chapter 1 -->
+<!-- End of WSDG Chapter Introduction -->
-<!-- EDG Chapter Libraries -->
+<!-- WSDG Chapter Libraries -->
<!-- $Id$ -->
<chapter id="ChapterLibraries">
<section id="ChLibIntro">
<title>Introduction</title>
<para>
- Several libraries are needed to build / run Ethereal. Most of the
+ Several libraries are needed to build / run Wireshark. Most of the
libraries are splitted into three packages:
<orderedlist>
<listitem>
<listitem>
<para>
Source package: library sources, usually not required to
- build ethereal
+ build Wireshark
</para>
</listitem>
</orderedlist>
<section id="ChLibsFormatWin32MSVC6">
<title>Win32: MSVC V6</title>
<para>
- Recommended for current Win32 Ethereal releases.
+ Recommended for current Win32 Wireshark releases.
Most of the Win32 binary libraries you will find on the web are in this
format. You will recognize MSVC libraries by the .lib/.dll file extension.
</para>
<para>
Before you start the download, you must have installed both
the required tools (see <xref linkend="ChapterTools"/>) and also the
- Ethereal sources (see <xref linkend="ChSrcObtain"/>).
+ Wireshark sources (see <xref linkend="ChSrcObtain"/>).
</para>
</note>
<para>
<prompt>></prompt> <userinput>nmake -f Makefile.nmake setup</userinput>
</para>
<para>
- This will first check for all the various tools needed to build Ethereal,
+ This will first check for all the various tools needed to build Wireshark,
as described already in <xref linkend="ChToolsWin32Verify"/>.
</para>
<para>
<itemizedlist>
<listitem>
<para>
- Update your Ethereal sources to the latest SVN files (see <xref
+ Update your Wireshark sources to the latest SVN files (see <xref
linkend="ChSrcObtain"/>), so the zip filenames in the setup target
of Makefile.nmake is in sync with the library zip files on the server.
</para>
<para>
Remove all files previously unzipped from the downloaded files in your
WIRESHARK_LIBS library path (all the subdirs, e.g.
- <filename>c:\ethereal_libs\gtk+</filename>),
+ <filename>c:\wireshark-win32-libs\gtk+</filename>),
except for the zip files located at the toplevel, which are the files
downloaded the last time(s). You could do this, be entering at the command line:
</para>
description about GLib, see <xref linkend="ChCodeGLib"/>.
</para>
<para>
- The GTK and it's dependant libraries are used to build Ethereal's GUI.
+ The GTK and it's dependant libraries are used to build Wireshark's GUI.
For a detailed description of the GTK libraries, see <xref
linkend="ChUIGTK"/>.
</para>
<para>
All other libraries are dependant on the two libraries mentioned above,
- you will typically not come in touch with these while doing Ethereal
+ you will typically not come in touch with these while doing Wireshark
development.
</para>
<para>
<section id="ChLibsWin32SNMP">
<title>Win32 MSVC</title>
<para>
- Ethereal uses the source Net-SNMP distribution at
+ Wireshark uses the source Net-SNMP distribution at
<ulink url="http://sourceforge.net/projects/net-snmp/"/>.
Then libsnmp is compiled with the "libsnmp - Win32 Release" project
- using MSVC++ 6.0. A file called "README.ethereal" has been placed in the
+ using MSVC++ 6.0. A file called "README.wireshark" has been placed in the
net-snmp zip archive at <ulink
url="http://anonsvn.wireshark.org/wireshark-win32-libs/trunk/packages/"/>
describing the changes in more detail.
</chapter>
-<!-- End of EDG Chapter Libraries -->
+<!-- End of WSDG Chapter Libraries -->
-<!-- EDG Chapter Sources -->
+<!-- WSDG Chapter Sources -->
<!-- $Id$ -->
<chapter id="ChapterSources">
<title>The Wireshark Subversion repository</title>
<para>
Subversion is used to keep track of the changes made to the Wireshark
- source code. The Wireshark source code is stored inside Ethereal project's
+ source code. The Wireshark source code is stored inside Wireshark project's
Subversion repository located at a server at the wireshark.org domain.
</para>
<para>
</para>
</tip>
<para>
- Using Ethereal's Subversion repository you can:
+ Using Wireshark's Subversion repository you can:
<itemizedlist>
<listitem><para>
keep your private sources uptodate with very little effort
</itemizedlist>
</para>
<para>
- The way Ethereal uses Subversion, it can be parted into a client and a
+ The way Wireshark uses Subversion, it can be parted into a client and a
server part. Thanks to Gerald Combs (the maintainer of the Subversion
server), no user usually has to deal with the
Subversion server. You will only need a Subversion client, which is
found at:
</para>
<para>
- <ulink url="http://anonsvn.wireshark.org/ethereal/trunk/"/>.
+ <ulink url="http://anonsvn.wireshark.org/wireshark/trunk/"/>.
</para>
<para>
A <command>comprehensive view</command> of all source versions
is available at:
</para>
<para>
- <ulink url="http://anonsvn.wireshark.org/viewcvs/viewcvs.py/"/>.
+ <ulink url="http://anonsvn.wireshark.org/viewvc/viewvc.cgi/"/>.
</para>
<para>
Of special interest might be the subdirectories:
<section id="ChSrcObtain">
<title>Obtain the Wireshark sources</title>
<para>
- There are several ways to obtain the sources from Ethereal's Subversion
+ There are several ways to obtain the sources from Wireshark's Subversion
server.
</para>
<tip><title>Tip!</title>
</para>
<para>
You can use a Subversion client to download the source code from
- Ethereal's anonymous Subversion repository. The URL for the repository
+ Wireshark's anonymous Subversion repository. The URL for the repository
trunk is:
- <ulink url="http://anonsvn.wireshark.org/ethereal/trunk/"/>.
+ <ulink url="http://anonsvn.wireshark.org/wireshark/trunk/"/>.
</para>
<para>
See <xref linkend="ChToolsSubversion"/> how to install a Subversion client.
</para>
<para>
<prompt>$</prompt>
- <userinput>svn checkout http://anonsvn.wireshark.org/ethereal/trunk ethereal</userinput>
+ <userinput>svn checkout http://anonsvn.wireshark.org/wireshark/trunk wireshark</userinput>
</para>
<para>
The checkout has to be only done once. This will copy all the sources of
<para>
The entire source tree of the Subversion repository is available via a
web interface at:
- <ulink url="http://anonsvn.wireshark.org/viewcvs/viewcvs.py/"/>.
+ <ulink url="http://anonsvn.wireshark.org/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 or entire directories.
</para>
<para>
The buildbot server will automatically start to generate a snapshot of
- Ethereal's sourcetree after a source code change committed.
+ Wireshark's sourcetree after a source code change committed.
These snapshots can be found at: <ulink
url="http://www.wireshark.org/distribution/buildbot-builds/source/"/>.
</para>
<para>
The officially released source files can be found at: <ulink
url="http://www.wireshark.org/download.html"/>.
- You should use these sources if you want to build Ethereal on your
+ You should use these sources if you want to build Wireshark on your
platform for productive use.
</para>
<para>
</section>
<section id="ChSrcBuildFirstTime">
- <title>Build Ethereal for the first time</title>
+ <title>Build Wireshark for the first time</title>
<para>
The sources contains several documentation files, it's a good idea to
look at these files first.
<tip><title>Tip!</title>
<para>
It is a very good idea, to first test your complete build environment
- (including running and debugging Ethereal) before doing any changes
+ (including running and debugging Wireshark) before doing any changes
to the source code (unless otherwise noted).
</para>
</tip>
<section>
<title>Unix</title>
<para>
- Run the autogen.sh script at the top-level ethereal directory to configure
+ Run the autogen.sh script at the top-level wireshark directory to configure
your build directory.
<programlisting>
./autogen.sh
<prompt>></prompt> <userinput>nmake -f Makefile.nmake all</userinput>
</para>
<para>
- will start the whole Ethereal build process.
+ will start the whole Wireshark build process.
</para>
<para>
After the build process successfully finished, you should find an
- <filename>ethereal.exe</filename> and some other files
+ <filename>wireshark.exe</filename> and some other files
in the root directory.
</para>
</section>
</section>
<section id="ChSrcRunFirstTime">
- <title>Run generated Ethereal for the first time</title>
+ <title>Run generated Wireshark for the first time</title>
<tip><title>Tip!</title>
<para>
- An already installed Ethereal may interfere with your newly generated
- version in various ways. If you have any problems getting your Ethereal
+ An already installed Wireshark may interfere with your newly generated
+ version in various ways. If you have any problems getting your Wireshark
running the first time, it might be a good idea to remove the previously
installed version first.
</para>
</section>
<section id="ChSrcDebug">
- <title>Debug your generated Ethereal</title>
+ <title>Debug your generated Wireshark</title>
<para>
- See the above info on running Ethereal.
+ See the above info on running Wireshark.
</para>
<para>
XXX - add more info here.
<title>Make changes to the Wireshark sources</title>
<para>
As the Wireshark developers working on many different platforms, a lot of
- editors are used to develop Ethereal (emacs, vi, Microsoft Visual Studio
+ editors are used to develop Wireshark (emacs, vi, Microsoft Visual Studio
and many many others). There's no "standard" or "default" development
environment.
</para>
<para>
- There are several reasons why you might want to change the Ethereal
+ There are several reasons why you might want to change the Wireshark
sources:
<itemizedlist>
<listitem><para>add your own new dissector</para></listitem>
<listitem><para>
Other people who find your contributions useful will appreciate
them, and you will know that you have helped people in the same way
- that the developers of Ethereal have helped people
+ that the developers of Wireshark have helped people
</para></listitem>
<listitem><para>
- The developers of Ethereal might improve your changes even more, as
+ The developers of Wireshark might improve your changes even more, as
there's always room for improvements. Or they may implement some advanced
things on top of your code, which can be useful for yourself too.
</para></listitem>
<listitem><para>
- The maintainers and developers of Ethereal will maintain your code as
+ The maintainers and developers of Wireshark will maintain your code as
well, fixing it when API changes or other changes are made, and generally
- keeping it in tune with what is happening with Ethereal. So if Wireshark is
- updated (which is done often), you can get a new Ethereal version from
+ keeping it in tune with what is happening with Wireshark. So if Wireshark is
+ updated (which is done often), you can get a new Wireshark version from
the website and your changes will already be included without any effort
- for you. The maintainers and developers of Ethereal will maintain your
+ for you. The maintainers and developers of Wireshark will maintain your
code as well, fixing it when API changes or other changes are made, and
- generally keeping it in tune with what is happening with Ethereal.
+ generally keeping it in tune with what is happening with Wireshark.
</para></listitem>
</itemizedlist>
There's no direct way to commit changes to the SVN repository. Only a few
Here is a small example of a patch file (XXX - generate a better example):
<programlisting>
<![CDATA[
-diff -ur ../wireshark-0.10.6/epan/dissectors/packet-dcerpc.c ./epan/dissectors/packet-dcerpc.c
---- ../wireshark-0.10.6/epan/dissectors/packet-dcerpc.c 2004-08-12 15:42:26.000000000 -0700
-+++ ./epan/dissectors/packet-dcerpc.c 2004-08-19 18:48:32.000000000 -0700
+diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/packet-dcerpc.c
+--- ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c 2005-08-12 15:42:26.000000000 -0700
++++ ./epan/dissectors/packet-dcerpc.c 2005-08-19 18:48:32.000000000 -0700
@@ -282,6 +282,7 @@
/* we need to keep track of what transport were used, ie what handle we came
* in through so we know what kind of pinfo->private_data was passed to us.
<section id="ChSrcSVNDiff">
<title>Using the svn command-line client</title>
<para>
- svn diff -u [changed_files] > svn.diff
+ <userinput>svn diff [changed_files] > svn.diff</userinput>
</para>
<para>
XXX - add more details
<listitem><para>
<command>Find a good descriptive filename for your patch.</command>
Think a moment to find a proper name for your patch file. Often a
- filename like <filename>ethereal.diff</filename> is used, which isn't
+ filename like <filename>wireshark.diff</filename> is used, which isn't
really helpful if keeping several of these files and find the right
one later. For example: If you want to commit changes to the datatypes
of dissector foo, a good filename might be:
<title>Code Requirements</title>
<para>
The core maintainers have a lot of work fixing bugs and making code
- compile on the various platforms Ethereal supports.
+ compile on the various platforms Wireshark supports.
</para>
<para>
- To ensure Ethereal's source code quality, and to reduce the workload of
+ To ensure Wireshark's source code quality, and to reduce the workload of
the core maintainers, there are some things you should
think about <command>before</command> submitting a patch.
<warning><title>Warn!</title>
Just because something compiles on your platform, that doesn't
mean it'll compile on all of the other platforms for which Wireshark is
built.
- Ethereal runs on many platforms, and can be compiled with a number of
+ Wireshark runs on many platforms, and can be compiled with a number of
different compilers. See <xref linkend="ChCodeStyle"/> for details.
</para>
</listitem>
<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
- "ethereal.orig/prefs.c" and "ethereal.mine/prefs.c", you'd run it with:
+ "wireshark.orig/prefs.c" and "wireshark.mine/prefs.c", you'd run it with:
</para>
<para>
<userinput>patch -p1 <new.diff</userinput>
</para>
<note><title>Note!</title>
<para>
- This action is only possible/allowed by the ethereal core developers who
+ This action is only possible/allowed by the Wireshark core developers who
have write access to the Subversion repository. It is put in here, to have
all information in one place.
</para>
Add a line to each new file, containing the following text (case is
important, so don't write ID or id or iD):
<programlisting>
-$Id$
+$Id:$
</programlisting>
</para>
</listitem>
<title>Binary packaging</title>
<para>
Delivering binary packages, makes it much easier for the end-users to
- install Ethereal on their target system. This section will explain how
+ install Wireshark on their target system. This section will explain how
the binary packages are made.
</para>
installed and wether to use the modern UI (which is recommended) or not.
</para>
<para>
- In the ethereal directory, type:
+ In the wireshark directory, type:
</para>
<para>
<prompt>></prompt> <userinput>nmake -f makefile.nmake packaging</userinput>
</tip>
<para>
If everything went well, you will now find something like:
- <filename>wireshark-setup-&EtherealCurrentVersion;.exe</filename> in
+ <filename>wireshark-setup-&WiresharkCurrentVersion;.exe</filename> in
the <filename>packaging/nsis</filename> directory.
</para>
</section>
</section>
</chapter>
-<!-- End of EDG Chapter Sources -->
+<!-- End of WSDG Chapter Sources -->
-<!-- EDG Chapter Tools -->
+<!-- WSDG Chapter Tools -->
<!-- $Id$ -->
<chapter id="ChapterTools">
the various tools needed for Wireshark development.
</para>
<para>
- None of the tools mentioned in this chapter is needed to run Ethereal,
+ None of the tools mentioned in this chapter is needed to run Wireshark,
they are only needed to build it.
</para>
<para>
Don't get confused by the (optional) marker at some of the items in the
"Tool" column.
Although these tools are not required to <command>build</command>
- Ethereal they can make development life much easier and some are even
+ Wireshark they can make development life much easier and some are even
required by the following installation procedure.
</para>
</section>
<title>Install Microsoft Visual Studio Version 6</title>
<para>
Install MSVC the usual way. Don't forget to install vcvars32.bat or call
- it manually before building Ethereal. vcvars32.bat will set some required
+ it manually before building Wireshark. vcvars32.bat will set some required
environment settings.
</para>
<warning><title>Warning!</title>
<title>Install Additional Tools</title>
<para>
Depending on your actual task the following tools are recommended.
- Please note that they are not required to build Ethereal but can be
+ Please note that they are not required to build Wireshark but can be
quite helpful.
</para>
<section>
<userinput>nmake -f Makefile.nmake verify_tools</userinput>
</para>
<para>
- This will check for the various tools needed to build Ethereal:
+ This will check for the various tools needed to build Wireshark:
</para>
<para>
<programlisting>
</note>
</para>
<para>
- The mainline for generating Ethereal on the windows platform, is using
+ The mainline for generating Wireshark on the windows platform, is using
the compiler cl.exe from the Microsoft Visual Studio version 6 (and it's
nmake, as described below).
</para>
<warning><title>Warning!</title>
<para>
The recent "Microsoft Visual Studio .NET" C compiler(s) currently cannot
- be used to compile Ethereal!!!
+ be used to compile Wireshark!!!
</para>
</warning>
</para>
<para>
Example why this hurts: A dependant library might try to open a file using
functions in MSVCRT.dll which creates an internal file handle and keeps
- information about that file. When Ethereal tries to read data from that
+ information about that file. When Wireshark tries to read data from that
file, it uses the functions from MSVCRT70.dll, which doesn't know anything
about that previously opened file and returns an error code.
</para>
MSVCRT.dll but they seemed to fail :-(
</para>
<para>
- It's also still unsure, if shipping the MSVCRT70.dll together with Ethereal
+ It's also still unsure, if shipping the MSVCRT70.dll together with Wireshark
is compatible with the GPL license at all.
</para>
<note><title>Note!</title>
<para>
- This isn't an Ethereal specific problem. Any software project trying to use
+ This isn't an Wireshark specific problem. Any software project trying to use
the version 7 C compiler will have the problems described above!
</para>
</note>
<para>
XXX - what about the legal issue, as the MSVCRT70.dll had to be shipped
- with Ethereal.
+ with Wireshark.
</para>
</section>
some people still think it's use is optional.
</para>
<para>
- The debugger you use must match the C compiler Ethereal was compiled with,
+ The debugger you use must match the C compiler Wireshark was compiled with,
otherwise the debugger will simply fail or you will only see a lot of
garbage.
</para>
<warning><title>Warning!</title>
<para>
It is recommended to use the Microsoft Visual Studio version 6 to compile
- Ethereal for Win32, see <xref linkend="ChToolsCompiler"/>. Don't follow the
+ Wireshark for Win32, see <xref linkend="ChToolsCompiler"/>. Don't follow the
instructions in this section, until you now what you are doing.
</para>
</warning>
<para>
Diff is used to get a file of all differences between two source
files/trees (sometimes called a patch). The diff tool isn't needed for
- building Ethereal, but it's needed if you are going to commit your changes
+ building Wireshark, but it's needed if you are going to commit your changes
back to the Wireshark community.
</para>
<note><title>Note!</title>
</chapter>
-<!-- End of EDG Chapter Tools -->
+<!-- End of WSDG Chapter Tools -->
<!-- $Id$ -->
<bookinfo>
- <title><inlinegraphic entityref="EtherealLogo" valign="middle" format="PNG"/> &DocumentTitle;</title>
+ <title><inlinegraphic entityref="WiresharkLogo" valign="middle" format="PNG"/>&DocumentTitle;</title>
<subtitle>&DocumentSubTitle;</subtitle>
<authorgroup>
<author><firstname>&AuthorFirstName;</firstname><surname>&AuthorSurname;</surname>
<title>Foreword</title>
<para>
This book tries to give you a guide to start your own experiments into
- the wonderful world of Ethereal development.
+ the wonderful world of Wireshark development.
</para>
<para>
- Developers who are new to Ethereal are often having a hard time getting
+ Developers who are new to Wireshark are often having a hard time getting
their development environment up and running. This is
especially true for Win32 developers, as a lot of the tools and methods
- used when building Ethereal are much more common in the UNIX world than
+ used when building Wireshark are much more common in the UNIX world than
on Win32.
</para>
<para>
The first part of this book will describe how to set up the environment
- needed to develop Ethereal.
+ needed to develop Wireshark.
</para>
<para>
The second part of this book will describe how to change the Wireshark
<title>Who should read this document?</title>
<para>
The intended audience of this book is anyone going into the development of
- Ethereal.
+ Wireshark.
</para>
<para>
- This book is not intended to explain the usage of Ethereal in general.
+ This book is not intended to explain the usage of Wireshark in general.
Please refer the
- <ulink url="&EtherealUsersGuidePage;">Ethereal User's Guide</ulink>
- about Ethereal usage.
+ <ulink url="&WiresharkUsersGuidePage;">Wireshark User's Guide</ulink>
+ about Wireshark usage.
</para>
<para>
- By reading this book, you will learn how to develop Ethereal. It will
+ By reading this book, you will learn how to develop Wireshark. It will
hopefully guide you around some common problems that frequently appears for
- new (and sometimes even advanced) developers of Ethereal.
+ new (and sometimes even advanced) developers of Wireshark.
</para>
</section>
<section id="PreAck">
<title>Acknowledgements</title>
<para>
- The authors would like to thank the whole Ethereal team for their
+ The authors would like to thank the whole Wireshark team for their
assistance. In particular, the authors would like to thank:
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
And of course a big thank you to the many, many contributors of the
- Ethereal development community!
+ Wireshark development community!
</para>
</section>
</note>
<tip><title>This is a tip!</title>
<para>
- Tips will be helpful for your everyday work developing Ethereal.
+ Tips will be helpful for your everyday work developing Wireshark.
</para>
</tip>
</section>
<title>Where to get the latest copy of this document?</title>
<para>
The latest copy of this documentation can always be found at:
- <ulink url="&EtherealDevsGuidePage;">&EtherealDevsGuidePage;</ulink>
+ <ulink url="&WiresharkDevsGuidePage;">&WiresharkDevsGuidePage;</ulink>
in PDF (A4 and US letter), HTML (single and chunked) and CHM format.
</para>
</section>
<title>Providing feedback about this document</title>
<para>
Should you have any feedback about this document, please send it
- to the authors through <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>.
+ to the authors through <ulink url="mailto:&WiresharkDevMailList;">&WiresharkDevMailList;</ulink>.
</para>
</section>
</preface>
-<!-- EDG Chapter User Interface -->
+<!-- WSDG Chapter User Interface -->
<!-- $Id$ -->
<chapter id="ChapterUserInterface">
<section id="ChUIIntro">
<title>Introduction</title>
<para>
- Ethereal can be "logically" seperated into the backend (dissecting of
+ Wireshark can be "logically" seperated into the backend (dissecting of
protocols, file load/save, capturing, ...) and the frontend (the user
interface). However, there's currently no clear seperation between
these two parts (no clear API definition), but this might change in the
future.
</para>
<para>
- The following frontends are currently maintained by the Ethereal
+ The following frontends are currently maintained by the Wireshark
development team:
<itemizedlist>
<listitem><para>
- Ethereal, GTK1.x based
+ Wireshark, GTK 1.x based
</para></listitem>
<listitem><para>
- Ethereal, GTK 2.x based
+ Wireshark, GTK 2.x based
</para></listitem>
<listitem><para>
TShark, console based
</para></listitem>
</itemizedlist>
- There are other Ethereal frontends existing, not developped nor
+ There are other Wireshark frontends existing, not developped nor
maintained by the Wireshark development team:
<itemizedlist>
<listitem><para>
details. GTK is designed to hide the details of the underlying GUI in
a platform independant way. As this is appreciated for a
multiplatform tool, this has some drawbacks, as it will result in a
- somewhat "non native" look and feel. For example: on win32, the "File
- open" dialog of Ethereal looks very different compared to the native
- win32 dialog the win32 users are used to see.
+ somewhat "non native" look and feel. For example: on Win32, the "File
+ open" dialog of Wireshark looks very different compared to the native
+ Win32 dialog the Win32 users are used to see.
</para>
<para>
GTK is available for a lot of different platforms including, but not
- limitted, to: unix/linux, mac os x and win32. It's the foundation of
+ limited, to: Unix/Linux, Mac OS X and Win32. It's the foundation of
the famous GNOME desktop, so the future development of GTK should be
certain.
- GTK is implemented in plain C (as Ethereal itself), and available under
+ GTK is implemented in plain C (as Wireshark itself), and available under
the LGPL (Lesser General Public License), being free to used by
commercial and noncommercial applications.
</para>
(typical for Win32 like systems).
</para>
<para>
- XXX: include Ethereal GTK1 screenshot
+ XXX: include Wireshark GTK1 screenshot
</para>
</section>
on X11, Windows, and the Linux framebuffer device.)
</para></listitem>
</itemizedlist>
- XXX: include Ethereal GTK2 screenshot
+ XXX: include Wireshark GTK2 screenshot
</para>
</section>
<para>
Theres no Win32 specific GTK mailing list. If you want to post
a Win32 specific problem (e.g. a problem in the GtkFileChooser dialog)
- and you are sure that it's really win32 specific, you
+ and you are sure that it's really Win32 specific, you
could send it to GIMPwin-users at <ulink
url="http://www.gimp.org/mail_lists.html"/>.
</para>
<title>GUI Reference documents</title>
<para>
Although the GUI development of Wireshark is platform independant, the
- Ethereal development team tries to
+ Wireshark development team tries to
follow the GNOME Human Interface Guidelines (HIG) where appropriate.
- This is the case, because both GNOME and Ethereal are based on the GTK+
+ This is the case, because both GNOME and Wireshark are based on the GTK+
toolkit and the GNOME HIG is excellently written and easy to understand.
</para>
<para>
<ulink url="http://developer.kde.org/documentation/library/ui.html"/>
</para></listitem>
<listitem><para>
- Win32 XXX - where are good win32 styleguides available?
+ Win32 XXX - where are good Win32 styleguides available?
</para></listitem>
</itemizedlist>
</para>
</section>
</chapter>
-<!-- End of EDG Chapter User Interface -->
+<!-- End of WSDG Chapter User Interface -->
-<!-- EDG Chapter Works -->
+<!-- WSDG Chapter Works -->
<!-- $Id$ -->
<chapter id="ChapterWorks">
- <title>How Ethereal Works</title>
+ <title>How Wireshark Works</title>
<section id="ChWorksIntro">
<title>Introduction</title>
<section id="ChWorksOverview">
<title>Overview</title>
<para>
- The following will give you a simplified overview of Ethereals function blocks:
+ The following will give you a simplified overview of Wiresharks function blocks:
<figure id="ChWorksFigOverview">
<title>
- <application>Ethereal</application> function blocks.
+ <application>Wireshark</application> function blocks.
</title>
- <graphic entityref="EtherealFunctionBlocks" format="PNG"/>
+ <graphic entityref="WiresharkFunctionBlocks" format="PNG"/>
</figure>
</para>
<para>
<varlistentry><term><command>Epan</command></term>
<listitem>
<para>
- Ethereal Package ANalyzing (XXX - is this correct?) the packet
+ Ethereal Packet ANalyzer (XXX - is this correct?) the packet
analyzing engine, source code can be found in the
<filename>epan</filename> directory.
</para>
</para>
<para>
To hide all the lowlevel machine dependant details from
- Ethereal, the libpcap/WinPcap (see <xref linkend="ChLibsPcap"/>) library
+ Wireshark, the libpcap/WinPcap (see <xref linkend="ChLibsPcap"/>) library
is used. This library provides a general purpose interface to capture
packets from a lot of different network interface types (Ethernet,
Token Ring, ...).
<section id="ChWorksCaptureFiles">
<title>Capture Files</title>
<para>
- Ethereal can read and write capture files in it's natural file format, the
+ Wireshark can read and write capture files in it's natural file format, the
libpcap format, which is used by many other network capturing tools,
e.g. tcpdump. In addition to this, as one of it's strengths,
- Ethereal can read/write files in many different file formats of other
+ Wireshark can read/write files in many different file formats of other
network capturing tools. The wiretap library, developed together with
- Ethereal, provides a general purpose interface to read/write all the file
+ Wireshark, provides a general purpose interface to read/write all the file
formats. If you need to add another capture file format, this is the place
to start.
</para>
<title>Dissect packets</title>
<para>
While Wireshark is loading packets from a file, each packet is dissected.
- Ethereal tries to detect what kind of packet it is and getting as much
+ Wireshark tries to detect what kind of packet it is and getting as much
information from it as possible. In this run, only the information showed
in the packet list pane is needed though.
</para>
<para>
As the user selects a specific packet in the packet list pane, this packet
- will be dissected again. This time, Ethereal tries to
+ will be dissected again. This time, Wireshark tries to
get every single piece of information and put it into
the packet details pane then.
</para>
</section>
</chapter>
-<!-- End of EDG Chapter Works -->
+<!-- End of WSDG Chapter Works -->
git.samba.org / obnox / wireshark / wip.git / commitdiff
