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