Further cleanup of Wireshark User Guide
[obnox/wireshark/wip.git] / docbook / user-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 <!-- Author's Names -->
13   <!ENTITY AuthorFullName "Ulf Lamping">
14   <!ENTITY AuthorFirstName "Ulf">
15   <!ENTITY AuthorOtherName "">
16   <!ENTITY AuthorSurname "Lamping">
17
18   <!ENTITY AuthorFullName2 "Richard Sharpe">
19   <!ENTITY AuthorFirstName2 "Richard">
20   <!ENTITY AuthorOtherName2 "">
21   <!ENTITY AuthorSurname2 "Sharpe">
22
23   <!ENTITY AuthorFullName3 "Ed Warnicke">
24   <!ENTITY AuthorFirstName3 "Ed">
25   <!ENTITY AuthorOtherName3 "">
26   <!ENTITY AuthorSurname3 "Warnicke">
27
28 <!--Author's Affiliation -->
29   <!ENTITY AuthorShortAffiliation "">
30   <!ENTITY AuthorJobTitle "">
31   <!ENTITY AuthorOrgName "">
32   <!ENTITY AuthorOrgDiv "">
33   <!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
34
35   <!ENTITY AuthorShortAffiliation2 "">
36   <!ENTITY AuthorJobTitle2 "Director">
37   <!ENTITY AuthorOrgName2 "NS Computer Software and Services P/L">
38   <!ENTITY AuthorOrgDiv2 "">
39   <!ENTITY AuthorEmail2 "rsharpe[AT]ns.aus.com">
40
41   <!ENTITY AuthorShortAffiliation3 "">
42   <!ENTITY AuthorJobTitle3 "">
43   <!ENTITY AuthorOrgName3 "">
44   <!ENTITY AuthorOrgDiv3 "">
45   <!ENTITY AuthorEmail3 "hagbard[AT]physics.rutgers.edu">
46
47
48
49   
50
51 <!--
52 DOCUMENT SECTION
53 -Use this section to encode all document information
54 -->
55
56   <!ENTITY DocumentTitle "<application>Wireshark</application> User's Guide">
57   <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
58   <!ENTITY DocumentTitleAbbreviation "WSUG">
59
60   <!ENTITY DocumentCopyrightHolder1 "Ulf Lamping ">
61   <!ENTITY DocumentCopyrightHolder2 "Richard Sharpe ">
62   <!ENTITY DocumentCopyrightHolder3 "Ed Warnicke ">
63   <!ENTITY DocumentCopyrightYear "2004-2006">
64
65   <!ENTITY DocumentEdition "Third ">
66   <!ENTITY DocumentVersion "V3.0.2">
67   <!ENTITY DocumentPubDate "2006">
68
69   <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
70   %SvnVersionFile;
71 <!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>">
72
73 <!--
74 Wireshark Info
75 -->
76   <!ENTITY WiresharkCurrentVersion "0.99.0">
77   <!ENTITY WiresharkWebSite "http://www.wireshark.org">
78   <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/#usersguide">
79   <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download.html">
80   <!ENTITY WiresharkBinariesPage "&WiresharkWebSite;/download.html#releases">
81   <!ENTITY WiresharkAuthorsPage "&WiresharkWebSite;/introduction.html#authors">
82   <!ENTITY WiresharkProtocolsPage "&WiresharkWebSite;/docs/dfref/">
83   <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
84   <!ENTITY WiresharkFAQPromiscPage "&WiresharkWebSite;/faq#promiscsniff">
85   <!ENTITY WiresharkMediaPage "&WiresharkWebSite;/media.html">
86   <!ENTITY WiresharkWikiPage "http://wiki.wireshark.org">
87   <!ENTITY WiresharkWikiCaptureFiltersPage "&WiresharkWikiPage;/CaptureFilters">
88   <!ENTITY WiresharkWikiDisplayFiltersPage "&WiresharkWikiPage;/DisplayFilters">
89   <!ENTITY WiresharkWikiPreferencesPage "&WiresharkWikiPage;/Preferences">
90   <!ENTITY WiresharkWikiColoringRulesPage "&WiresharkWikiPage;/ColoringRules">
91   <!ENTITY WiresharkWikiPreferencesPage "&WiresharkWikiPage;/Preferences">
92
93   <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
94   <!ENTITY WiresharkUsersMailList "wireshark-users[AT]wireshark.org">
95
96   
97 <!--
98 Winpcap Info
99 -->
100   <!ENTITY WinPcapWebsite "http://www.winpcap.org">
101   <!ENTITY WinPcapDownloadWebsite "&WinPcapWebsite;/install/default.htm">
102
103 <!--
104 Tcpdump Info
105 -->
106   <!ENTITY TcpdumpWebsite "http://www.tcpdump.org">
107   <!ENTITY TcpdumpManpage "&TcpdumpWebsite;/tcpdump_man.html">
108
109 <!--
110 Gnu info
111 -->
112   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
113
114 <!--
115 Timezone info
116 -->
117   <!ENTITY TimezoneGMTSite "http://wwp.greenwichmeantime.com/">
118   <!ENTITY TimezoneWorldClockSite "http://www.timeanddate.com/worldclock/">
119   <!ENTITY NTPSite "http://www.ntp.org/">
120   <!ENTITY WikipediaWebsite "http://en.wikipedia.org">
121   <!ENTITY WikipediaTimezone "&WikipediaWebsite;/wiki/Time_zone">
122   <!ENTITY WikipediaDaylightSaving "&WikipediaWebsite;/wiki/Daylight_saving">
123   <!ENTITY WikipediaUTC "&WikipediaWebsite;/wiki/Coordinated_Universal_Time">
124
125 <!--
126 FILE SECTION
127 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
128 -->
129 <!-- These refer to graphics files and figures contained in the document -->
130   <!-- -->
131   <!ENTITY WiresharkLogo SYSTEM "./graphics/wireshark-logo.png" NDATA PNG>
132   
133   <!-- 1st Chapter -->
134   <!ENTITY WiresharkMain1 SYSTEM "./graphics/wireshark-main.png" NDATA PNG>
135
136   <!-- 2nd Chapter -->
137
138   <!-- Third Chapter -->
139   <!ENTITY WiresharkEmpty SYSTEM "./graphics/ethereal-empty.png" NDATA PNG>
140   <!ENTITY WiresharkThreePane1 SYSTEM "./graphics/wireshark-main.png" NDATA PNG>
141   <!ENTITY WiresharkMenuOnly SYSTEM "./graphics/ethereal-menu.png" NDATA PNG>
142   <!ENTITY WiresharkMainToolbar SYSTEM "./graphics/ethereal-main-toolbar.png" NDATA PNG>
143   <!ENTITY WiresharkFilterToolbar SYSTEM "./graphics/ethereal-filter-toolbar.png" NDATA PNG>
144   <!ENTITY WiresharkListPane SYSTEM "./graphics/ethereal-list-pane.png" NDATA PNG>
145   <!ENTITY WiresharkDetailsPane SYSTEM "./graphics/ethereal-details-pane.png" NDATA PNG>
146   <!ENTITY WiresharkBytesPane SYSTEM "./graphics/ethereal-bytes-pane.png" NDATA PNG>
147   <!ENTITY WiresharkBytesPaneTabs SYSTEM "./graphics/ethereal-bytes-pane-tabs.png" NDATA PNG>
148   <!ENTITY WiresharkStatusbarEmpty SYSTEM "./graphics/ethereal-statusbar-empty.png" NDATA PNG>
149   <!ENTITY WiresharkStatusbarLoaded SYSTEM "./graphics/ethereal-statusbar-loaded.png" NDATA PNG>
150   <!ENTITY WiresharkStatusbarSelected SYSTEM "./graphics/ethereal-statusbar-selected.png" NDATA PNG>
151   <!ENTITY WiresharkSaveAs SYSTEM "./graphics/ethereal-save-as.png" NDATA PNG>
152   <!ENTITY WiresharkOpen SYSTEM "./graphics/ethereal-open.png" NDATA PNG> 
153   <!ENTITY WiresharkPacketSelected1 SYSTEM "./graphics/ethereal-packet-selected.png" NDATA PNG>
154   <!ENTITY WiresharkPacketSepView SYSTEM "./graphics/ethereal-packet-sep-win.png" NDATA PNG>
155   <!ENTITY WiresharkFilterTCP SYSTEM "./graphics/ethereal-display-filter-tcp.png" NDATA PNG>  
156   <!ENTITY WiresharkColoringRulesDialog SYSTEM "./graphics/ethereal-coloring-rules-dialog.png" NDATA PNG>
157   <!ENTITY WiresharkEditColorDialog SYSTEM "./graphics/ethereal-edit-color-rule-dialog.png" NDATA PNG>
158   <!ENTITY WiresharkChooseColorDialog SYSTEM "./graphics/ethereal-choose-color-rule.png" NDATA PNG>
159   <!ENTITY WiresharkFollowStream SYSTEM "./graphics/ethereal-follow-stream.png" NDATA PNG>
160   <!ENTITY WiresharkFindPacket SYSTEM "./graphics/ethereal-find-packet.png" NDATA PNG>  
161   <!ENTITY WiresharkGoToPacket SYSTEM "./graphics/ethereal-goto-packet.png" NDATA PNG>  
162   <!ENTITY WiresharkPrint SYSTEM "./graphics/ethereal-print.png" NDATA PNG>
163   <!ENTITY WiresharkGUIPreferences SYSTEM "./graphics/ethereal-gui-preferences.png" NDATA PNG>
164   <!ENTITY WiresharkGUILayoutPreferences SYSTEM "./graphics/ethereal-gui-layout-preferences.png" NDATA PNG>
165   <!ENTITY WiresharkGUIColumnsPreferences SYSTEM "./graphics/ethereal-gui-columns-preferences.png" NDATA PNG>
166   <!ENTITY WiresharkGUIFontPreferences SYSTEM "./graphics/ethereal-gui-font-preferences.png" NDATA PNG>
167   <!ENTITY WiresharkGUIColorsPreferences SYSTEM "./graphics/ethereal-gui-colors-preferences.png" NDATA PNG>
168   <!ENTITY WiresharkCapturePreferences SYSTEM "./graphics/ethereal-capture-preferences.png" NDATA PNG>
169   <!ENTITY WiresharkPrintingPreferences SYSTEM "./graphics/ethereal-printing-preferences.png" NDATA PNG>
170   <!ENTITY WiresharkNameResolutionPreferences SYSTEM "./graphics/ethereal-nameresolution-preferences.png" NDATA PNG>
171   <!ENTITY WiresharkFilters SYSTEM "./graphics/ethereal-filters.png" NDATA PNG>
172   <!ENTITY WiresharkFileMenu SYSTEM "./graphics/ethereal-file-menu.png" NDATA PNG>
173   <!ENTITY WiresharkEditMenu SYSTEM "./graphics/ethereal-edit-menu.png" NDATA PNG>
174   <!ENTITY WiresharkViewMenu SYSTEM "./graphics/ethereal-view-menu.png" NDATA PNG>
175   <!ENTITY WiresharkGoMenu SYSTEM "./graphics/ethereal-go-menu.png" NDATA PNG>
176   <!ENTITY WiresharkCaptureMenu SYSTEM "./graphics/ethereal-capture-menu.png" NDATA PNG>
177   <!ENTITY WiresharkAnalyzeMenu SYSTEM "./graphics/ethereal-analyze-menu.png" NDATA PNG>
178   <!ENTITY WiresharkStatisticsMenu SYSTEM "./graphics/ethereal-statistics-menu.png" NDATA PNG>
179   <!ENTITY WiresharkHelpMenu SYSTEM "./graphics/ethereal-help-menu.png" NDATA PNG>
180   <!ENTITY WiresharkPacketPanePopupMenu SYSTEM "./graphics/ethereal-packet-pane-popup-menu.png" NDATA PNG>
181   <!ENTITY WiresharkDetailsPanePopupMenu SYSTEM "./graphics/ethereal-details-pane-popup-menu.png" NDATA PNG>
182   <!ENTITY WiresharkBytesPanePopupMenu SYSTEM "./graphics/ethereal-bytes-pane-popup-menu.png" NDATA PNG>
183   <!ENTITY WiresharkFilterAddExpression SYSTEM "./graphics/ethereal-filter-add-expression.png" NDATA PNG>
184   <!ENTITY WiresharkFilters2 SYSTEM "./graphics/ethereal-filters-2.png" NDATA PNG>
185   <!ENTITY WiresharkExportPlainDialog SYSTEM "./graphics/ethereal-export-plain.png" NDATA PNG>
186   <!ENTITY WiresharkExportPSDialog SYSTEM "./graphics/ethereal-export-ps.png" NDATA PNG>
187   <!ENTITY WiresharkExportPSMLDialog SYSTEM "./graphics/ethereal-export-psml.png" NDATA PNG>
188   <!ENTITY WiresharkExportPDMLDialog SYSTEM "./graphics/ethereal-export-pdml.png" NDATA PNG>
189   <!ENTITY WiresharkExportSelectedDialog SYSTEM "./graphics/ethereal-export-selected.png" NDATA PNG>
190   <!ENTITY WiresharkCaptureInterfacesDialog SYSTEM "./graphics/ethereal-capture-interfaces.png" NDATA PNG>
191   <!ENTITY WiresharkCaptureOptionsDialog SYSTEM "./graphics/ethereal-capture-options.png" NDATA PNG>
192   <!ENTITY WiresharkCaptureInfoDialog SYSTEM "./graphics/ethereal-capture-info.png" NDATA PNG>
193   <!ENTITY WiresharkMergeDialog SYSTEM "./graphics/ethereal-merge.png" NDATA PNG>
194   <!ENTITY WiresharkPacketRangeFrame SYSTEM "./graphics/ethereal-packet-range.png" NDATA PNG>
195   <!ENTITY WiresharkPacketFormatFrame SYSTEM "./graphics/ethereal-packet-format.png" NDATA PNG>
196   <!ENTITY WiresharkTimeReference SYSTEM "./graphics/ethereal-time-reference.png" NDATA PNG>
197   <!ENTITY WiresharkEnabledProtocols SYSTEM "./graphics/ethereal-enabled-protocols.png" NDATA PNG>
198   <!ENTITY WiresharkDecodeAs SYSTEM "./graphics/ethereal-decode-as.png" NDATA PNG>
199   <!ENTITY WiresharkDecodeAsShow SYSTEM "./graphics/ethereal-decode-as-show.png" NDATA PNG>
200   <!ENTITY WiresharkFileSetDialog SYSTEM "./graphics/ethereal-file-set-dialog.png" NDATA PNG>
201
202   <!-- Third Chapter Toolbar-->
203   <!ENTITY WiresharkToolbarCaptureInterfaces SYSTEM "./graphics/toolbar/capture_interfaces_24.png" NDATA PNG>
204   <!ENTITY WiresharkToolbarCaptureOptions SYSTEM "./graphics/toolbar/capture_options_24.png" NDATA PNG>
205   <!ENTITY WiresharkToolbarCaptureStart SYSTEM "./graphics/toolbar/capture_start_24.png" NDATA PNG>
206   <!ENTITY WiresharkToolbarCaptureStop SYSTEM "./graphics/toolbar/capture_stop_24.png" NDATA PNG>
207   <!ENTITY WiresharkToolbarCaptureRestart SYSTEM "./graphics/toolbar/capture_restart_24.png" NDATA PNG>
208   <!ENTITY WiresharkToolbarCaptureFilters SYSTEM "./graphics/toolbar/capture_filter_24.png" NDATA PNG>
209   <!ENTITY WiresharkToolbarDisplayFilters SYSTEM "./graphics/toolbar/display_filter_24.png" NDATA PNG>
210   <!ENTITY WiresharkToolbarAdd SYSTEM "./graphics/toolbar/stock_add_24.png" NDATA PNG>
211   <!ENTITY WiresharkToolbarGoLast SYSTEM "./graphics/toolbar/stock_bottom_24.png" NDATA PNG>
212   <!ENTITY WiresharkToolbarClose SYSTEM "./graphics/toolbar/stock_close_24.png" NDATA PNG>
213   <!ENTITY WiresharkToolbarColoringRules SYSTEM "./graphics/toolbar/stock_colorselector_24.png" NDATA PNG>
214   <!ENTITY WiresharkToolbarHelp SYSTEM "./graphics/toolbar/stock_help_24.png" NDATA PNG>
215   <!ENTITY WiresharkToolbarGoTo SYSTEM "./graphics/toolbar/stock_jump_to_24.png" NDATA PNG>
216   <!ENTITY WiresharkToolbarGoBack SYSTEM "./graphics/toolbar/stock_left_arrow_24.png" NDATA PNG>
217   <!ENTITY WiresharkToolbarOpen SYSTEM "./graphics/toolbar/stock_open_24.png" NDATA PNG>
218   <!ENTITY WiresharkToolbarPreferences SYSTEM "./graphics/toolbar/stock_preferences_24.png" NDATA PNG>
219   <!ENTITY WiresharkToolbarPrint SYSTEM "./graphics/toolbar/stock_print_24.png" NDATA PNG>
220   <!ENTITY WiresharkToolbarProperties SYSTEM "./graphics/toolbar/stock_properties_24.png" NDATA PNG>
221   <!ENTITY WiresharkToolbarReload SYSTEM "./graphics/toolbar/stock_refresh_24.png" NDATA PNG>
222   <!ENTITY WiresharkToolbarGoForward SYSTEM "./graphics/toolbar/stock_right_arrow_24.png" NDATA PNG>
223   <!ENTITY WiresharkToolbarSave SYSTEM "./graphics/toolbar/stock_save_24.png" NDATA PNG>
224   <!ENTITY WiresharkToolbarSaveAs SYSTEM "./graphics/toolbar/stock_save_as_24.png" NDATA PNG>
225   <!ENTITY WiresharkToolbarFind SYSTEM "./graphics/toolbar/stock_search_24.png" NDATA PNG>
226   <!ENTITY WiresharkToolbarStop SYSTEM "./graphics/toolbar/stock_stop_24.png" NDATA PNG>
227   <!ENTITY WiresharkToolbarGoFirst SYSTEM "./graphics/toolbar/stock_top_24.png" NDATA PNG>
228   <!ENTITY WiresharkToolbarZoom100 SYSTEM "./graphics/toolbar/stock_zoom_1_24.png" NDATA PNG>
229   <!ENTITY WiresharkToolbarZoomIn SYSTEM "./graphics/toolbar/stock_zoom_in_24.png" NDATA PNG>
230   <!ENTITY WiresharkToolbarZoomOut SYSTEM "./graphics/toolbar/stock_zoom_out_24.png" NDATA PNG>
231   <!ENTITY WiresharkToolbarColorize SYSTEM "./graphics/toolbar/colorize_24.png" NDATA PNG>
232   <!ENTITY WiresharkToolbarAutoScroll SYSTEM "./graphics/toolbar/autoscroll_24.png" NDATA PNG>
233   <!ENTITY WiresharkToolbarResizeColumns SYSTEM "./graphics/toolbar/resize_columns_24.png" NDATA PNG>
234
235   <!-- Third Chapter Statistics -->
236   <!ENTITY WiresharkStatsSummary SYSTEM "./graphics/ethereal-stats-summary.png" NDATA PNG>
237   <!ENTITY WiresharkStatsHierarchy SYSTEM "./graphics/ethereal-stats-hierarchy.png" NDATA PNG>
238   <!ENTITY WiresharkStatsEndpoints SYSTEM "./graphics/ethereal-stats-endpoints.png" NDATA PNG>
239   <!ENTITY WiresharkStatsConversations SYSTEM "./graphics/ethereal-stats-conversations.png" NDATA PNG>
240   <!ENTITY WiresharkStatsIOGraphs SYSTEM "./graphics/ethereal-stats-iographs.png" NDATA PNG>
241   <!ENTITY WiresharkStatsSrtDcerpcFilter SYSTEM "./graphics/ethereal-stats-srt-dcerpc-filter.png" NDATA PNG>
242   <!ENTITY WiresharkStatsSrtDcerpc SYSTEM "./graphics/ethereal-stats-srt-dcerpc.png" NDATA PNG>
243
244   <!-- Fifth Chapter -->
245
246   <!-- Sixth Chapter -->
247
248   <!-- Appendices etc -->
249   <!ENTITY WiresharkFormatError SYSTEM "./graphics/ethereal-error-open.png" NDATA PNG>
250   <!ENTITY WiresharkFormatError SYSTEM "./graphics/ethereal-error-open.png" NDATA PNG>
251   <!ENTITY WiresharkSaveError SYSTEM "./graphics/ethereal-save-error.png" NDATA PNG>
252
253
254 <!-- These are the actual files that make up the document -->
255   <!ENTITY BookMetaInformation SYSTEM "wsug_src/WSUG_meta_info.xml">
256   <!ENTITY Preface SYSTEM  "wsug_src/WSUG_preface.xml">
257   <!ENTITY ChapterIntroduction SYSTEM "wsug_src/WSUG_chapter_introduction.xml">
258   <!ENTITY ChapterBuildInstall SYSTEM "wsug_src/WSUG_chapter_build_install.xml">
259   <!ENTITY ChapterUse SYSTEM "wsug_src/WSUG_chapter_use.xml">
260   <!ENTITY ChapterCapture SYSTEM "wsug_src/WSUG_chapter_capture.xml">
261   <!ENTITY ChapterIo SYSTEM "wsug_src/WSUG_chapter_io.xml">
262   <!ENTITY ChapterWork SYSTEM "wsug_src/WSUG_chapter_work.xml">
263   <!ENTITY ChapterAdvanced SYSTEM "wsug_src/WSUG_chapter_advanced.xml">
264   <!ENTITY ChapterStatistics SYSTEM "wsug_src/WSUG_chapter_statistics.xml">
265   <!ENTITY ChapterCustomize SYSTEM "wsug_src/WSUG_chapter_customize.xml">
266   <!ENTITY ChapterTroubleshoot SYSTEM "wsug_src/WSUG_chapter_troubleshoot.xml">
267   <!ENTITY AppMessages SYSTEM "wsug_src/WSUG_app_messages.xml">
268   <!ENTITY AppFiles SYSTEM "wsug_src/WSUG_app_files.xml">
269   <!ENTITY AppProtocols SYSTEM   "wsug_src/WSUG_app_protocols.xml">
270   <!ENTITY AppHowItWorks SYSTEM "wsug_src/WSUG_app_howitworks.xml">
271   <!ENTITY AppTools SYSTEM "wsug_src/WSUG_app_tools.xml">
272   <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">
273
274 ]>
275
276 <book>
277   <title>&DocumentTitle;</title>
278   <subtitle>&DocumentSubTitle;</subtitle>
279   <!--
280   -->
281   &BookMetaInformation;
282   &Preface;
283   &ChapterIntroduction;
284   &ChapterBuildInstall;
285   &ChapterUse;
286   &ChapterCapture;
287   &ChapterIo;
288   &ChapterWork;
289   &ChapterAdvanced;
290   &ChapterStatistics;  
291   &ChapterCustomize;
292
293   &AppFiles;
294   &AppProtocols;
295   &AppMessages;  
296   &AppTools;
297   <!--
298   -->
299   
300   &AppGPL;
301   <!-- 
302   Removed, as these chapters must be reworked
303   &Glossary;
304   &Index;
305   Removed, as this chapter is not finished 
306   &AppHowItWorks;
307   Removed, as this chapter has to be reworked
308   &ChapterTroubleshoot;   
309   -->
310   
311 </book>