Ethereal->Wireshark
[obnox/wireshark/wip.git] / docbook / release-notes.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE article 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 DOCUMENT SECTION
9 -Use this section to encode all document information
10 -->
11
12 <!--
13 Ethereal Info
14 -->
15   <!ENTITY EtherealCurrentVersion "0.99.0">
16
17 ]>
18
19 <article>
20   <title>Ethereal &EtherealCurrentVersion; Release Notes</title>
21
22   <section id="WhatIs"><title>What is Ethereal?</title>
23     <para>
24       Wireshark is the world's most popular network protocol analyzer.  It
25       is used for troubleshooting, analysis, development, and education.
26     </para>
27   </section>
28
29   <section id="WhatsNew"><title>What's New</title>
30     <section><title>Bug Fixes</title>
31     <para>
32
33       The following vulnerabilities have been fixed:
34
35       <itemizedlist>
36
37         <listitem><para>
38           The XXXXXX dissector could crash.
39           <!-- Fixed in r#####, r##### -->
40           <!-- Bug IDs: ### -->
41           Versions affected: 0.99.0.
42         </para></listitem>
43
44       </itemizedlist>
45
46      <!-- Coverity bugs (r17489 and above) -->
47
48       Under a grant funded by the U.S. Department of Homeland Security,
49       <ulink url="http://www.coverity.com">Coverity</ulink> has uncovered
50       a number of vulnerabilities in Wireshark:
51       <itemizedlist>
52
53         <!-- CID 1 - 149: Fixed for 0.99.0 -->
54         <!-- CID 150: Post-0.99.0 -->
55
56         <listitem><para>
57           XXXX feature could crash Ethereal.
58           <!-- Fixed in r##### -->
59           <!-- Bug IDs: None -->
60           <!-- Coverity CID ### -->
61           Versions affected: 0.9.16.
62         </para></listitem>
63
64       </itemizedlist>
65     </para>
66
67     </section>
68
69     <section><title>New and Updated Features</title>
70     <para>
71       The following features are new (or have been significantly updated)
72       since the last release:
73       <itemizedlist>
74
75         <listitem><para>
76         </para></listitem>
77
78       </itemizedlist>
79     </para>
80     </section>
81
82     <section><title>New Protocol Support</title>
83     <para>
84
85     </para>
86     </section>
87
88     <section><title>Updated Protocol Support</title> <para>
89
90     </para>
91     </section>
92
93     <section><title>New and Updated Capture File Support</title>
94     <para>
95
96     </para>
97     </section>
98
99   </section>
100
101   <section id="GettingEthereal"><title>Getting Ethereal</title>
102     <section><title>Microsoft Windows</title>
103       <para>
104         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
105         <ulink url="http://www.ethereal.com/distribution/win32/">Windows
106         download area</ulink> on the main web site.  Double-click the
107         installer executable.
108       </para>
109     </section>
110
111     <section><title>Sun Solaris</title>
112       <para>
113         Download the appropriate package from the
114         <ulink url="http://www.ethereal.com/distribution/solaris/">Solaris
115         download area</ulink> on the main web site.  Uncompress the package
116         using bzip2, and install it using pkgadd.
117       </para>
118     </section>
119
120     <section><title>Source Code</title>
121       <para>
122         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
123         <ulink url="http://www.ethereal.com/distribution/">main
124         download area</ulink> on the web site.  Extract the package
125         using tar and gzip.  Run "configure ; make ; make install".
126       </para>
127     </section>
128
129     <section><title>Vendor-supplied Packages</title>
130       <para>
131         Most Linux and Unix vendors supply their own Ethereal packages.
132         You can install or upgrade Ethereal using the package management
133         system specific to that platform.  A list of third-party packages
134         can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Wireshark web site.
135       </para>
136     </section>
137
138   </section>
139
140   <!-- XXX needs to be written
141   <section id="RemovingEthereal"><title>Removing Ethereal</title>
142     <para>
143     </para>
144   </section>
145   -->
146
147   <section id="FileLocations"><title>File Locations</title>
148     <para>
149       Ethereal and Tethereal look in several different locations for
150       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
151       These locations vary from platform to platform.  You can use
152       About->Folders to find the default locations on your system.
153     </para>
154   </section>
155
156   <section id="KnownProblems"><title>Known Problems</title>
157
158     <para>
159       On Windows systems the packet list scroll bar can sometimes disappear
160       or become unusable.  Until the problem is fixed you can work around it
161       by resizing the packet list or the main window.
162       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
163       #220</ulink>)
164     </para>
165
166     <para>
167       The <guibutton>Filter</guibutton> button is nonfunctional in the
168       file dialogs under Windows.
169     </para>
170
171     <para>
172       Trying to save flow data may crash Ethereal.
173       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=396">Bug
174       #396</ulink>)
175     </para>
176
177     <para>
178       It may not be possible to re-order coloring rules under Windows.
179       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=699">Bug
180       #699</ulink>)
181     </para>
182
183     <para>
184       Multiple tap interfaces may cause a crash under FreeBSD.
185       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=757">Bug
186       #757</ulink>)
187     </para>
188
189     <para>
190       Ethereal may crash while viewing TCP streams.
191       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=852">Bug
192       #852</ulink>)
193     </para>
194
195   </section>
196
197   <section id="GettingHelp"><title>Getting Help</title>
198     <para>
199     Community support is available on the ethereal-users mailing list.
200     Subscription information and archives for all of Ethereal's mailing
201     lists can be found on <ulink url="http://www.ethereal.com/lists/">the
202     web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
203     </para>
204     <para>
205     Commercial support, training, and development services are available
206     from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
207     </para>
208   </section>
209
210   <section id="FAQ"><title>Frequently Asked Questions</title>
211     <para>
212     A complete FAQ is available on the
213     <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
214     </para>
215   </section>
216
217 </article>