aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/ug-src
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2004-08-03 05:21:35 +0000
committerUlf Lamping <ulf.lamping@web.de>2004-08-03 05:21:35 +0000
commit72fb3f47228acf7e076dc2a8375b17744d0f4518 (patch)
treedca84bb9224b910328f772f8ad9832affcdd6727 /docbook/ug-src
parent07658bc75c0478e4f62d7ccc3e9414ba69a7e37d (diff)
first and second part of Graeme Hewsons review comments
svn path=/trunk/; revision=11595
Diffstat (limited to 'docbook/ug-src')
-rw-r--r--docbook/ug-src/EUG_chapter_introduction.xml41
-rw-r--r--docbook/ug-src/EUG_chapter_use.xml98
-rw-r--r--docbook/ug-src/EUG_preface.xml6
3 files changed, 74 insertions, 71 deletions
diff --git a/docbook/ug-src/EUG_chapter_introduction.xml b/docbook/ug-src/EUG_chapter_introduction.xml
index 4393ae6105..a740e2e5c3 100644
--- a/docbook/ug-src/EUG_chapter_introduction.xml
+++ b/docbook/ug-src/EUG_chapter_introduction.xml
@@ -112,8 +112,8 @@
<section>
<title>Live capture from many different network media</title>
<para>
- Unlike its name suggests, Ethereal can capture traffic from
- some other network media than Ethernet too. Which media types are
+ Despite its name, Ethereal can capture traffic from
+ network media other than Ethernet. 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:
<ulink url="&EtherealMediaPage;"/>.
@@ -123,14 +123,14 @@
<section><title>Import files from many other capture programs</title>
<para>
Ethereal can open packets captured from a large number of
- other capture programs, for a list of input formats see
+ other capture programs. For a list of input formats see
<xref linkend="ChIOInputFormatsSection"/>.
</para>
</section>
<section><title>Export files for many other capture programs</title>
<para>
Ethereal can save packets captured in a large number of formats of
- other capture programs, for a list of output formats see
+ other capture programs. For a list of output formats see
<xref linkend="ChIOOutputFormatsSection"/>.
</para>
</section>
@@ -139,7 +139,7 @@
<title>Many protocol decoders</title>
<para>
There are protocol decoders (or dissectors, as they are
- known in Ethereal) for a great many protocols,
+ known in Ethereal) for a great many protocols:
see <xref linkend="AppProtocols"/>.
</para>
</section>
@@ -169,7 +169,7 @@
<listitem><para>
Ethereal will not manipulate things on the network, it will only
"measure" things from it. Ethereal doesn't send packets on the network
- or doing other active things (except for name resolutions, but even
+ or do other active things (except for name resolutions, but even
that can be disabled).
</para></listitem>
</itemizedlist>
@@ -296,13 +296,13 @@
</para>
<para>
In late 1998, Richard Sharpe, who was giving TCP/IP courses, saw its
- potential on such courses, started looking at it to see if it
+ potential on such courses, and started looking at it to see if it
supported the protocols he needed. While it didn't at that point,
new protocols could be easily added. So he started contributing
dissectors and contributing patches.
</para>
<para>
- The list of people who have contributed to Ethereal became very long
+ The list of people who have contributed to Ethereal has become very long
since then, and almost all of them started with a protocol that they
needed that Ethereal did not already handle. So they copied an existing
dissector and contributed the code back to the team.
@@ -385,13 +385,13 @@
the corresponding answers.
<note><title>Read the FAQ!</title>
<para>
- Before sending any mails to the mailing lists below, be sure to read the
+ Before sending any mail to the mailing lists below, be sure to read the
FAQ, as it will often answer the question(s) you might have. This will save
- yourself and others a lot of time (keep in mind, that a lot of people are
+ yourself and others a lot of time (keep in mind that a lot of people are
subscribed to the mailing lists).
</para>
</note>
- You will find the FAQ inside Ethereal, by clicking the menu item
+ You will find the FAQ inside Ethereal by clicking the menu item
Help/Contents and selecting the FAQ page in the upcoming dialog.
</para>
<para>
@@ -439,9 +439,9 @@
as well.
<tip><title>Tip!</title>
<para>
- You can search in the list archives, if someone asked the same question
- some time before and maybe already got an answer. That way you don't have
- to wait until someone answers your question.
+ You can search in the list archives to see if someone asked the same
+ question some time before and maybe already got an answer. That way you
+ don't have to wait until someone answers your question.
</para>
</tip>
</para>
@@ -450,8 +450,8 @@
<section><title>Reporting Problems</title>
<note><title>Note!</title>
<para>
- Before reporting any problems, make sure you have installed the latest
- version of Ethereal.
+ Before reporting any problems, please make sure you have installed the
+ latest version of Ethereal.
</para>
</note>
<para>
@@ -481,7 +481,7 @@
<para>
Do not send large files (>100KB) to the mailing lists, just place a note
that further data is available on request. Large files will only annoy a
- lot of people on the list which are not related to your specific problem.
+ lot of people on the list who are not interested in your specific problem.
If required, you will be asked for further data by the persons who really
can help you.
</para>
@@ -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 information mentioned in "Reporting
+ traceback information (besides the information mentioned in "Reporting
Problems").
</para>
<para>
@@ -519,7 +519,8 @@ $
<note>
<para>
backtrace is a <command>gdb</command> command. You should
- enter it verbatim after the first line shown above. The ^D
+ enter it verbatim after the first line shown above, it will not be
+ echoed. The ^D
(Control-D, that is, press the Control key and the D key
together) will cause <command>gdb</command> to exit. This will
leave you with a file called
@@ -544,7 +545,7 @@ $
<section><title>Reporting Crashes on Windows platforms</title>
<para>
The Windows distributions don't contain the symbol files (.pdb), because
- they are very large. So it's not possible to create
+ they are very large. For this reason it's not possible to create
a meaningful backtrace file from it. You should report your crash just
like other problems, using the mechanism described above.
</para>
diff --git a/docbook/ug-src/EUG_chapter_use.xml b/docbook/ug-src/EUG_chapter_use.xml
index 24502add9b..976076a1e0 100644
--- a/docbook/ug-src/EUG_chapter_use.xml
+++ b/docbook/ug-src/EUG_chapter_use.xml
@@ -41,8 +41,8 @@
You can start Ethereal from your shell or window manager.
<tip><title>Tip!</title>
<para>
- When starting Ethereal it's possible to specify optional settings, using
- the command line, see <xref linkend="ChCustCommandLine"/> for details.
+ When starting Ethereal it's possible to specify optional settings using
+ the command line. See <xref linkend="ChCustCommandLine"/> for details.
</para>
</tip>
<note><title>Note!</title>
@@ -50,9 +50,9 @@
In the following chapters, a lot of screenshots from Ethereal will be shown.
As Ethereal runs on many different platforms and there are different
versions of the underlying GUI toolkit (GTK 1.x / 2.x) used, your
- screen might look different than the provided screenshots. But as there
- are no real differences in functionality, this screenshots should still
- be well understandable.
+ screen might look different from the provided screenshots. But as there
+ are no real differences in functionality, these screenshots should still
+ be understandable.
</para>
</note>
</para>
@@ -121,8 +121,8 @@
</orderedlist>
<tip><title>Tip!</title>
<para>
- The layout of the main window can be customized by changing preference settings,
- see <xref linkend="ChCustGUILayoutPrefPage"/>!
+ The layout of the main window can be customized by changing preference settings.
+ See <xref linkend="ChCustGUILayoutPrefPage"/> for details!
</para>
</tip>
</para>
@@ -135,9 +135,9 @@
</para>
<note><title>Note!</title>
<para>
- Menu items will be greyed out, if the corresponding feature isn't
+ Menu items will be greyed out if the corresponding feature isn't
available. For example, you cannot save a capture file if you didn't
- captured/loaded any data before.
+ capture or load any data before.
</para>
</note>
<para>
@@ -221,7 +221,7 @@
</listitem>
</varlistentry>
</variablelist>
- Each of these menu items are described in more detail in the sections
+ Each of these menu items is described in more detail in the sections
that follow.
</para>
<tip><title>Tip!</title>
@@ -229,7 +229,7 @@
You can access menu items directly or by pressing the corresponding
accelerator keys, which are shown at the right side of the
menu. For example, you can press the Control (or Strg in german) and the K
- keys together, to open the capture dialog.
+ keys together to open the capture dialog.
</para>
</tip>
</section>
@@ -269,7 +269,7 @@
<entry></entry>
<entry><para>
This menu item shows a submenu containing the recently opened
- capture files. Clicking on one of the submenu items, will open the
+ capture files. Clicking on one of the submenu items will open the
corresponding capture file directly.
</para></entry>
</row>
@@ -287,7 +287,8 @@
<entry>Ctrl+W</entry>
<entry><para>
This menu item closes the current capture. If you
- haven't saved the capture, you will be asked to do so first.
+ haven't saved the capture, you will be asked to do so first
+ (this can be disabled by a preference setting).
</para></entry>
</row>
<row>
@@ -338,7 +339,7 @@
<entry><command>Export > as "Plain Text" file...</command></entry>
<entry></entry>
<entry><para>
- This menu item allows you to export the (or some) of the packets in
+ This menu item allows you to export all, or some, of the packets in
the capture file to a plain ASCII text file.
It pops up the Ethereal Export dialog box (which is discussed further in
<xref linkend="ChIOExportPlainDialog"/>).
@@ -379,7 +380,7 @@
<entry>Ctrl+H</entry>
<entry><para>
This menu item allows you to export the currently selected bytes
- in the packet bytes pane into a binary file. It pops up the
+ in the packet bytes pane to a binary file. It pops up the
Ethereal Export dialog box (which is discussed further in
<xref linkend="ChIOExportSelectedDialog"/>)
</para></entry>
@@ -409,8 +410,8 @@
<entry>Ctrl+Q</entry>
<entry><para>
This menu item allows you to quit from Ethereal.
- Ethereal will ask to save your capture file, if you haven't saved
- it before.
+ Ethereal will ask to save your capture file if you haven't saved
+ it before (this can be disabled by a preference setting).
</para></entry>
</row>
</tbody>
@@ -454,7 +455,7 @@
<entry><command>Find Next</command></entry>
<entry>Ctrl+N</entry>
<entry><para>
- This menu item tries to find the next packet, matching the
+ This menu item tries to find the next packet matching the
settings from "Find Packet...".
</para></entry>
</row>
@@ -462,7 +463,7 @@
<entry><command>Find Previous</command></entry>
<entry>Ctrl+B</entry>
<entry><para>
- This menu item tries to find the previous packet, matching the
+ This menu item tries to find the previous packet matching the
settings from "Find Packet...".
</para></entry>
</row>
@@ -498,8 +499,8 @@
<entry><command>Mark Packet</command></entry>
<entry>Ctrl+M</entry>
<entry><para>
- This menu item "marks" the currently selected packet, see
- <xref linkend="ChWorkMarkPacketSection"/>.
+ This menu item "marks" the currently selected packet. See
+ <xref linkend="ChWorkMarkPacketSection"/> for details.
</para></entry>
</row>
<row>
@@ -774,7 +775,7 @@
<entry></entry>
<entry><para>
This menu item brings up a dialog box that allows you
- color packets in the packet list pane according to
+ to color packets in the packet list pane according to
filter expressions you choose. It can be very useful
for spotting certain types of packets, see
<xref linkend="ChCustColorizationSection"/>.
@@ -834,8 +835,8 @@
<entry>Ctrl-G</entry>
<entry><para>
This menu item brings up a dialog box that allows you
- to specify a packet to go to the given packet number, see
- <xref linkend="ChWorkGoToPacketSection"/>
+ to specify a packet number, and then goes to that packet. See
+ <xref linkend="ChWorkGoToPacketSection"/> for details.
</para></entry>
</row>
<row>
@@ -965,8 +966,8 @@
<entry><para>
These menu items will change the current display filter and apply
the changed filter immediately. Depending on the chosen menu item,
- the current display filter string will be replaced or appended by
- the selected protocol field in the packet details pane.
+ the current display filter string will be replaced or appended to
+ by the selected protocol field in the packet details pane.
</para></entry>
</row>
<row>
@@ -975,8 +976,8 @@
<entry><para>
These menu items will change the current display filter but won't
apply the changed filter. Depending on the chosen menu item,
- the current display filter string will be replaced or appended by
- the selected protocol field in the packet details pane.
+ the current display filter string will be replaced or appended to
+ by the selected protocol field in the packet details pane.
</para></entry>
</row>
<row>
@@ -1278,9 +1279,9 @@
more packet data.
</para>
<para>
- Like in the menu, only the items useful in the current program state will
- be available, the others will be greyed out (e.g. you cannot save a capture
- file, if you haven't loaded one).
+ As in the menu, only the items useful in the current program state will
+ be available. The others will be greyed out (e.g. you cannot save a capture
+ file if you haven't loaded one).
<figure id="ChUseEtherealMainToolbar">
<title>The "Main" toolbar</title>
<graphic entityref="EtherealMainToolbar" format="PNG"/>
@@ -1330,7 +1331,7 @@
</para>
<note><title>Note!</title>
<para>
- This icon is shown, if a live capture is in progress, and you are
+ This icon is shown if a live capture is in progress, and you are
using "Update List of Packets in Realtime", otherwise the Start
Capture icon
<inlinegraphic entityref="EtherealToolbarCapture" format="PNG"/>
@@ -1568,11 +1569,12 @@
<para>
The left middle text box provides an area to enter or edit display
filter strings, see <xref linkend="ChWorkBuildDisplayFilterSection"/>
- . A syntax check of your filter string is done while
- you are typing. The background of an invalid string will become red,
- and for a valid one it will become green. You can click on the pull
- down arrow to select past filter string from a list. The entries in
- the pull down list will remain available even after a program restart.
+ . A syntax check of your filter string is done while you are typing.
+ The background will turn red if you enter an incomplete or invalid
+ string, and will become green when you enter a valid string. You can
+ click on the pull down arrow to select a previously-entered filter
+ string from a list. The entries in the pull down list will remain
+ available even after a program restart.
</para>
<note><title>Note!</title>
<para>
@@ -1589,7 +1591,7 @@
</listitem>
<listitem>
<para>
- The middle button labeled "Add Expression..." opens a dialog box that let's
+ The middle button labeled "Add Expression..." opens a dialog box that lets
you edit a display filter from a list of protocol fields, described in
<xref linkend="ChWorkFilterAddExpressionSection"/>
</para>
@@ -1638,7 +1640,7 @@
an Ethernet packet. The Ethernet dissector will write its data (like the
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.
+ information, and so on.
</para>
<para>
There are a lot of different columns available. Which columns are
@@ -1662,17 +1664,17 @@
</listitem>
<listitem>
<para><command>Source</command>
- The source address where this packet is coming from.
+ The address where this packet is coming from.
</para>
</listitem>
<listitem>
<para><command>Destination</command>
- The destination address where this packet is going to.
+ The address where this packet is going to.
</para>
</listitem>
<listitem>
<para><command>Protocol</command>
- The protocol name in a short (maybe abbreviated) version.
+ The protocol name in a short (perhaps abbreviated) version.
</para>
</listitem>
<listitem>
@@ -1691,7 +1693,7 @@
<section id="ChUsePacketDetailsPaneSection"><title>The "Packet Details" pane</title>
<para>
The packet details pane shows the current packet (selected in the "Packet List"
- pane) more detailed.
+ pane) in a more detailed form.
<figure id="ChUseEtherealDetailsPane">
<title>The "Packet Details" pane</title>
<graphic entityref="EtherealDetailsPane" format="PNG"/>
@@ -1714,7 +1716,7 @@
<para>
<command>Generated fields</command>
Ethereal itself will generate additional protocol fields which are
- surrounded by brackets. The info of these fields are derived from the
+ surrounded by brackets. The information in these fields is derived from the
known context to other packets in the capture file. For example, Ethereal
is doing a sequence/acknowledge analysis of each TCP stream,
which is displayed in the [SEQ/ACK analysis] fields of the TCP protocol.
@@ -1742,7 +1744,7 @@
</para>
<para>
As usual for a hexdump, the left side shows the offset in the packet data,
- in the middle the packet data in a hexadecimal representation is shown and
+ in the middle the packet data is shown in a hexadecimal representation and
on the right the corresponding ASCII characters (or . if not appropriate)
are displayed.
</para>
@@ -1754,7 +1756,7 @@
Depending on the packet data, sometimes more than one page is available,
e.g. when Ethereal has reassembled some packets into a single chunk of
data, see <xref linkend="ChAdvReassemblySection"/>. In this case there are
- some additional tabs shown at the bottom of the pane, to let you select
+ some additional tabs shown at the bottom of the pane to let you select
the page you want to see.
<figure id="ChUseEtherealBytesPaneTabs">
<title>The "Packet Bytes" pane with tabs</title>
@@ -1768,7 +1770,7 @@
</note>
<para>
The context menu (right mouse click) of the tab labels will show a list of
- all available pages. This can be helpful, if the size in the pane is too
+ all available pages. This can be helpful if the size in the pane is too
small for all the tab labels.
</para>
</section>
@@ -1795,7 +1797,7 @@
<graphic entityref="EtherealStatusbarLoaded" format="PNG"/>
</figure>
The left side shows information about the capture file, its
- name, its size and the elapsed time while it was captured.
+ name, its size and the elapsed time while it was being captured.
</para>
<para>
The right side shows the current number of packets in the
diff --git a/docbook/ug-src/EUG_preface.xml b/docbook/ug-src/EUG_preface.xml
index 786a962385..85ab480868 100644
--- a/docbook/ug-src/EUG_preface.xml
+++ b/docbook/ug-src/EUG_preface.xml
@@ -8,7 +8,7 @@
would like from Ethereal because of the lack of documentation.
</para>
<para>
- This document is part of an effort of the Ethereal team to improve the
+ This document is part of an effort by the Ethereal team to improve the
usability of Ethereal.
</para>
<para>
@@ -23,7 +23,7 @@
</para>
<para>
This book will explain all the basics and also some of the advanced features
- that Ethereal provides. As Ethereal is becoming a very complex program since
+ that Ethereal provides. As Ethereal has become a very complex program since
the early days, not every feature of Ethereal might be explained in this
book.
</para>
@@ -35,7 +35,7 @@
<para>
By reading this book, you will learn how to install Ethereal, how to use the
basic elements of the graphical user interface (like the menu) and what's
- behind some of the advanced features that's maybe not that obvious at first
+ behind some of the advanced features that are maybe not that obvious at first
sight. It will
hopefully guide you around some common problems that frequently appears for
new (and sometimes even advanced) users of Ethereal.