From Graham Bloice:
[obnox/wireshark/wip.git] / 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-2007">
36
37   <!ENTITY DocumentEdition "Draft">
38   <!ENTITY DocumentVersion "Draft 0.0.3">
39   <!ENTITY DocumentPubDate "2007">
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 "0.99.5">
49   <!ENTITY WiresharkWebSite "http://www.wireshark.org">
50   <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
51   <!ENTITY WiresharkAuthorsPage "http://anonsvn.wireshark.org/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 "http://bugs.wireshark.org">
58
59 <!--
60 Gnu info
61 -->
62   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
63
64 <!--
65 FILE SECTION
66 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
67 -->
68
69 <!-- These refer to graphics files and figures contained in the document -->
70
71   <!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
72   <!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
73
74 <!-- These are the actual files that make up the document -->
75
76   <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
77   <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
78   <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
79   <!ENTITY QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.xml">
80   <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
81   <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
82   <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
83   
84   <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
85   <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
86   <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
87   <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
88   <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
89
90   <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">
91
92 <!-- These refer to graphics files and figures contained in the document -->
93   <!-- 1st Chapter -->
94 ]>
95
96 <book>
97 <title>&DocumentTitle;</title>
98 <subtitle>&DocumentSubTitle;</subtitle>
99 &BookMetaInformation;
100 &Preface;
101 <part id="PartEnvironment" label="I">
102 <title>Wireshark Build Environment</title>
103 <partintro>
104 <para>
105 <command>Part I. Wireshark Build Environment</command>
106 </para>
107 <para>
108 <command>The first part describes how to set up the tools, libraries and 
109 source needed to generate Wireshark, and how to do some typical development 
110 tasks.</command>
111 </para>
112 <para>
113 Part II. Wireshark Development
114 </para>
115 <para>
116 The second part describes how the Wireshark sources are structured and how 
117 to change the sources (e.g. adding a new dissector).
118 </para>
119 </partintro>
120 &EnvIntroduction;
121 &QuickSetup;
122 &Sources;
123 &Tools;
124 &Libraries;
125 </part>
126 <part id="PartDevelopment" label="II">
127 <title>Wireshark Development (incomplete)</title>
128 <partintro>
129 <!--<para>
130 This is the second of two parts:
131 </para>-->
132 <para>
133 Part I. Wireshark Build Environment
134 </para>
135 <para>
136 The first part describes how to set up the tools, libraries and source needed 
137 to generate Wireshark, and how to do some typical development tasks.
138 </para>
139 <para>
140 <command>Part II. Wireshark Development</command>
141 </para>
142 <para>
143 <command>The second part describes how the Wireshark sources are structured and how 
144 to change the sources (e.g. adding a new dissector).</command>
145 </para>
146 </partintro>
147 &HowWiresharkWorks;
148 &BuildIntroduction;
149 &Capture;
150 &Dissection;
151 &UserInterface;
152 </part>
153
154 &AppGPL;
155 <!--
156
157 &Glossary;
158 &Index;  -->
159 </book>