aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/developer-guide.xml
blob: 17c9499bb96cbcd963d1a2582ab57165d9c593c3 (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
152
153
154
155
156
157
<?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>Ethereal</application> Developer's Guide">
  <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &EtherealCurrentVersion;">
  <!ENTITY DocumentTitleAbbreviation "EDG">

  <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
  <!ENTITY DocumentCopyrightYear "2004-2005">

  <!ENTITY DocumentEdition "Draft">
  <!ENTITY DocumentVersion "Draft 0.0.2">
  <!ENTITY DocumentPubDate "2005">
  <!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>">

<!--
Ethereal Info
-->
  <!ENTITY EtherealCurrentVersion "0.10.14">
  <!ENTITY EtherealWebSite "http://www.wireshark.org">
  <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
  <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
  <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
  <!ENTITY EtherealDevMailList "wireshark-dev[AT]wireshark.org">
  <!ENTITY EtherealDevsGuidePage "&EtherealWebSite;/docs">
  <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs">
  <!ENTITY EtherealWikiSite "http://wiki.wireshark.org">
  <!ENTITY EtherealBugsSite "http://bugs.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 EtherealLogo SYSTEM "./edg_graphics/wireshark-logo.png" NDATA PNG>
  <!ENTITY EtherealFunctionBlocks SYSTEM "./edg_graphics/ethereal-function-blocks.png" NDATA PNG>

<!-- These are the actual files that make up the document -->

  <!ENTITY BookMetaInformation SYSTEM "edg_src/EDG_meta_info.xml">
  <!ENTITY Preface SYSTEM "edg_src/EDG_preface.xml">
  <!ENTITY EnvIntroduction SYSTEM "edg_src/EDG_chapter_env_intro.xml">
  <!ENTITY Tools SYSTEM "edg_src/EDG_chapter_tools.xml">
  <!ENTITY Libraries SYSTEM "edg_src/EDG_chapter_libraries.xml">
  <!ENTITY Sources SYSTEM "edg_src/EDG_chapter_sources.xml">
  
  <!ENTITY BuildIntroduction SYSTEM "edg_src/EDG_chapter_build_intro.xml">
  <!ENTITY HowEtherealWorks SYSTEM "edg_src/EDG_chapter_works.xml">
  <!ENTITY Capture SYSTEM "edg_src/EDG_chapter_capture.xml">
  <!ENTITY Dissection SYSTEM "edg_src/EDG_chapter_dissection.xml">
  <!ENTITY UserInterface SYSTEM "edg_src/EDG_chapter_userinterface.xml">

  <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">

<!-- These refer to graphics files and figures contained in the document -->
  <!-- 1st Chapter -->
]>

<book>
<title>&DocumentTitle;</title>
<subtitle>&DocumentSubTitle;</subtitle>
&BookMetaInformation;
&Preface;
<part id="PartEnvironment" label="I">
<title>Ethereal Build Environment</title>
<partintro>
<para>
<command>Part I. Ethereal Build Environment</command>
</para>
<para>
<command>The first part describes how to set up the tools, libraries and 
source needed to generate Ethereal, and how to do some typical development 
tasks.</command>
</para>
<para>
Part II. Ethereal 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;
&Tools;
&Libraries;
&Sources;
</part>
<part id="PartDevelopment" label="II">
<title>Ethereal Development (incomplete)</title>
<partintro>
<!--<para>
This is the second of two parts:
</para>-->
<para>
Part I. Ethereal Build Environment
</para>
<para>
The first part describes how to set up the tools, libraries and source needed 
to generate Ethereal, and how to do some typical development tasks.
</para>
<para>
<command>Part II. Ethereal 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>
&HowEtherealWorks;
&BuildIntroduction;
&Capture;
&Dissection;
&UserInterface;
</part>

&AppGPL;
<!--

&Glossary;
&Index;  -->
</book>