Add an entry for the UMA dissector.
[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.15">
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       Three 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 H.248 dissector could crash.
78           <!-- Fixed in r16967 -->
79           <!-- Bug IDs: 651 -->
80           Versions affected: 0.10.14.
81         </para></listitem>
82         <listitem><para>
83           The UMA dissector could go into an infinite loop.
84           <!-- Fixed in r17119, r17273 -->
85           <!-- Bug IDs: ??? -->
86           Versions affected: ???.
87         </para></listitem>
88         <listitem><para>
89           Win32: Unicode characters in the users profile path causes problems 
90           reading/writing the preferences (and alike) files.
91           <!-- Fixed in r17024 -->
92           <!-- Bug IDs: 648 -->
93           Versions affected: 0.10.14.
94         </para></listitem>
95         <listitem><para>
96           Win32: Unicode characters in filenames given to the Ethereal command 
97           line doesn't work (used e.g. when "double-clicking" in explorer).
98           <!-- Fixed in r17025 -->
99           <!-- Bug IDs: 661 -->
100           Versions affected: 0.10.14.
101         </para></listitem>
102
103 <!-- FIX (17235), canary bugs -->
104
105       </itemizedlist>
106     </para>
107     </section>
108
109     <section><title>New and Updated Features</title>
110     <para>
111       The following features are new (or have been significantly updated)
112       since the last release:
113       <itemizedlist>
114
115         <listitem><para>
116           Win32: Catch hardware exceptions caused by buggy dissectors. 
117           If e.g. a NULL pointer exceptions occurs, Ethereal won't crash now 
118           but displays the exception and tries to continue decoding packets.
119         </para></listitem>
120       </itemizedlist>
121     </para>
122     </section>
123
124     <section><title>New Protocol Support</title>
125     <para>
126
127     </para>
128     </section>
129
130     <section><title>Updated Protocol Support</title> <para>
131
132     </para>
133     </section>
134
135     <section><title>New and Updated Capture File Support</title>
136     <para>
137
138     </para>
139     </section>
140
141   </section>
142
143   <section id="GettingEthereal"><title>Getting Ethereal</title>
144     <section><title>Microsoft Windows</title>
145       <para>
146         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
147         <ulink url="http://www.ethereal.com/distribution/win32/">Windows
148         download area</ulink> on the main web site.  Double-click the 
149         installer executable.
150       </para>
151     </section>
152
153     <section><title>Sun Solaris</title>
154       <para>
155         Download the appropriate package from the
156         <ulink url="http://www.ethereal.com/distribution/solaris/">Solaris
157         download area</ulink> on the main web site.  Uncompress the package
158         using bzip2, and install it using pkgadd.
159       </para>
160     </section>
161
162     <section><title>Source Code</title>
163       <para>
164         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
165         <ulink url="http://www.ethereal.com/distribution/">main
166         download area</ulink> on the web site.  Extract the package
167         using tar and gzip.  Run "configure ; make ; make install".
168       </para>
169     </section>
170
171     <section><title>Vendor-supplied Packages</title>
172       <para>
173         Most Linux and Unix vendors supply their own Ethereal packages.
174         You can install or upgrade Ethereal using the package management
175         system specific to that platform.  A list of third-party packages
176         can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Ethereal web site.
177       </para>
178     </section>
179
180   </section>
181
182   <!-- XXX needs to be written 
183   <section id="RemovingEthereal"><title>Removing Ethereal</title>
184     <para>
185     </para>
186   </section>
187   -->
188
189   <section id="FileLocations"><title>File Locations</title>
190     <para>
191       Ethereal and Tethereal look in several different locations for
192       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
193       These locations vary from platform to platform.  You can use
194       About->Folders to find the default locations on your system.
195     </para>
196   </section>
197
198   <section id="KnownProblems"><title>Known Problems</title>
199     <para>
200     On Windows systems the packet list scroll bar can sometimes disappear
201     or become unusable.  Until the problem is fixed you can work around it
202     by resizing the packet list or the main window.
203     (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
204     #220</ulink>)
205     </para>
206   </section>
207
208   <section id="GettingHelp"><title>Getting Help</title>
209     <para>
210     Community support is available on the ethereal-users mailing list.
211     Subscription information and archives for all of Ethereal's mailing
212     lists can be found on <ulink url="http://www.ethereal.com/lists/">the
213     web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
214     </para>
215     <para>
216     Commercial support, training, and development services are available
217     from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
218     </para>
219   </section>
220
221   <section id="FAQ"><title>Frequently Asked Questions</title>
222     <para>
223     A complete FAQ is available on the
224     <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
225     </para>
226   </section>
227
228 </article>