Ethereal->Wireshark
[obnox/wireshark/wip.git] / docbook / release-notes.xml
index e14b9ea0f426a367b9091a44504aa559351bd205..6dfdd794e1d89c72fca94ac6671456d3b8eadab1 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 
 <!-- $Id$ -->
@@ -9,48 +9,10 @@ DOCUMENT SECTION
 -Use this section to encode all document information
 -->
 
-  <!ENTITY DocumentTitle "<application>Ethereal</application> Release Notes">
-  <!ENTITY DocumentSubTitle "&DocumentVersion; (&SvnVersion;) for Ethereal &EtherealCurrentVersion;">
-  <!ENTITY DocumentTitleAbbreviation "Relnotes">
-
-  <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
-  %SvnVersionFile;
-<!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>">
-
 <!--
 Ethereal Info
 -->
-  <!ENTITY EtherealCurrentVersion "0.10.15">
-  <!ENTITY EtherealWebSite "http://www.ethereal.com">
-  <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
-  <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
-  <!ENTITY EtherealBinariesPage "&EtherealWebSite;/download.html#releases">
-  <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
-  <!ENTITY EtherealProtocolsPage "&EtherealWebSite;/docs/dfref/">
-  <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
-  <!ENTITY EtherealFAQPromiscPage "&EtherealWebSite;/faq#promiscsniff">
-  <!ENTITY EtherealMediaPage "&EtherealWebSite;/media.html">
-  <!ENTITY EtherealWikiPage "http://wiki.ethereal.com">
-  <!ENTITY EtherealWikiCaptureFiltersPage "&EtherealWikiPage;/CaptureFilters">
-  <!ENTITY EtherealWikiDisplayFiltersPage "&EtherealWikiPage;/DisplayFilters">
-  <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
-  <!ENTITY EtherealWikiColoringRulesPage "&EtherealWikiPage;/ColoringRules">
-  <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
-
-  <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
-  <!ENTITY EtherealUsersMailList "ethereal-users[AT]ethereal.com">
-
-  
-<!--
-Winpcap Info
--->
-  <!ENTITY WinPcapWebsite "http://www.winpcap.org">
-  <!ENTITY WinPcapDownloadWebsite "http://www.winpcap.org/install/default.htm">
-
-<!--
-Gnu info
--->
-  <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
+  <!ENTITY EtherealCurrentVersion "0.99.0">
 
 ]>
 
@@ -59,7 +21,7 @@ Gnu info
 
   <section id="WhatIs"><title>What is Ethereal?</title>
     <para>
-      Ethereal is the world's most popular network protocol analyzer.  It
+      Wireshark is the world's most popular network protocol analyzer.  It
       is used for troubleshooting, analysis, development, and education.
     </para>
   </section>
@@ -67,47 +29,53 @@ Gnu info
   <section id="WhatsNew"><title>What's New</title>
     <section><title>Bug Fixes</title>
     <para>
-      Three security vulnerabilities have been fixed since the
-      previous release.  See the
-      <ulink url="http://www.ethereal.com/appnotes/enpa-sa-00022.html">application
-      advisory</ulink> for more details.
+
+      The following vulnerabilities have been fixed:
+
       <itemizedlist>
 
         <listitem><para>
-         The H.248 dissector could crash.
-         <!-- Fixed in r16967 -->
-         <!-- Bug IDs: 651 -->
-         Versions affected: 0.10.14.
-        </para></listitem>
-        <listitem><para>
-         Win32: Unicode characters in the users profile path causes problems 
-         reading/writing the preferences (and alike) files.
-         <!-- Fixed in r17024 -->
-         <!-- Bug IDs: 648 -->
-         Versions affected: 0.10.14.
+         The XXXXXX dissector could crash.
+         <!-- Fixed in r#####, r##### -->
+         <!-- Bug IDs: ### -->
+         Versions affected: 0.99.0.
         </para></listitem>
+
+      </itemizedlist>
+
+     <!-- Coverity bugs (r17489 and above) -->
+
+      Under a grant funded by the U.S. Department of Homeland Security,
+      <ulink url="http://www.coverity.com">Coverity</ulink> has uncovered
+      a number of vulnerabilities in Wireshark:
+      <itemizedlist>
+
+        <!-- CID 1 - 149: Fixed for 0.99.0 -->
+        <!-- CID 150: Post-0.99.0 -->
+
         <listitem><para>
-         Win32: Unicode characters in filenames given to the Ethereal command 
-         line doesn't work (used e.g. when "double-clicking" in explorer).
-         <!-- Fixed in r17025 -->
-         <!-- Bug IDs: 661 -->
-         Versions affected: 0.10.14.
+         XXXX feature could crash Ethereal.
+         <!-- Fixed in r##### -->
+         <!-- Bug IDs: None -->
+          <!-- Coverity CID ### -->
+         Versions affected: 0.9.16.
         </para></listitem>
 
       </itemizedlist>
     </para>
+
     </section>
 
     <section><title>New and Updated Features</title>
     <para>
       The following features are new (or have been significantly updated)
       since the last release:
+      <itemizedlist>
 
         <listitem><para>
-         Win32: Catch hardware exceptions caused by buggy dissectors. 
-         If e.g. a NULL pointer exceptions occurs, Ethereal won't crash now 
-         but displays the exception and tries to continue decoding packets.
         </para></listitem>
+
+      </itemizedlist>
     </para>
     </section>
 
@@ -135,7 +103,7 @@ Gnu info
       <para>
        Download ethereal-setup-&EtherealCurrentVersion;.exe from the
        <ulink url="http://www.ethereal.com/distribution/win32/">Windows
-       download area</ulink> on the main web site.  Double-click the 
+       download area</ulink> on the main web site.  Double-click the
        installer executable.
       </para>
     </section>
@@ -163,13 +131,13 @@ Gnu info
        Most Linux and Unix vendors supply their own Ethereal packages.
        You can install or upgrade Ethereal using the package management
        system specific to that platform.  A list of third-party packages
-        can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Ethereal web site.
+        can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Wireshark web site.
       </para>
     </section>
 
   </section>
 
-  <!-- XXX needs to be written 
+  <!-- XXX needs to be written
   <section id="RemovingEthereal"><title>Removing Ethereal</title>
     <para>
     </para>
@@ -186,13 +154,44 @@ Gnu info
   </section>
 
   <section id="KnownProblems"><title>Known Problems</title>
+
+    <para>
+      On Windows systems the packet list scroll bar can sometimes disappear
+      or become unusable.  Until the problem is fixed you can work around it
+      by resizing the packet list or the main window.
+      (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
+      #220</ulink>)
+    </para>
+
     <para>
-    On Windows systems the packet list scroll bar can sometimes disappear
-    or become unusable.  Until the problem is fixed you can work around it
-    by resizing the packet list or the main window.
-    (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
-    #220</ulink>)
+      The <guibutton>Filter</guibutton> button is nonfunctional in the
+      file dialogs under Windows.
     </para>
+
+    <para>
+      Trying to save flow data may crash Ethereal.
+      (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=396">Bug
+      #396</ulink>)
+    </para>
+
+    <para>
+      It may not be possible to re-order coloring rules under Windows.
+      (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=699">Bug
+      #699</ulink>)
+    </para>
+
+    <para>
+      Multiple tap interfaces may cause a crash under FreeBSD.
+      (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=757">Bug
+      #757</ulink>)
+    </para>
+
+    <para>
+      Ethereal may crash while viewing TCP streams.
+      (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=852">Bug
+      #852</ulink>)
+    </para>
+
   </section>
 
   <section id="GettingHelp"><title>Getting Help</title>