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.13 (preliminary)">
  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>Bugfixes</title>
  69     <para>
  70       The following bugs have been fixed since the previous release:
  71       <itemizedlist>
  72
  73         <listitem><para>
  74           The ISAKMP dissector could exhaust system memory.
  75           <!-- Fixed in r15163 -->
  76           <!-- Bug IDs: none -->
  77           Versions affected: 0.10.11 to 0.10.12.
  78         </para></listitem>
  79
  80         <listitem><para>
  81           The FC-FCS dissector could exhaust system memory.
  82           <!-- Fixed in r15204 -->
  83           <!-- Bug IDs: 312 -->
  84           Versions affected: 0.9.0 to 0.10.12.
  85         </para></listitem>
  86
  87         <listitem><para>
  88           The RSVP dissector could exhaust system memory.
  89           <!-- Fixed in r15206, r15600 -->
  90           <!-- Bug IDs: 311, 314, 382 -->
  91           Versions affected: 0.9.4 to 0.10.12.
  92         </para></listitem>
  93
  94         <listitem><para>
  95           The ISIS LSP dissector could exhaust system memory.
  96           <!-- Fixed in r15245 -->
  97           <!-- Bug IDs: 320, 326 -->
  98           Versions affected: 0.8.18 to 0.10.12.
  99         </para></listitem>
 100
 101         <listitem><para>
 102           The IrDA dissector could crash.
 103           <!-- Fixed in r15265, r15267 -->
 104           <!-- Bug IDs: 328, 329, 330, 334, 335, 336 -->
 105           Versions affected: 0.10.0 to 0.10.12.
 106         </para></listitem>
 107
 108         <listitem><para>
 109           The SLIMP3 dissector could overflow a buffer.
 110           <!-- Fixed in r15279 -->
 111           <!-- Bug IDs: 327 -->
 112           Versions affected: 0.9.1 to 0.10.12.
 113         </para></listitem>
 114
 115         <listitem><para>
 116           The BER dissector was susceptible to an infinite loop.
 117           <!-- Fixed in r15292 -->
 118           <!-- Bug IDs: none -->
 119           Versions affected: 0.10.3 to 0.10.12.
 120         </para></listitem>
 121
 122         <listitem><para>
 123           The SCSI dissector could dereference a null pointer and crash.
 124           <!-- Fixed in r15289 -->
 125           <!-- Bug IDs: none -->
 126           Versions affected: 0.10.3 to 0.10.12.
 127         </para></listitem>
 128
 129         <listitem><para>
 130           If the "Dissect unknown RPC program numbers" option was enabled,
 131           the ONC RPC dissector might be able to exhaust system memory.
 132           This option is disabled by default.
 133           <!-- Fixed in r15290 -->
 134           <!-- Bug IDs: none -->
 135           Versions affected: 0.7.7 to 0.10.12.
 136         </para></listitem>
 137
 138         <listitem><para>
 139           The sFlow dissector could dereference a null pointer and crash.
 140           <!-- Fixed in r15375 -->
 141           <!-- Bug IDs: 356 -->
 142           Versions affected: 0.9.14 to 0.10.12.
 143         </para></listitem>
 144
 145         <listitem><para>
 146           The RTnet dissector could dereference a null pointer and crash.
 147           <!-- Fixed in r15673 -->
 148           <!-- Bug IDs: none -->
 149           Versions affected: 0.10.8 to 0.10.12.
 150         </para></listitem>
 151
 152         <listitem><para>
 153           The SigComp UDVM could go into an infinite loop or crash.
 154           <!-- Fixed in r15715, 15901 -->
 155           <!-- Bug IDs: none -->
 156           Versions affected: 0.10.12.
 157         </para></listitem>
 158
 159         <listitem><para>
 160           If SMB transaction payload reassembly is enabled the SMB
 161           dissector could crash.  This preference is disabled by default.
 162           <!-- Fixed in r15789 -->
 163           <!-- Bug IDs: 421 -->
 164           Versions affected: 0.9.7 to 0.10.12.
 165         </para></listitem>
 166
 167       </itemizedlist>
 168     </para>
 169
 170     <para>
 171       The PCRE library that ships with the Windows installer has been upgraded
 172       from version 4.4 to 6.3 in response to a
 173       <ulink url="http://www.securityfocus.com/bid/14620">security
 174       vulnerability</ulink>.
 175     </para>
 176     </section>
 177
 178     <section><title>New and Updated Features</title>
 179     <para>
 180       The following features are new (or have been significantly updated) since
 181           the last release:
 182       <itemizedlist>
 183
 184         <listitem><para>
 185           The <command>timestamp display precision</command> of the Packet List
 186           can be adjusted now. The precision will be automatically adjusted
 187           depending on the file format loaded, e.g. libpcap typically uses
 188           microsecond resolution displayed like "0.000000". In addition you can
 189           adjust the precision manually through the View/Time Display Format menu
 190           items.
 191         </para></listitem>
 192
 193         <listitem><para>
 194           The <command>WinPcap version 3.1</command> installer was released since
 195           the last Ethereal release. The version included in the Ethereal Windows
 196           installer has been updated from 3.1 beta 4 to 3.1.
 197           If you want to upgrade WinPcap separately or install a
 198           different version you can download it from:
 199           <ulink url="http://www.winpcap.org">the WinPcap web site</ulink>.
 200         </para></listitem>
 201
 202         <listitem><para>
 203           The behavior of the display filter
 204           <command>"ip.checksum_bad" has changed</command>.
 205       Instead of merely checking for its presence you must now make sure
 206       it is set, e.g. instead of using "ip.checksum_bad" you must now
 207       use "ip.checksum_bad == 1".
 208         </para></listitem>
 209
 210         <listitem><para>
 211           A new capture file format
 212           <command>"Nanosecond libpcap (Ethereal)"</command> was added. It is
 213           very similar to the common libpcap file format but is capable of keeping
 214           nanosecond resolution timestamps. This format is currently supported only
 215           by Ethereal.
 216         </para></listitem>
 217
 218       </itemizedlist>
 219     </para>
 220     </section>
 221   </section>
 222
 223   <section id="GettingEthereal"><title>Getting Ethereal</title>
 224     <section><title>Microsoft Windows</title>
 225       <para>
 226         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
 227         <ulink url="http://www.ethereal.com/docs/distribution/win32/">Windows
 228         download area</ulink> on the main web site.  Double-click the
 229         installer executable.
 230       </para>
 231     </section>
 232
 233     <section><title>Sun Solaris</title>
 234       <para>
 235         Download the appropriate package from the
 236         <ulink url="http://www.ethereal.com/docs/distribution/solaris/">Solaris
 237         download area</ulink> on the main web site.  Uncompress the package
 238         using bzip2, and install it using pkgadd.
 239       </para>
 240     </section>
 241
 242     <section><title>Source Code</title>
 243       <para>
 244         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
 245         <ulink url="http://www.ethereal.com/docs/distribution/">main
 246         download area</ulink> on the web site.  Extract the package
 247         using tar and gzip.  Run "configure ; make ; make install".
 248       </para>
 249     </section>
 250
 251     <section><title>Vendor-supplied Packages</title>
 252       <para>
 253         Most Linux and Unix vendors supply their own Ethereal packages.
 254         You can install or upgrade Ethereal using the package management
 255         system specific to that platform.
 256       </para>
 257     </section>
 258
 259   </section>
 260
 261   <section id="RemovingEthereal"><title>Removing Ethereal</title>
 262     <para>
 263   <!-- XXX needs to be written -->
 264     </para>
 265   </section>
 266
 267   <section id="FileLocations"><title>File Locations</title>
 268     <para>
 269       Ethereal and Tethereal look in several different locations for
 270       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
 271       These locations vary from platform to platform.  You can use
 272       About->Folders to find the default locations on your system.
 273     </para>
 274   </section>
 275
 276   <section id="KnownProblems"><title>Known Problems</title>
 277     <para>
 278     On Windows systems the packet list scroll bar can sometimes disappear
 279     or become unusable.  Until the problem is fixed you can work around it
 280     by resizing the packet list or the main window.
 281     (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
 282     #220</ulink>)
 283     </para>
 284   </section>
 285
 286   <section id="GettingHelp"><title>Getting Help</title>
 287     <para>
 288   <!-- XXX needs to be written -->
 289     </para>
 290   </section>
 291
 292   <section id="FAQ"><title>Frequently Asked Questions</title>
 293     <para>
 294   <!-- XXX needs to be written -->
 295     </para>
 296   </section>
 297
 298 </article>