aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/developer-guide.xml
blob: 8005c8d4945891b1a6bc43bb6b585b558b64647b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?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-2012">

  <!ENTITY DocumentEdition "Draft">
  <!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>">

<!--
Wireshark Info
-->
  <!ENTITY WiresharkCurrentVersion "1.9">
  <!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">

<!--
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">

]>

<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>
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;
</book>