docbook/developer-guide.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8 BIOGRAPHICAL SECTION
   9 -Use this section to encode all biographical information
  10 -->
  11
  12 <!-- Authors Names -->
  13   <!ENTITY AuthorFullName "Ulf Lamping">
  14   <!ENTITY AuthorFirstName "Ulf">
  15   <!ENTITY AuthorOtherName "">
  16   <!ENTITY AuthorSurname "Lamping">
  17   <!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
  18
  19 <!--Authors Affiliation -->
  20   <!ENTITY AuthorShortAffiliation "">
  21   <!ENTITY AuthorJobTitle "">
  22   <!ENTITY AuthorOrgName "">
  23   <!ENTITY AuthorOrgDiv "">
  24
  25 <!--
  26 DOCUMENT SECTION
  27 -Use this section to encode all document information
  28 -->
  29
  30   <!ENTITY DocumentTitle "<application>Wireshark</application> Developer's Guide">
  31   <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
  32   <!ENTITY DocumentTitleAbbreviation "WSDG">
  33
  34   <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
  35   <!ENTITY DocumentCopyrightYear "2004-2010">
  36
  37   <!ENTITY DocumentEdition "Draft">
  38   <!ENTITY DocumentVersion "Draft 0.0.3">
  39   <!ENTITY DocumentPubDate "2008">
  40   <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
  41   %SvnVersionFile;
  42
  43 <!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>">
  44
  45 <!--
  46 Wireshark Info
  47 -->
  48   <!ENTITY WiresharkCurrentVersion "1.7">
  49   <!ENTITY WiresharkWebSite "http://www.wireshark.org">
  50   <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
  51   <!ENTITY WiresharkAuthorsPage "&WiresharkRepositorySite;/wireshark/trunk/AUTHORS">
  52   <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
  53   <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
  54   <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/">
  55   <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/">
  56   <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
  57   <!ENTITY WiresharkBugsSite "https://bugs.wireshark.org">
  58   <!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org">
  59
  60 <!--
  61 Gnu info
  62 -->
  63   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
  64
  65 <!--
  66 FILE SECTION
  67 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
  68 -->
  69
  70 <!-- These refer to graphics files and figures contained in the document -->
  71
  72   <!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
  73   <!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
  74
  75 <!-- These are the actual files that make up the document -->
  76
  77   <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
  78   <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
  79   <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
  80   <!ENTITY QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.xml">
  81   <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
  82   <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
  83   <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
  84
  85   <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
  86   <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
  87   <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
  88   <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
  89   <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
  90
  91   <!ENTITY AppGPL SYSTEM "GPL_appendix.xml">
  92
  93 ]>
  94
  95 <book>
  96 <title>&DocumentTitle;</title>
  97 <subtitle>&DocumentSubTitle;</subtitle>
  98 &BookMetaInformation;
  99 &Preface;
 100 <part id="PartEnvironment" label="I">
 101 <title>Wireshark Build Environment</title>
 102 <partintro>
 103 <para>
 104 <command>Part I. Wireshark Build Environment</command>
 105 </para>
 106 <para>
 107 <command>The first part describes how to set up the tools, libraries and
 108 source needed to generate Wireshark, and how to do some typical development
 109 tasks.</command>
 110 </para>
 111 <para>
 112 Part II. Wireshark Development
 113 </para>
 114 <para>
 115 The second part describes how the Wireshark sources are structured and how
 116 to change the sources (e.g. adding a new dissector).
 117 </para>
 118 </partintro>
 119 &EnvIntroduction;
 120 &QuickSetup;
 121 &Sources;
 122 &Tools;
 123 &Libraries;
 124 </part>
 125 <part id="PartDevelopment" label="II">
 126 <title>Wireshark Development (incomplete)</title>
 127 <partintro>
 128 <para>
 129 Part I. Wireshark Build Environment
 130 </para>
 131 <para>
 132 The first part describes how to set up the tools, libraries and source needed
 133 to generate Wireshark, and how to do some typical development tasks.
 134 </para>
 135 <para>
 136 <command>Part II. Wireshark Development</command>
 137 </para>
 138 <para>
 139 <command>The second part describes how the Wireshark sources are structured and how
 140 to change the sources (e.g. adding a new dissector).</command>
 141 </para>
 142 </partintro>
 143 &HowWiresharkWorks;
 144 &BuildIntroduction;
 145 &Capture;
 146 &Dissection;
 147 &UserInterface;
 148 </part>
 149
 150 &AppGPL;
 151 </book>