third part of Graeme Hewsons review comments
[metze/wireshark/wip.git] / docbook / user-guide.xml
1 <?xml version="1.0"?>\r
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" \r
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [\r
4 \r
5 <!--\r
6 BIOGRAPHICAL SECTION\r
7 -Use this section to encode all biographical information\r
8 -->\r
9 \r
10 <!-- Author's Names -->\r
11   <!ENTITY AuthorFullName "Richard Sharpe">\r
12   <!ENTITY AuthorFirstName "Richard">\r
13   <!ENTITY AuthorOtherName "">\r
14   <!ENTITY AuthorSurname "Sharpe">\r
15 \r
16   <!ENTITY AuthorFullName2 "Ed Warnicke">\r
17   <!ENTITY AuthorFirstName2 "Ed">\r
18   <!ENTITY AuthorOtherName2 "">\r
19   <!ENTITY AuthorSurname2 "Warnicke">\r
20 \r
21   <!ENTITY AuthorFullName3 "Ulf Lamping">\r
22   <!ENTITY AuthorFirstName3 "Ulf">\r
23   <!ENTITY AuthorOtherName3 "">\r
24   <!ENTITY AuthorSurname3 "Lamping">\r
25 \r
26 <!--Author's Affiliation -->\r
27   <!ENTITY AuthorShortAffiliation "">\r
28   <!ENTITY AuthorJobTitle "Director">\r
29   <!ENTITY AuthorOrgName "NS Computer Software and Services P/L">\r
30   <!ENTITY AuthorOrgDiv "">\r
31   <!ENTITY AuthorEmail "rsharpe[AT]ns.aus.com">\r
32 \r
33   <!ENTITY AuthorShortAffiliation2 "">\r
34   <!ENTITY AuthorJobTitle2 "">\r
35   <!ENTITY AuthorOrgName2 "">\r
36   <!ENTITY AuthorOrgDiv2 "">\r
37   <!ENTITY AuthorEmail2 "hagbard[AT]physics.rutgers.edu">\r
38 \r
39   <!ENTITY AuthorShortAffiliation3 "">\r
40   <!ENTITY AuthorJobTitle3 "">\r
41   <!ENTITY AuthorOrgName3 "">\r
42   <!ENTITY AuthorOrgDiv3 "">\r
43   <!ENTITY AuthorEmail3 "ulf.lamping[AT]web.de">\r
44 \r
45 \r
46   \r
47 \r
48 <!--\r
49 DOCUMENT SECTION\r
50 -Use this section to encode all document information\r
51 -->\r
52 \r
53   <!ENTITY DocumentTitle "<application>Ethereal</application> User's Guide">\r
54   <!ENTITY DocumentSubTitle "&DocumentVersion; for Ethereal &EtherealCurrentVersion;">\r
55   <!ENTITY DocumentTitleAbbreviation "EUG">\r
56 \r
57   <!ENTITY DocumentCopyrightHolder1 "Richard Sharpe">\r
58   <!ENTITY DocumentCopyrightHolder2 "Ed Warnicke">\r
59   <!ENTITY DocumentCopyrightHolder3 "Ulf Lamping">\r
60   <!ENTITY DocumentCopyrightYear "2004">\r
61 \r
62   <!ENTITY DocumentEdition "Third ">\r
63   <!ENTITY DocumentVersion "V1.93">\r
64   <!ENTITY DocumentPubDate "2004">\r
65 \r
66 <!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">\r
67 \r
68 <!--\r
69 Ethereal Info\r
70 -->\r
71   <!ENTITY EtherealCurrentVersion "0.10.5">\r
72   <!ENTITY EtherealNextMinorVersion "0.10.6">\r
73   <!ENTITY EtherealWebSite "http://www.ethereal.com">\r
74   <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">\r
75   <!ENTITY EtherealBinariesPage "&EtherealWebSite;/download.html#binaries">\r
76   <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">\r
77   <!ENTITY EtherealProtocolsPage "&EtherealWebSite;/docs/dfref/">\r
78   <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">\r
79   <!ENTITY EtherealFAQPromiscPage "&EtherealWebSite;/faq#promiscsniff">\r
80   <!ENTITY EtherealMediaPage "&EtherealWebSite;/media.html">\r
81   <!ENTITY EtherealCurrentVersionTarFile "0.10.5">\r
82 \r
83   <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">\r
84   <!ENTITY EtherealUsersMailList "ethereal-users[AT]ethereal.com">\r
85 \r
86   \r
87 <!--\r
88 Winpcap Info\r
89 -->\r
90   <!ENTITY WinPcapWebsite "http://winpcap.polito.it">\r
91   <!ENTITY WinPcapDownloadWebsite "http://winpcap.polito.it/install/Default.htm">\r
92 \r
93 <!--\r
94 Gnu info\r
95 -->\r
96   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">\r
97 \r
98 <!-- Self referential info\r
99 -->\r
100 \r
101   <!ENTITY LatestVersionWebsite "http://www.richardsharpe.com/richard/ethereal/user-guide/book1.html" >\r
102   <!ENTITY LatestVersionPDFWebsiteA4 "http://www.richardsharpe.com/richard/ethereal/user-guide/user-guide-a4.pdf" >\r
103   <!ENTITY LatestVersionPDFWebsiteUSLetter "http://www.richardsharpe.com/richard/ethereal/user-guide/user-guide-usletter.pdf" >\r
104 <!--\r
105 FILE SECTION\r
106 -Use this section to specify the files that make up the book. Use FPI (public identifiers)\r
107 -->\r
108 <!-- These refer to graphics files and figures contained in the document -->\r
109   <!-- -->\r
110   <!ENTITY EtherealLogo SYSTEM "./graphics/ethereal-logo.png" NDATA PNG>\r
111   \r
112   <!-- 1st Chapter -->\r
113   <!ENTITY EtherealMain1 SYSTEM "./graphics/ethereal-main.png" NDATA PNG>\r
114 \r
115   <!-- 2nd Chapter -->\r
116 \r
117   <!-- Third Chapter -->\r
118   <!ENTITY EtherealEmpty SYSTEM "./graphics/ethereal-empty.png" NDATA PNG>\r
119   <!ENTITY EtherealThreePane1 SYSTEM "./graphics/ethereal-3pane.png" NDATA PNG>\r
120   <!ENTITY EtherealMenuOnly SYSTEM "./graphics/ethereal-menu.png" NDATA PNG>\r
121   <!ENTITY EtherealMainToolbar SYSTEM "./graphics/ethereal-main-toolbar.png" NDATA PNG>\r
122   <!ENTITY EtherealFilterToolbar SYSTEM "./graphics/ethereal-filter-toolbar.png" NDATA PNG>\r
123   <!ENTITY EtherealListPane SYSTEM "./graphics/ethereal-list-pane.png" NDATA PNG>\r
124   <!ENTITY EtherealDetailsPane SYSTEM "./graphics/ethereal-details-pane.png" NDATA PNG>\r
125   <!ENTITY EtherealBytesPane SYSTEM "./graphics/ethereal-bytes-pane.png" NDATA PNG>\r
126   <!ENTITY EtherealBytesPaneTabs SYSTEM "./graphics/ethereal-bytes-pane-tabs.png" NDATA PNG>\r
127   <!ENTITY EtherealStatusbarEmpty SYSTEM "./graphics/ethereal-statusbar-empty.png" NDATA PNG>\r
128   <!ENTITY EtherealStatusbarLoaded SYSTEM "./graphics/ethereal-statusbar-loaded.png" NDATA PNG>\r
129   <!ENTITY EtherealStatusbarSelected SYSTEM "./graphics/ethereal-statusbar-selected.png" NDATA PNG>\r
130   <!ENTITY EtherealSaveAs SYSTEM "./graphics/ethereal-save-as.png" NDATA PNG>\r
131   <!ENTITY EtherealOpen SYSTEM "./graphics/ethereal-open.png" NDATA PNG> \r
132   <!ENTITY EtherealPacketSelected1 SYSTEM "./graphics/ethereal-packet-selected.png" NDATA PNG>\r
133   <!ENTITY EtherealPacketSepView SYSTEM "./graphics/ethereal-packet-sep-win.png" NDATA PNG>\r
134   <!ENTITY EtherealFilterTCP SYSTEM "./graphics/ethereal-display-filter-tcp.png" NDATA PNG>  \r
135   <!ENTITY EtherealColoringRulesDialog SYSTEM "./graphics/ethereal-coloring-rules-dialog.png" NDATA PNG>\r
136   <!ENTITY EtherealEditColorDialog SYSTEM "./graphics/ethereal-edit-color-rule-dialog.png" NDATA PNG>\r
137   <!ENTITY EtherealChooseColorDialog SYSTEM "./graphics/ethereal-choose-color-rule.png" NDATA PNG>\r
138   <!ENTITY EtherealFollowStream SYSTEM "./graphics/ethereal-follow-stream.png" NDATA PNG>\r
139   <!ENTITY EtherealFindPacket SYSTEM "./graphics/ethereal-find-packet.png" NDATA PNG>  \r
140   <!ENTITY EtherealGoToPacket SYSTEM "./graphics/ethereal-goto-packet.png" NDATA PNG>  \r
141   <!ENTITY EtherealPrint SYSTEM "./graphics/ethereal-print.png" NDATA PNG>\r
142   <!ENTITY EtherealGUIPreferences SYSTEM "./graphics/ethereal-gui-preferences.png" NDATA PNG>\r
143   <!ENTITY EtherealGUILayoutPreferences SYSTEM "./graphics/ethereal-gui-layout-preferences.png" NDATA PNG>\r
144   <!ENTITY EtherealGUIColumnsPreferences SYSTEM "./graphics/ethereal-gui-columns-preferences.png" NDATA PNG>\r
145   <!ENTITY EtherealGUIFontPreferences SYSTEM "./graphics/ethereal-gui-font-preferences.png" NDATA PNG>\r
146   <!ENTITY EtherealGUIColorsPreferences SYSTEM "./graphics/ethereal-gui-colors-preferences.png" NDATA PNG>\r
147   <!ENTITY EtherealCapturePreferences SYSTEM "./graphics/ethereal-capture-preferences.png" NDATA PNG>\r
148   <!ENTITY EtherealPrintingPreferences SYSTEM "./graphics/ethereal-printing-preferences.png" NDATA PNG>\r
149   <!ENTITY EtherealNameResolutionPreferences SYSTEM "./graphics/ethereal-nameresolution-preferences.png" NDATA PNG>\r
150   <!ENTITY EtherealFilters SYSTEM "./graphics/ethereal-filters.png" NDATA PNG>\r
151   <!ENTITY EtherealFileMenu SYSTEM "./graphics/ethereal-file-menu.png" NDATA PNG>\r
152   <!ENTITY EtherealEditMenu SYSTEM "./graphics/ethereal-edit-menu.png" NDATA PNG>\r
153   <!ENTITY EtherealViewMenu SYSTEM "./graphics/ethereal-view-menu.png" NDATA PNG>\r
154   <!ENTITY EtherealGoMenu SYSTEM "./graphics/ethereal-go-menu.png" NDATA PNG>\r
155   <!ENTITY EtherealCaptureMenu SYSTEM "./graphics/ethereal-capture-menu.png" NDATA PNG>\r
156   <!ENTITY EtherealAnalyzeMenu SYSTEM "./graphics/ethereal-analyze-menu.png" NDATA PNG>\r
157   <!ENTITY EtherealStatisticsMenu SYSTEM "./graphics/ethereal-statistics-menu.png" NDATA PNG>\r
158   <!ENTITY EtherealHelpMenu SYSTEM "./graphics/ethereal-help-menu.png" NDATA PNG>\r
159   <!ENTITY EtherealPacketPanePopupMenu SYSTEM "./graphics/ethereal-packet-pane-popup-menu.png" NDATA PNG>\r
160   <!ENTITY EtherealDetailsPanePopupMenu SYSTEM "./graphics/ethereal-details-pane-popup-menu.png" NDATA PNG>\r
161   <!ENTITY EtherealBytesPanePopupMenu SYSTEM "./graphics/ethereal-bytes-pane-popup-menu.png" NDATA PNG>\r
162   <!ENTITY EtherealFilterAddExpression SYSTEM "./graphics/ethereal-filter-add-expression.png" NDATA PNG>\r
163   <!ENTITY EtherealFilters2 SYSTEM "./graphics/ethereal-filters-2.png" NDATA PNG>\r
164   <!ENTITY EtherealExportPlainDialog SYSTEM "./graphics/ethereal-export-plain.png" NDATA PNG>\r
165   <!ENTITY EtherealExportPSDialog SYSTEM "./graphics/ethereal-export-ps.png" NDATA PNG>\r
166   <!ENTITY EtherealExportPSMLDialog SYSTEM "./graphics/ethereal-export-psml.png" NDATA PNG>\r
167   <!ENTITY EtherealExportPDMLDialog SYSTEM "./graphics/ethereal-export-pdml.png" NDATA PNG>\r
168   <!ENTITY EtherealExportSelectedDialog SYSTEM "./graphics/ethereal-export-selected.png" NDATA PNG>\r
169   <!ENTITY EtherealCaptureOptionsDialog SYSTEM "./graphics/ethereal-capture-options.png" NDATA PNG>\r
170   <!ENTITY EtherealCaptureInfoDialog SYSTEM "./graphics/ethereal-capture-info.png" NDATA PNG>\r
171   <!ENTITY EtherealMergeDialog SYSTEM "./graphics/ethereal-merge.png" NDATA PNG>\r
172   <!ENTITY EtherealPacketRangeFrame SYSTEM "./graphics/ethereal-packet-range.png" NDATA PNG>\r
173   <!ENTITY EtherealPacketFormatFrame SYSTEM "./graphics/ethereal-packet-format.png" NDATA PNG>\r
174   <!ENTITY EtherealTimeReference SYSTEM "./graphics/ethereal-time-reference.png" NDATA PNG>\r
175   <!ENTITY EtherealEnabledProtocols SYSTEM "./graphics/ethereal-enabled-protocols.png" NDATA PNG>\r
176   <!ENTITY EtherealDecodeAs SYSTEM "./graphics/ethereal-decode-as.png" NDATA PNG>\r
177   <!ENTITY EtherealDecodeAsShow SYSTEM "./graphics/ethereal-decode-as-show.png" NDATA PNG>\r
178 \r
179   <!-- Third Chapter Toolbar-->\r
180   <!ENTITY EtherealToolbarCapture SYSTEM "./graphics/toolbar/capture_24.png" NDATA PNG>\r
181   <!ENTITY EtherealToolbarCaptureFilters SYSTEM "./graphics/toolbar/cfilter_24.png" NDATA PNG>\r
182   <!ENTITY EtherealToolbarDisplayFilters SYSTEM "./graphics/toolbar/dfilter_24.png" NDATA PNG>\r
183   <!ENTITY EtherealToolbarAdd SYSTEM "./graphics/toolbar/stock_add_24.png" NDATA PNG>\r
184   <!ENTITY EtherealToolbarGoLast SYSTEM "./graphics/toolbar/stock_bottom_24.png" NDATA PNG>\r
185   <!ENTITY EtherealToolbarClose SYSTEM "./graphics/toolbar/stock_close_24.png" NDATA PNG>\r
186   <!ENTITY EtherealToolbarColoringRules SYSTEM "./graphics/toolbar/stock_colorselector_24.png" NDATA PNG>\r
187   <!ENTITY EtherealToolbarHelp SYSTEM "./graphics/toolbar/stock_help_24.png" NDATA PNG>\r
188   <!ENTITY EtherealToolbarGoTo SYSTEM "./graphics/toolbar/stock_jump_to_24.png" NDATA PNG>\r
189   <!ENTITY EtherealToolbarFindPrevious SYSTEM "./graphics/toolbar/stock_left_arrow_24.png" NDATA PNG>\r
190   <!ENTITY EtherealToolbarOpen SYSTEM "./graphics/toolbar/stock_open_24.png" NDATA PNG>\r
191   <!ENTITY EtherealToolbarPreferences SYSTEM "./graphics/toolbar/stock_preferences_24.png" NDATA PNG>\r
192   <!ENTITY EtherealToolbarPrint SYSTEM "./graphics/toolbar/stock_print_24.png" NDATA PNG>\r
193   <!ENTITY EtherealToolbarProperties SYSTEM "./graphics/toolbar/stock_properties_24.png" NDATA PNG>\r
194   <!ENTITY EtherealToolbarReload SYSTEM "./graphics/toolbar/stock_refresh_24.png" NDATA PNG>\r
195   <!ENTITY EtherealToolbarFindNext SYSTEM "./graphics/toolbar/stock_right_arrow_24.png" NDATA PNG>\r
196   <!ENTITY EtherealToolbarSave SYSTEM "./graphics/toolbar/stock_save_24.png" NDATA PNG>\r
197   <!ENTITY EtherealToolbarSaveAs SYSTEM "./graphics/toolbar/stock_save_as_24.png" NDATA PNG>\r
198   <!ENTITY EtherealToolbarFind SYSTEM "./graphics/toolbar/stock_search_24.png" NDATA PNG>\r
199   <!ENTITY EtherealToolbarStop SYSTEM "./graphics/toolbar/stock_stop_24.png" NDATA PNG>\r
200   <!ENTITY EtherealToolbarGoFirst SYSTEM "./graphics/toolbar/stock_top_24.png" NDATA PNG>\r
201   <!ENTITY EtherealToolbarZoom100 SYSTEM "./graphics/toolbar/stock_zoom_1_24.png" NDATA PNG>\r
202   <!ENTITY EtherealToolbarZoomIn SYSTEM "./graphics/toolbar/stock_zoom_in_24.png" NDATA PNG>\r
203   <!ENTITY EtherealToolbarZoomOut SYSTEM "./graphics/toolbar/stock_zoom_out_24.png" NDATA PNG>\r
204 \r
205   <!-- Third Chapter Statistics -->\r
206   <!ENTITY EtherealStatsSummary SYSTEM "./graphics/ethereal-stats-summary.png" NDATA PNG>\r
207   <!ENTITY EtherealStatsHierarchy SYSTEM "./graphics/ethereal-stats-hierarchy.png" NDATA PNG>\r
208   <!ENTITY EtherealStatsEndpoints SYSTEM "./graphics/ethereal-stats-endpoints.png" NDATA PNG>\r
209   <!ENTITY EtherealStatsConversations SYSTEM "./graphics/ethereal-stats-conversations.png" NDATA PNG>\r
210   <!ENTITY EtherealStatsIOGraphs SYSTEM "./graphics/ethereal-stats-iographs.png" NDATA PNG>\r
211   <!ENTITY EtherealStatsSrtDcerpcFilter SYSTEM "./graphics/ethereal-stats-srt-dcerpc-filter.png" NDATA PNG>\r
212   <!ENTITY EtherealStatsSrtDcerpc SYSTEM "./graphics/ethereal-stats-srt-dcerpc.png" NDATA PNG>\r
213 \r
214   <!-- Fifth Chapter -->\r
215 \r
216   <!-- Sixth Chapter -->\r
217 \r
218   <!-- Appendices etc -->\r
219   <!ENTITY EtherealFormatError SYSTEM "./graphics/ethereal-error-open.png" NDATA PNG>\r
220   <!ENTITY EtherealFormatError SYSTEM "./graphics/ethereal-error-open.png" NDATA PNG>\r
221   <!ENTITY EtherealSaveError SYSTEM "./graphics/ethereal-save-error.png" NDATA PNG>\r
222 \r
223 \r
224 <!-- These are the actual files that make up the document -->\r
225   <!ENTITY BookMetaInformation SYSTEM "ug-src/EUG_meta_info.xml">\r
226   <!ENTITY Preface SYSTEM  "ug-src/EUG_preface.xml">\r
227   <!ENTITY ChapterIntroduction SYSTEM "ug-src/EUG_chapter_introduction.xml">\r
228   <!ENTITY ChapterBuildInstall SYSTEM "ug-src/EUG_chapter_build_install.xml">\r
229   <!ENTITY ChapterUse SYSTEM "ug-src/EUG_chapter_use.xml">\r
230   <!ENTITY ChapterCapture SYSTEM "ug-src/EUG_chapter_capture.xml">\r
231   <!ENTITY ChapterIo SYSTEM "ug-src/EUG_chapter_io.xml">\r
232   <!ENTITY ChapterWork SYSTEM "ug-src/EUG_chapter_work.xml">\r
233   <!ENTITY ChapterAdvanced SYSTEM "ug-src/EUG_chapter_advanced.xml">\r
234   <!ENTITY ChapterStatistics SYSTEM "ug-src/EUG_chapter_statistics.xml">\r
235   <!ENTITY ChapterCustomize SYSTEM "ug-src/EUG_chapter_customize.xml">\r
236   <!ENTITY ChapterTroubleshoot SYSTEM "ug-src/EUG_chapter_troubleshoot.xml">\r
237   <!ENTITY AppMessages SYSTEM "ug-src/EUG_app_messages.xml">\r
238   <!ENTITY AppFiles SYSTEM "ug-src/EUG_app_files.xml">\r
239   <!ENTITY AppProtocols SYSTEM   "ug-src/EUG_app_protocols.xml">\r
240   <!ENTITY AppHowItWorks SYSTEM "ug-src/EUG_app_howitworks.xml">\r
241   <!ENTITY AppTools SYSTEM "ug-src/EUG_app_tools.xml">\r
242   <!ENTITY AppGFDPL SYSTEM    "GFDPL_appendix.xml">\r
243   <!ENTITY ProtoList SYSTEM    "protocols.xml">\r
244 \r
245 ]>\r
246 \r
247 <book>\r
248   <title>&DocumentTitle;</title>\r
249   <subtitle>&DocumentSubTitle;</subtitle>\r
250   <!-- -->\r
251   &BookMetaInformation;\r
252   &Preface;\r
253   &ChapterIntroduction;\r
254   &ChapterBuildInstall;\r
255   &ChapterUse;\r
256   &ChapterCapture;\r
257   &ChapterIo;\r
258   &ChapterWork;\r
259   &ChapterAdvanced;\r
260   <!-- -->\r
261   &ChapterStatistics;  \r
262   &ChapterCustomize;\r
263 \r
264   <!-- Removed, as this chapter has to be reworked first -->\r
265   <!-- &ChapterTroubleshoot; -->\r
266   \r
267   <!-- Removed, as this chapter is much too long and should form it's own document -->\r
268   <!-- &FilterFields; -->\r
269 \r
270   <!-- Removed, as there are a lot more of warnings and messages right now, and \r
271   the warnings and messages should be self explanatory. -->\r
272   <!-- &AppMessages; -->\r
273   \r
274   &AppFiles;\r
275   &AppProtocols;\r
276   &AppTools;\r
277   <!-- Removed, as this chapter is not finished\r
278   &AppHowItWorks;\r
279   -->\r
280   &AppGFDPL;\r
281   <!-- Removed, as these chapters must be reworked -->\r
282   <!--\r
283   &Glossary;\r
284   &Index;  -->\r
285 </book>\r