docbook/developer-guide.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.5/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-2013">
  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
  44   and/or modify this document under the terms of the GNU General Public
  45   License, Version 2 or any later version published by the Free Software
  46   Foundation.
  47   </para>
  48   <para>All logos and trademarks in this document are property of their
  49   respective owner.</para>">
  50
  51 <!--
  52 Wireshark Info
  53 -->
  54   <!ENTITY WiresharkCurrentVersion "1.11">
  55   <!ENTITY WiresharkWebSite "http://www.wireshark.org">
  56   <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
  57   <!ENTITY WiresharkAuthorsPage "&WiresharkRepositorySite;/wireshark/trunk/AUTHORS">
  58   <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
  59   <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
  60   <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/">
  61   <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/">
  62   <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
  63   <!ENTITY WiresharkBugsSite "https://bugs.wireshark.org">
  64   <!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org">
  65   <!ENTITY WiresharkListsPage "&WiresharkWebSite;/lists/">
  66   <!ENTITY WiresharkQASite "http://ask.wireshark.org">
  67
  68 <!--
  69 Gnu info
  70 -->
  71   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
  72
  73 <!--
  74 FILE SECTION
  75 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
  76 -->
  77
  78 <!-- These refer to graphics files and figures contained in the document -->
  79
  80   <!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
  81   <!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
  82
  83 <!-- These are the actual files that make up the document -->
  84
  85   <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
  86   <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
  87   <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
  88   <!ENTITY QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.xml">
  89   <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
  90   <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
  91   <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
  92
  93   <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
  94   <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
  95   <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
  96   <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
  97   <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
  98
  99   <!ENTITY AppGPL SYSTEM "GPL_appendix.xml">
 100
 101 ]>
 102
 103 <book>
 104 <title>&DocumentTitle;</title>
 105 <subtitle>&DocumentSubTitle;</subtitle>
 106 &BookMetaInformation;
 107 &Preface;
 108 <part id="PartEnvironment" label="I">
 109 <title>Wireshark Build Environment</title>
 110 <partintro>
 111 <para>
 112 <command>Part I. Wireshark Build Environment</command>
 113 </para>
 114 <para>
 115 <command>The first part describes how to set up the tools, libraries and
 116 source needed to generate Wireshark, and how to do some typical development
 117 tasks.</command>
 118 </para>
 119 <para>
 120 Part II. Wireshark Development
 121 </para>
 122 <para>
 123 The second part describes how the Wireshark sources are structured and how
 124 to change the sources (e.g. adding a new dissector).
 125 </para>
 126 </partintro>
 127 &EnvIntroduction;
 128 &QuickSetup;
 129 &Sources;
 130 &Tools;
 131 &Libraries;
 132 </part>
 133 <part id="PartDevelopment" label="II">
 134 <title>Wireshark Development (incomplete)</title>
 135 <partintro>
 136 <para>
 137 Part I. Wireshark Build Environment
 138 </para>
 139 <para>
 140 The first part describes how to set up the tools, libraries and source needed
 141 to generate Wireshark, and how to do some typical development tasks.
 142 </para>
 143 <para>
 144 <command>Part II. Wireshark Development</command>
 145 </para>
 146 <para>
 147 <command>The second part describes how the Wireshark sources are structured and how
 148 to change the sources (e.g. adding a new dissector).</command>
 149 </para>
 150 </partintro>
 151 &HowWiresharkWorks;
 152 &BuildIntroduction;
 153 &Capture;
 154 &Dissection;
 155 &UserInterface;
 156 </part>
 157
 158 &AppGPL;
 159 </book>