From Harald Welte:
[obnox/wireshark/wip.git] / docbook / developer-guide.xml
index 1c8c1366a873568674c114971958038bd749c1f9..ca229360d5e7fc59d39097e95051cb3e0af22e98 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 
 <!-- $Id$ -->
@@ -27,55 +27,69 @@ DOCUMENT SECTION
 -Use this section to encode all document information
 -->
 
-  <!ENTITY DocumentTitle "<application>Ethereal</application> Developer's Guide">
-  <!ENTITY DocumentSubTitle "&DocumentVersion; for Ethereal &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">
+  <!ENTITY DocumentCopyrightYear "2004-2010">
 
   <!ENTITY DocumentEdition "Draft">
-  <!ENTITY DocumentVersion "Draft 0.01">
-  <!ENTITY DocumentPubDate "2004">
+  <!ENTITY DocumentVersion "Draft 0.0.3">
+  <!ENTITY DocumentPubDate "2008">
+  <!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>">
 
-  <!ENTITY EtherealWebSite "http://www.ethereal.com">
-  <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
-  <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
-  <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
-  <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
-  <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
-  <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
+<!--
+Wireshark Info
+-->
+  <!ENTITY WiresharkCurrentVersion "1.7">
+  <!ENTITY WiresharkWebSite "http://www.wireshark.org">
+  <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
+  <!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 "https://bugs.wireshark.org">
+  <!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org">
 
 <!--
-Ethereal Info
+Gnu info
 -->
-  <!ENTITY EtherealCurrentVersion "0.10.6">
-  <!ENTITY EtherealNextMinorVersion "0.10.7">
+  <!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 "dg-src/EDG_meta_info.xml">
-  <!ENTITY Preface SYSTEM "dg-src/EDG_preface.xml">
-  <!ENTITY EnvIntroduction SYSTEM "dg-src/EDG_chapter_env_intro.xml">
-  <!ENTITY Tools SYSTEM "dg-src/EDG_chapter_tools.xml">
-  <!ENTITY Libraries SYSTEM "dg-src/EDG_chapter_libraries.xml">
-  <!ENTITY Sources SYSTEM "dg-src/EDG_chapter_sources.xml">
-  
-  <!ENTITY BuildIntroduction SYSTEM "dg-src/EDG_chapter_build_intro.xml">
-  <!ENTITY Dissection SYSTEM "dg-src/EDG_chapter_dissection.xml">
-  <!ENTITY UserInterface SYSTEM "dg-src/EDG_chapter_userinterface.xml">
-
-  <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">
 
-<!-- These refer to graphics files and figures contained in the document -->
-  <!-- 1st Chapter -->
+  <!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">
+
 ]>
 
 <book>
@@ -84,33 +98,54 @@ FILE SECTION
 &BookMetaInformation;
 &Preface;
 <part id="PartEnvironment" label="I">
-<title>Ethereal Build Environment</title>
+<title>Wireshark Build Environment</title>
 <partintro>
 <para>
-The first part of this book will describe how to set up the environment needed
-to develop Ethereal.
+<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;
-&Sources;
 </part>
 <part id="PartDevelopment" label="II">
-<title>Ethereal Development</title>
+<title>Wireshark Development (incomplete)</title>
 <partintro>
 <para>
-The second part of this book will describe how to do the actual Ethereal development.
+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>