aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2004-07-30 17:10:49 +0000
committerUlf Lamping <ulf.lamping@web.de>2004-07-30 17:10:49 +0000
commit7137202a7b33f53d4bc9a015c5a6c0c57d1c660d (patch)
treeeb878bf2cd534a7ef2423132e38d11b6bdeb0a7a /docbook
parent2599bcad0a022e86b63b07fa6a6e9c51b0a3c46b (diff)
some more review comments from Guy Harris and some other minor changes
svn path=/trunk/; revision=11574
Diffstat (limited to 'docbook')
-rw-r--r--docbook/ug-src/EUG_chapter_advanced.xml9
-rw-r--r--docbook/ug-src/EUG_chapter_build_install.xml10
-rw-r--r--docbook/ug-src/EUG_chapter_capture.xml72
-rw-r--r--docbook/ug-src/EUG_chapter_customize.xml9
-rw-r--r--docbook/ug-src/EUG_chapter_introduction.xml6
-rw-r--r--docbook/ug-src/EUG_chapter_io.xml15
-rw-r--r--docbook/ug-src/EUG_chapter_statistics.xml10
-rw-r--r--docbook/ug-src/EUG_chapter_use.xml6
-rw-r--r--docbook/ug-src/EUG_chapter_work.xml4
-rw-r--r--docbook/user-guide.xml2
10 files changed, 98 insertions, 45 deletions
diff --git a/docbook/ug-src/EUG_chapter_advanced.xml b/docbook/ug-src/EUG_chapter_advanced.xml
index 735480dc16..7c68d87cb9 100644
--- a/docbook/ug-src/EUG_chapter_advanced.xml
+++ b/docbook/ug-src/EUG_chapter_advanced.xml
@@ -232,7 +232,7 @@
</para>
</note>
<para>
- The name resolution feature can be en-/disabled seperately for the
+ The name resolution feature can be en-/disabled separately for the
following protocol layers:
</para>
<section><title>MAC Layer</title>
@@ -254,9 +254,10 @@
<warning>
<title>Warning!</title>
<para>
- Enabling network name resolution when your DNS server is
- unavailable may significantly slow ethereal while it waits
- for all of the DNS requests to time out. Use ADNS in that case.
+ Enabling network name resolution when your name server is
+ unavailable may significantly slow Ethereal while it waits
+ for all of the name server requests to time out. Use ADNS in that
+ case.
</para>
</warning>
</section>
diff --git a/docbook/ug-src/EUG_chapter_build_install.xml b/docbook/ug-src/EUG_chapter_build_install.xml
index 2e6dd3e0ce..56ec529ceb 100644
--- a/docbook/ug-src/EUG_chapter_build_install.xml
+++ b/docbook/ug-src/EUG_chapter_build_install.xml
@@ -20,7 +20,7 @@
</itemizedlist>
</para>
<para>
- Currently, only two or three Linux distributions ship ethereal, and
+ Currently, only two or three Linux distributions ship Ethereal, and
they are commonly shipping an out-of-date version. No other versions
of UNIX ship Ethereal so far, and Microsoft does not ship it with any
version of Windows. For that reason, you will need to know where to
@@ -182,9 +182,9 @@ make install
<example id="Ch2Ex2">
<title>Building and installing libpcap</title>
<programlisting>
-gzip -dc libpcap-0.5.tar.Z | tar xvf -
+gzip -dc libpcap-0.8.3.tar.Z | tar xvf -
&lt;much output removed>
-cd libpcap_0_5rel2
+cd libpcap_0_8_3
./configure
&lt;much output removed>
make
@@ -258,7 +258,7 @@ rpm -ivh libpcap-0.4-19.i386.rpm
</para>
</note>
<para>
- Under Debian you can install ethereal using apt-get. apt-get will
+ Under Debian you can install Ethereal using apt-get. apt-get will
handle any dependency issues for you. <xref linkend="Ch02Ex5"/> shows
how to do this.
<example id="Ch02Ex5">
@@ -314,7 +314,7 @@ tar xvf ethereal-&EtherealCurrentVersionTarFile;-tar
</listitem>
<listitem>
<para>
- Change directory to the ethereal source directory.
+ Change directory to the Ethereal source directory.
</para>
</listitem>
<listitem>
diff --git a/docbook/ug-src/EUG_chapter_capture.xml b/docbook/ug-src/EUG_chapter_capture.xml
index 1f108c2f50..503ffbc906 100644
--- a/docbook/ug-src/EUG_chapter_capture.xml
+++ b/docbook/ug-src/EUG_chapter_capture.xml
@@ -71,8 +71,9 @@ ethereal -i eth0 -k
<varlistentry><term><command>Link-layer header type</command></term>
<listitem>
<para>
- Unless you are in the rare case that you will need this, just keep the default.
- XXX - insert a better explanation here.
+ Unless you are in the rare case that you will need this, just keep
+ the default. For a detailed description, see
+ <xref linkend="ChCapLinkLayerHeader"/>
</para>
</listitem>
</varlistentry>
@@ -127,28 +128,29 @@ ethereal -i eth0 -k
data that will be captured for each packet, and is
sometimes referred to as the <command>snaplen</command>. If disabled,
the default is 65535, which will be sufficient for most
- protocols. The value should be at least the MTU for the interface
- you are capturing on. Some rules of thumb:
+ protocols. Some rules of thumb:
</para>
<itemizedlist>
<listitem>
<para>
- If you are unsure, just keep the default value.
+ If you are unsure, just keep the default value.
</para>
</listitem>
<listitem>
<para>
- You may want to choose a small snapshot length, as it reduces CPU time
- for copying packets, less buffer space is required and perhaps fewer
- packets dropped if traffic is very heavy.
+ If you don't need all of the data in a packet - for example, if you
+ only need the link-layer, IP, and TCP headers - you might want to
+ choose a small snapshot length, as less CPU time is required for
+ copying packets, less buffer space is required for packets, and thus
+ perhaps fewer packets will be dropped if traffic is very heavy.
</para>
</listitem>
<listitem>
<para>
- You may not want a small snapshot length, as you don't get all the
- packet data, the stuff you want might be in the part that's
- dropped or reassembly might not be possible as required data for it
- is missing.
+ If you don't capture all of the data in a packet, you might find that
+ the packet data you want is in the part that's dropped, or that
+ reassembly isn't possible as the data required for reassembly is
+ missing.
</para>
</listitem>
</itemizedlist>
@@ -205,7 +207,7 @@ ethereal -i eth0 -k
<listitem>
<para>
Multiple files only: Switch to the next file, after the given
- number of byte(s)/kilobyte(s)/megabyte(s)/gigabyte(s) were
+ number of byte(s)/kilobyte(s)/megabyte(s)/gigabyte(s) have been
captured.
</para>
</listitem>
@@ -214,7 +216,7 @@ ethereal -i eth0 -k
<listitem>
<para>
Multiple files only: Switch to the next file, after the given
- number of second(s)/minutes(s)/hours(s)/days(s) expired.
+ number of second(s)/minutes(s)/hours(s)/days(s) have elapsed.
</para>
</listitem>
</varlistentry>
@@ -397,7 +399,7 @@ ethereal -i eth0 -k
report context related problems (like a stream error) and keeps information
about context related protocols (e.g. where data is exchanged at the
establishing phase and only referred to in later packets).
- As it keeps these informations only for the loaded file, using one of
+ As it keeps these information only for the loaded file, using one of
the multiple file modes may cut these contexts, If the establishing phase
is saved in one file and the things you would like to see is in another,
you might not see some of the valuable context related information.
@@ -504,12 +506,48 @@ ethereal -i eth0 -k
</varlistentry>
</variablelist>
</section>
-
+
+ <section id="ChCapLinkLayerHeader"><title>Link-layer header type</title>
+ <para>
+ In the usual case, you won't have to choose this link-layer header type.
+ The following paragraphs will describe the exceptional cases, where
+ selecting this type is possible, so you will have a guide what to do:
+ </para>
+ <para>
+ If you are capturing on an 802.11 device on some versions of BSD, this
+ might offer a choice of "Ethernet" or "802.11". "Ethernet" will cause
+ the captured packets to have fake Ethernet headers; "802.11" will cause
+ them to have IEEE 802.11 headers. Unless the capture needs to be read by
+ an application that doesn't support 802.11 headers, you should select
+ "802.11".
+ </para>
+ <para>
+ If you are capturing on an Endace DAG card connected to a synchronous
+ serial line, this might offer a choice of "PPP over serial" or
+ "Cisco HDLC"; if the protocol on the serial line is PPP, select
+ "PPP over serial", and if the protocol on the serial line is Cisco HDLC,
+ select "Cisco HDLC".
+ </para>
+ <para>
+ If you are capturing on an Endace DAG card connected to an ATM network,
+ this might offer a choide of "RFC 1483 IP-over-ATM" or "Sun raw ATM".
+ If the only traffic being captured is RFC 1483 LLC-encapsulated IP, or if
+ the capture needs to be read by an application that doesn't support SunATM
+ headers, select "RFC 1483 IP-over-ATM", otherwise select "Sun raw ATM".
+ </para>
+ <para>
+ If you are capturing on an Ethernet device, this might offer a choice of
+ "Ethernet" or "DOCSIS". If you are capturing traffic from a Cisco Cable
+ Modem Termination System that is putting DOCSIS traffic onto the Ethernet
+ to be captured, select "DOCSIS", otherwise select "Ethernet".
+ </para>
+ </section>
+
<section id="ChCapCaptureFilterSection"><title>Filtering while capturing</title>
<para>
Ethereal uses the libpcap filter language for capture filters.
This is explained in the tcpdump man page, which can be hard to
- understand, so it's explained here to some extend.
+ understand, so it's explained here to some extent.
</para>
<para>
You enter the capture filter into the Filter field of the Ethereal
diff --git a/docbook/ug-src/EUG_chapter_customize.xml b/docbook/ug-src/EUG_chapter_customize.xml
index f1bcc33747..0d752f7603 100644
--- a/docbook/ug-src/EUG_chapter_customize.xml
+++ b/docbook/ug-src/EUG_chapter_customize.xml
@@ -500,7 +500,7 @@ ethereal [ -vh ] [ -klLnpQS ] [ -a &lt;capture autostop condition> ] ...
dissected.
</para>
<para>
- Each protocol has it's own dissector, so dissecting a packet will
+ Each protocol has its own dissector, so dissecting a packet will
typically involve several dissectors. As Ethereal tries to find the
right dissector for each packet (using static "routes" and heuristics
"guessing"), it might choose the wrong dissector in your specific
@@ -751,6 +751,13 @@ ethereal [ -vh ] [ -klLnpQS ] [ -a &lt;capture autostop condition> ] ...
This page allows you to select which columns appear in the
"Packet List" Pane.
</para>
+ <note><title>Note!</title>
+ <para>
+ Unlike all other preference changes, you will have to save the
+ preferences and restart Ethereal in order to take column changes to
+ take effect!
+ </para>
+ </note>
</section>
<section><title>The "User Interface: Font" page</title>
diff --git a/docbook/ug-src/EUG_chapter_introduction.xml b/docbook/ug-src/EUG_chapter_introduction.xml
index b3961fd771..4393ae6105 100644
--- a/docbook/ug-src/EUG_chapter_introduction.xml
+++ b/docbook/ug-src/EUG_chapter_introduction.xml
@@ -112,7 +112,7 @@
<section>
<title>Live capture from many different network media</title>
<para>
- Unlike it's name suggests, Ethereal can capture traffic from
+ Unlike its name suggests, Ethereal can capture traffic from
some other network media than Ethernet too. Which media types are
supported, depends on many things like the operating system you are
using. An overview of the supported media types can be found at:
@@ -268,7 +268,7 @@
</para>
<para>
You are welcome to call it what you like, as long as you find it
- useful, the FAQ gives the official pronounciation as "e-the-real".
+ useful. The FAQ gives the official pronounciation as "e-the-real".
</para>
</section>
@@ -497,7 +497,7 @@
<section><title>Reporting Crashes on UNIX/Linux platforms</title>
<para>
When reporting crashes with Ethereal, it is helpful if you supply the
- traceback information (beside the informations mentioned in "Reporting
+ traceback information (beside the information mentioned in "Reporting
Problems").
</para>
<para>
diff --git a/docbook/ug-src/EUG_chapter_io.xml b/docbook/ug-src/EUG_chapter_io.xml
index a1d7cd622f..8b38af0f2e 100644
--- a/docbook/ug-src/EUG_chapter_io.xml
+++ b/docbook/ug-src/EUG_chapter_io.xml
@@ -73,7 +73,7 @@
Ethereal uses the open dialog box from the version of the GTK+
toolkit that it's using. This dialog was completely redesigned in
the GTK version 2.4. Depending on the installed GTK version,
- your dialog box might be looking different. However, as the
+ your dialog box might look different. However, as the
functionality remains almost the same, much of this description
will work with your version of Ethereal.
</para>
@@ -184,7 +184,7 @@
</para>
<note><title>Note!</title>
<para>
- It may not be possible to read some formats dependant on the packet types
+ It may not be possible to read some formats dependent on the packet types
captured. Ethernet captures are usually supported for most file formats,
but other packet types (e.g. token ring packets) may not be possible to
read from all file formats.
@@ -215,7 +215,7 @@
Ethereal uses the open dialog box from the version of the GTK+
toolkit that it's using. This dialog was completely redesigned in
the GTK version 2.4. Depending on the installed GTK version,
- your dialog box might be looking different. However, as the
+ your dialog box might look different. However, as the
functionality remains almost the same, much of this description
will work with your version of Ethereal.
</para>
@@ -439,6 +439,13 @@
<para>
Export packet data into PostScript, much like the format used
to print packets.
+ <tip><title>Tip!</title>
+ <para>
+ You can easily convert PostScript files to PDF files using ghostscript.
+ For example: export to a file named foo.ps and then call:
+ <command>ps2pdf foo.ps</command>
+ </para>
+ </tip>
<figure>
<title>The "Export as PostScript File" dialog box</title>
<graphic entityref="EtherealExportPSDialog" format="PNG"/>
@@ -703,7 +710,7 @@ lpr -Pmypostscript
<listitem>
<para>
<command>Packet summary line</command> enable the output of the
- summary line, just like in the "Packet List" pane.
+ summary line, just as in the "Packet List" pane.
</para>
</listitem>
<listitem>
diff --git a/docbook/ug-src/EUG_chapter_statistics.xml b/docbook/ug-src/EUG_chapter_statistics.xml
index 615d75948e..99215b37da 100644
--- a/docbook/ug-src/EUG_chapter_statistics.xml
+++ b/docbook/ug-src/EUG_chapter_statistics.xml
@@ -179,7 +179,7 @@
</para>
<section id="ChStatEndpointDefinition"><title>What is an Endpoint?</title>
<para>
- A network endpoint is the logical endpoint of seperate protocol traffic of
+ A network endpoint is the logical endpoint of separate protocol traffic of
a specific protocol layer. The endpoint statistics of Ethereal will take
the following endpoints into account:
</para>
@@ -280,8 +280,8 @@
<title>The protocol specific "Endpoint List" windows</title>
<para>
Before the combined window described above was available, each of its
- pages were shown as seperate windows. Even as the combined window is
- much more convenient to use, these seperate windows are still
+ pages were shown as separate windows. Even as the combined window is
+ much more convenient to use, these separate windows are still
available. The main reason is, they might process faster for
very large capture files. However, as the functionality is exactly the
same as in the combined window, they won't be discussed in detail here.
@@ -316,8 +316,8 @@
<title>The protocol specific "Conversation List" windows</title>
<para>
Before the combined window described above was available, each of its
- pages were shown as seperate windows. Even as the combined window is
- much more convenient to use, these seperate windows are still
+ pages were shown as separate windows. Even as the combined window is
+ much more convenient to use, these separate windows are still
available. The main reason is, they might process faster for
very large capture files. However, as the functionality is exactly the
same as in the combined window, they won't be discussed in detail here.
diff --git a/docbook/ug-src/EUG_chapter_use.xml b/docbook/ug-src/EUG_chapter_use.xml
index db1a9b9b79..24502add9b 100644
--- a/docbook/ug-src/EUG_chapter_use.xml
+++ b/docbook/ug-src/EUG_chapter_use.xml
@@ -1114,7 +1114,7 @@
<entry><command>Endpoint List</command></entry>
<entry></entry>
<entry><para>
- Display a list of endpoints, obsoleted be the combined window
+ Display a list of endpoints, obsoleted by the combined window
of Endpoints above, see
<xref linkend="ChStatEndpointListWindow"/>.
</para></entry>
@@ -1628,7 +1628,7 @@
the "Packet Details" and "Packet Bytes" panes.
</para>
<para>
- While dissecting a packet, Ethereal will place informations from the
+ While dissecting a packet, Ethereal will place information from the
protocol dissectors into the columns. As higher level protocols might
overwrite information from lower levels, you will typically see the
information from the highest possible level only.
@@ -1636,7 +1636,7 @@
<para>
For example, let's look at a packet containing TCP inside IP inside
an Ethernet packet. The Ethernet dissector will write its data (like the
- Ethernet addresses), the IP dissector will overwrite this by it's own
+ Ethernet addresses), the IP dissector will overwrite this by its own
(like the IP addresses), the TCP dissector will overwrite the IP
information and so on.
</para>
diff --git a/docbook/ug-src/EUG_chapter_work.xml b/docbook/ug-src/EUG_chapter_work.xml
index 305dd27c8a..2ba663ab2d 100644
--- a/docbook/ug-src/EUG_chapter_work.xml
+++ b/docbook/ug-src/EUG_chapter_work.xml
@@ -530,7 +530,7 @@
<note>
<title>Note!</title>
<para>
- All filter expressions are entered in lowercase. Also, don't
+ All protocol and field names are entered in lowercase. Also, don't
forget to press enter after entering the filter expression.
</para>
</note>
@@ -863,7 +863,7 @@ eth.src[1-2] == 00:83
<para>
Then they use <command>ip.addr != 1.2.3.4</command> to see all packets
not containing the IP address 1.2.3.4 in it. Unfortunately, this does
- *not* do the expected.
+ <command>not</command> do the expected.
</para>
<para>
Instead, that expression will even be true for packets where either
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml
index 056a6e3133..622e491b7f 100644
--- a/docbook/user-guide.xml
+++ b/docbook/user-guide.xml
@@ -60,7 +60,7 @@ DOCUMENT SECTION
<!ENTITY DocumentCopyrightYear "2004">
<!ENTITY DocumentEdition "Third ">
- <!ENTITY DocumentVersion "V1.91">
+ <!ENTITY DocumentVersion "V1.92">
<!ENTITY DocumentPubDate "2004">
<!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">