Further cleanup of Wireshark User Guide
[obnox/wireshark/wip.git] / docbook / wsug_src / WSUG_preface.xml
1 <!-- $Id$ -->
2
3 <preface id="Preface">
4   <title>Preface</title>
5   <section id="PreForeword">
6   <title>Foreword</title>
7   <para>
8     Wireshark is one of those programs that many network managers would love 
9     to be able to use, but they are often prevented from getting what they 
10     would like from Wireshark because of the lack of documentation.
11   </para>
12   <para>
13     This document is part of an effort by the Wireshark team to improve the 
14         usability of Wireshark.
15   </para>
16   <para>
17     We hope that you find it useful, and look forward to your comments.
18   </para>
19   </section>
20
21   <section id="PreAudience">
22   <title>Who should read this document?</title>
23   <para>
24   The intended audience of this book is anyone using Wireshark.
25   </para>
26   <para>
27   This book will explain all the basics and also some of the advanced features 
28   that Wireshark provides. As Wireshark has become a very complex program since 
29   the early days, not every feature of Wireshark might be explained in this 
30   book. 
31   </para>
32   <para>
33   This book is not intended to explain network sniffing in general and it will
34   not provide details about specific network protocols. A lot of useful 
35   information regarding these topics can be found at the Wireshark Wiki at
36   <ulink url="&WiresharkWikiPage;">&WiresharkWikiPage;</ulink>
37   </para>
38   <para>
39   By reading this book, you will learn how to install Wireshark, how to use the 
40   basic elements of the graphical user interface (like the menu) and what's 
41   behind some of the advanced features that are maybe not that obvious at first 
42   sight. It will 
43   hopefully guide you around some common problems that frequently appears for 
44   new (and sometimes even advanced) users of Wireshark.
45   </para>
46   </section>
47
48   <section id="PreAck">
49   <title>Acknowledgements</title>
50   <para>
51     The authors would like to thank the whole Wireshark team for their 
52         assistance. In particular, the authors would like to thank:
53     <itemizedlist>
54       <listitem>
55         <para>
56           Gerald Combs, for initiating the Wireshark project and funding to 
57           do this documentation.
58         </para>
59       </listitem>
60       <listitem>
61         <para>
62           Guy Harris, for many helpful hints and a great deal of patience 
63           in reviewing this document.
64         </para>
65       </listitem>
66       <listitem>
67         <para>
68           Gilbert Ramirez, for general encouragement and helpful hints along 
69           the way.
70         </para>
71       </listitem>
72     </itemizedlist>
73   </para>
74   <para>
75     The authors would also like to thank the following people for their 
76         helpful feedback on this document:
77     <itemizedlist>
78       <listitem>
79         <para>
80           Pat Eyler, for his suggestions on improving the example on 
81           generating a backtrace.
82         </para>
83       </listitem>
84       <listitem>
85         <para>
86           Martin Regner, for his various suggestions and corrections.
87         </para>
88       </listitem>
89       <listitem>
90         <para>
91           Graeme Hewson, for a lot of grammatical corrections.
92         </para>
93       </listitem>
94     </itemizedlist>
95   </para>
96   <para>
97     The authors would like to acknowledge those man page and README authors 
98         for the Wireshark project from who sections of this document borrow heavily:
99     <itemizedlist>
100       <listitem>
101         <para>
102           Scott Renfro from whose <command>mergecap</command> man page 
103           <xref linkend="AppToolsmergecap"/> is derived.
104         </para>
105       </listitem>
106       <listitem>
107         <para>
108           Ashok Narayanan from whose <command>text2pcap</command> man page 
109           <xref linkend="AppToolstext2pcap"/> is derived.
110         </para>
111       </listitem>
112       <listitem>
113         <para>
114           Frank Singleton from whose <filename>README.idl2wrs</filename> 
115           <xref linkend="AppToolsidl2wrs"/> is derived. 
116         </para>
117       </listitem>
118     </itemizedlist>
119   </para>
120   </section>
121
122   <section id="PreAbout">
123     <title>About this document</title>
124     <para>
125       This book was originally developed by 
126       <ulink url="mailto:&AuthorEmail;">Richard Sharpe</ulink> with 
127       funds provided from the Wireshark Fund. It was updated by 
128           <ulink url="mailto:&AuthorEmail2;">Ed Warnicke</ulink> and more recently 
129           redesigned and updated by <ulink url="mailto:&AuthorEmail3;">Ulf 
130           Lamping</ulink>.
131     </para>
132     <para>
133       It is written in DocBook/XML.
134     </para>
135     <para>
136         You will find some specially marked parts in this book:
137     </para>
138     <warning><title>This is a warning!</title>
139         <para>
140         You should pay attention to a warning, as otherwise data loss might occur.
141         </para>
142     </warning>
143     <note><title>This is a note!</title>
144         <para>
145         A note will point you to common mistakes and things that might not be 
146         obvious.
147         </para>
148     </note>
149     <tip><title>This is a tip!</title>
150         <para>
151         Tips will be helpful for your everyday work using Wireshark.
152         </para>
153     </tip>
154   </section>
155   
156   <section id="PreDownload">
157     <title>Where to get the latest copy of this document?</title>
158     <para>
159       The latest copy of this documentation can always be found at: 
160       <ulink url="&WiresharkUsersGuidePage;"/>.
161     </para>
162   </section>
163
164   <section id="PreFeedback">
165     <title>Providing feedback about this document</title>
166     <para>
167       Should you have any feedback about this document, please send them 
168       to the authors through <ulink url="mailto:&WiresharkDevMailList;">&WiresharkDevMailList;</ulink>.
169     </para>
170   </section>
171 </preface>