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
-->

<!--
Ethereal Info
-->
  <!ENTITY EtherealCurrentVersion "0.99.0">

]>

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

  <section id="WhatIs"><title>What is Ethereal?</title>
    <para>
      Wireshark 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>

      The following vulnerabilities have been fixed:

      <itemizedlist>

        <listitem><para>
	  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>
	  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>
        </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 Wireshark 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 TShark 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>

    <para>
      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>
    <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>