wireshark/docbook/release-notes.xml

<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!-- $Id$ -->

<!--
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.99.0">
  <!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">

]>

<article>
  <title>Ethereal &EtherealCurrentVersion; Release Notes</title>

  <section id="WhatIs"><title>What is Ethereal?</title>
    <para>
      Ethereal is the world's most popular network protocol analyzer.  It
      is used for troubleshooting, analysis, development, and education.
    </para>
  </section>

  <section id="WhatsNew"><title>What's New</title>
    <section><title>Bug Fixes</title>
    <para>
      Many 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.
      <itemizedlist>

        <listitem><para>
	  The H.248 dissector could crash.
	  <!-- Fixed in r16967 -->
	  <!-- Bug IDs: 651 -->
	  Versions affected: 0.10.14.
        </para></listitem>
        <listitem><para>
	  The UMA dissector could go into an infinite loop.
	  <!-- Fixed in r17119, r17273 -->
	  <!-- Bug IDs: ??? -->
	  Versions affected: ???.
        </para></listitem>

<!-- FIX (17235), canary bugs -->


      </itemizedlist>

      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 Ethereal:
      <itemizedlist>
          
        <listitem><para>
	  The GSM SMS dissector could crash Ethereal.
	  <!-- Fixed in r17506 -->
	  <!-- Bug IDs: None -->
          <!-- Coverity run 12, CID 104 -->
	  Versions affected: ???.
        </para></listitem>

      </itemizedlist>
    </para>

    <para>
      Win32: Unicode characters in the users profile path causes problems 
      reading/writing the preferences (and alike) files.
      <!-- Fixed in r17024,r17025 -->
      <!-- Bug IDs: 648 -->
      Versions affected: 0.10.14.
    </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>
		The new command line tool <command>dumpcap</command> makes it 
		possible to capture network data without the drawbacks of (t)ethereal 
		(memory usage, security problems, ...) while keeping the benefit of 
		advanced techniques like multiple (ringbuffer) files and alike.
		</para>
		<para>
		The manpage of <command>dumpcap</command> in HTML format is available 
		at: <ulink url="http://www.ethereal.com/docs/"/>
        </para></listitem>
        <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>

    <section><title>New Protocol Support</title>
    <para>

    </para>
    </section>

    <section><title>Updated Protocol Support</title> <para>

    </para>
    </section>

    <section><title>New and Updated Capture File Support</title>
    <para>

    </para>
    </section>

  </section>

  <section id="GettingEthereal"><title>Getting Ethereal</title>
    <section><title>Microsoft Windows</title>
      <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 
	installer executable.
      </para>
    </section>

    <section><title>Sun Solaris</title>
      <para>
	Download the appropriate package from the
	<ulink url="http://www.ethereal.com/distribution/solaris/">Solaris
	download area</ulink> on the main web site.  Uncompress the package
	using bzip2, and install it using pkgadd.
      </para>
    </section>

    <section><title>Source Code</title>
      <para>
	Download ethereal-&EtherealCurrentVersion;.tar.gz from the
	<ulink url="http://www.ethereal.com/distribution/">main
	download area</ulink> on the web site.  Extract the package
	using tar and gzip.  Run "configure ; make ; make install".
      </para>
    </section>

    <section><title>Vendor-supplied Packages</title>
      <para>
	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.
      </para>
    </section>

  </section>

  <!-- XXX needs to be written 
  <section id="RemovingEthereal"><title>Removing Ethereal</title>
    <para>
    </para>
  </section>
  -->

  <section id="FileLocations"><title>File Locations</title>
    <para>
      Ethereal and Tethereal look in several different locations for
      preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
      These locations vary from platform to platform.  You can use
      About->Folders to find the default locations on your system.
    </para>
  </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>
  </section>

  <section id="GettingHelp"><title>Getting Help</title>
    <para>
    Community support is available on the ethereal-users mailing list.
    Subscription information and archives for all of Ethereal's mailing
    lists can be found on <ulink url="http://www.ethereal.com/lists/">the
    web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
    </para>
    <para>
    Commercial support, training, and development services are available
    from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
    </para>
  </section>

  <section id="FAQ"><title>Frequently Asked Questions</title>
    <para>
    A complete FAQ is available on the
    <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
    </para>
  </section>

</article>