Updated feature: When cancelling a file load operation...
[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   <!ENTITY DocumentTitle "<application>Ethereal</application> Release Notes">
13   <!ENTITY DocumentSubTitle "&DocumentVersion; (&SvnVersion;) for Ethereal &EtherealCurrentVersion;">
14   <!ENTITY DocumentTitleAbbreviation "Relnotes">
15
16   <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
17   %SvnVersionFile;
18 <!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>">
19
20 <!--
21 Ethereal Info
22 -->
23   <!ENTITY EtherealCurrentVersion "0.10.14pre1">
24   <!ENTITY EtherealWebSite "http://www.ethereal.com">
25   <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
26   <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
27   <!ENTITY EtherealBinariesPage "&EtherealWebSite;/download.html#releases">
28   <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
29   <!ENTITY EtherealProtocolsPage "&EtherealWebSite;/docs/dfref/">
30   <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
31   <!ENTITY EtherealFAQPromiscPage "&EtherealWebSite;/faq#promiscsniff">
32   <!ENTITY EtherealMediaPage "&EtherealWebSite;/media.html">
33   <!ENTITY EtherealWikiPage "http://wiki.ethereal.com">
34   <!ENTITY EtherealWikiCaptureFiltersPage "&EtherealWikiPage;/CaptureFilters">
35   <!ENTITY EtherealWikiDisplayFiltersPage "&EtherealWikiPage;/DisplayFilters">
36   <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
37   <!ENTITY EtherealWikiColoringRulesPage "&EtherealWikiPage;/ColoringRules">
38   <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
39
40   <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
41   <!ENTITY EtherealUsersMailList "ethereal-users[AT]ethereal.com">
42
43   
44 <!--
45 Winpcap Info
46 -->
47   <!ENTITY WinPcapWebsite "http://www.winpcap.org">
48   <!ENTITY WinPcapDownloadWebsite "http://www.winpcap.org/install/default.htm">
49
50 <!--
51 Gnu info
52 -->
53   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
54
55 ]>
56
57 <article>
58   <title>Ethereal &EtherealCurrentVersion; Release Notes</title>
59
60   <section id="WhatIs"><title>What is Ethereal?</title>
61     <para>
62       Ethereal is the world's most popular network protocol analyzer.  It
63       is used for troubleshooting, analysis, development, and education.
64     </para>
65   </section>
66
67   <section id="WhatsNew"><title>What's New</title>
68     <section><title>Bug Fixes</title>
69     <para>
70       Several security vulnerabilities have been fixed since the
71       previous release.  See the
72       <ulink url="http://www.ethereal.com/appnotes/enpa-sa-00022.html">application
73       advisory</ulink> for more details.
74       <itemizedlist>
75
76         <listitem><para>
77           The IRC dissector could go into an infinite loop.
78           <!-- Fixed in r16290 -->
79           <!-- Bug IDs: 548 -->
80           <!-- CVE: CVE-2005-3313 -->
81           Versions affected: 0.10.13.
82         </para></listitem>
83
84         <listitem><para>
85           The GTP dissector could go into an infinite loop.
86           <!-- Fixed in r16436 -->
87           <!-- Bug IDs: 576 -->
88           <!-- CVE: None -->
89           Versions affected: 0.9.1 to 0.10.13.
90         </para></listitem>
91
92       </itemizedlist>
93     </para>
94     </section>
95
96     <section><title>New and Updated Features</title>
97     <para>
98       The following features are new (or have been significantly updated)
99       since the last release:
100
101       <itemizedlist>
102         <listitem><para>
103                 When cancelling a file load operation, Ethereal will keep
104                 displaying the loaded packets now, instead of simply discarding the 
105                 whole load attempt. 
106                 </para>
107                 <para>
108                 This can be very helpful to detect wether a specific (huge) capture 
109                 file is the expected file or not. Remember: 
110                 The complete load of a huge capture file (>100MB) can take even 
111                 minutes!
112         </para></listitem>
113       </itemizedlist>
114     </para>
115     </section>
116
117     <section><title>New Protocol Support</title>
118     <para>
119
120     </para>
121     </section>
122
123     <section><title>Updated Protocol Support</title> <para>
124
125     </para>
126     </section>
127
128     <section><title>New and Updated Capture File Support</title>
129     <para>
130
131     </para>
132     </section>
133
134   </section>
135
136   <section id="GettingEthereal"><title>Getting Ethereal</title>
137     <section><title>Microsoft Windows</title>
138       <para>
139         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
140         <ulink url="http://www.ethereal.com/docs/distribution/win32/">Windows
141         download area</ulink> on the main web site.  Double-click the 
142         installer executable.
143       </para>
144     </section>
145
146     <section><title>Sun Solaris</title>
147       <para>
148         Download the appropriate package from the
149         <ulink url="http://www.ethereal.com/docs/distribution/solaris/">Solaris
150         download area</ulink> on the main web site.  Uncompress the package
151         using bzip2, and install it using pkgadd.
152       </para>
153     </section>
154
155     <section><title>Source Code</title>
156       <para>
157         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
158         <ulink url="http://www.ethereal.com/docs/distribution/">main
159         download area</ulink> on the web site.  Extract the package
160         using tar and gzip.  Run "configure ; make ; make install".
161       </para>
162     </section>
163
164     <section><title>Vendor-supplied Packages</title>
165       <para>
166         Most Linux and Unix vendors supply their own Ethereal packages.
167         You can install or upgrade Ethereal using the package management
168         system specific to that platform.  A list of third-party packages
169         can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Ethereal web site.
170       </para>
171     </section>
172
173   </section>
174
175   <!-- XXX needs to be written 
176   <section id="RemovingEthereal"><title>Removing Ethereal</title>
177     <para>
178     </para>
179   </section>
180   -->
181
182   <section id="FileLocations"><title>File Locations</title>
183     <para>
184       Ethereal and Tethereal look in several different locations for
185       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
186       These locations vary from platform to platform.  You can use
187       About->Folders to find the default locations on your system.
188     </para>
189   </section>
190
191   <section id="KnownProblems"><title>Known Problems</title>
192     <para>
193     On Windows systems the packet list scroll bar can sometimes disappear
194     or become unusable.  Until the problem is fixed you can work around it
195     by resizing the packet list or the main window.
196     (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
197     #220</ulink>)
198     </para>
199   </section>
200
201   <section id="GettingHelp"><title>Getting Help</title>
202     <para>
203     Community support is available on the ethereal-users mailing list.
204     Subscription information and archives for all of Ethereal's mailing
205     lists can be found on <ulink url="http://www.ethereal.com/lists/">the
206     web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
207     </para>
208     <para>
209     Commercial support, training, and development services are available
210     from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
211     </para>
212   </section>
213
214   <section id="FAQ"><title>Frequently Asked Questions</title>
215     <para>
216     A complete FAQ is available on the
217     <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
218     </para>
219   </section>
220
221 </article>