wireshark/docbook/developer-guide.xml

160 lines
5.0 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!-- $Id$ -->
<!--
BIOGRAPHICAL SECTION
-Use this section to encode all biographical information
-->
<!-- Authors Names -->
<!ENTITY AuthorFullName "Ulf Lamping">
<!ENTITY AuthorFirstName "Ulf">
<!ENTITY AuthorOtherName "">
<!ENTITY AuthorSurname "Lamping">
<!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
<!--Authors Affiliation -->
<!ENTITY AuthorShortAffiliation "">
<!ENTITY AuthorJobTitle "">
<!ENTITY AuthorOrgName "">
<!ENTITY AuthorOrgDiv "">
<!--
DOCUMENT SECTION
-Use this section to encode all document information
-->
<!ENTITY DocumentTitle "<application>Wireshark</application> Developer's Guide">
<!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
<!ENTITY DocumentTitleAbbreviation "WSDG">
<!ENTITY DocumentCopyrightHolder "Ulf Lamping">
<!ENTITY DocumentCopyrightYear "2004-2007">
<!ENTITY DocumentEdition "Draft">
<!ENTITY DocumentVersion "Draft 0.0.3">
<!ENTITY DocumentPubDate "2007">
<!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>">
<!--
Wireshark Info
-->
<!ENTITY WiresharkCurrentVersion "0.99.6">
<!ENTITY WiresharkWebSite "http://www.wireshark.org">
<!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
<!ENTITY WiresharkAuthorsPage "http://anonsvn.wireshark.org/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">
<!--
Gnu info
-->
<!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
<!--
FILE SECTION
-Use this section to specify the files that make up the book. Use FPI (public identifiers)
-->
<!-- These refer to graphics files and figures contained in the document -->
<!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
<!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
<!-- These are the actual files that make up the document -->
<!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 QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.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 "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">
<!-- These refer to graphics files and figures contained in the document -->
<!-- 1st Chapter -->
]>
<book>
<title>&DocumentTitle;</title>
<subtitle>&DocumentSubTitle;</subtitle>
&BookMetaInformation;
&Preface;
<part id="PartEnvironment" label="I">
<title>Wireshark Build Environment</title>
<partintro>
<para>
<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 Wireshark, and how to do some typical development
tasks.</command>
</para>
<para>
Part II. Wireshark Development
</para>
<para>
The second part describes how the Wireshark sources are structured and how
to change the sources (e.g. adding a new dissector).
</para>
</partintro>
&EnvIntroduction;
&QuickSetup;
&Sources;
&Tools;
&Libraries;
</part>
<part id="PartDevelopment" label="II">
<title>Wireshark Development (incomplete)</title>
<partintro>
<!--<para>
This is the second of two parts:
</para>-->
<para>
Part I. Wireshark Build Environment
</para>
<para>
The first part describes how to set up the tools, libraries and source needed
to generate Wireshark, and how to do some typical development tasks.
</para>
<para>
<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>
&HowWiresharkWorks;
&BuildIntroduction;
&Capture;
&Dissection;
&UserInterface;
</part>
&AppGPL;
<!--
&Glossary;
&Index; -->
</book>