aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2006-04-21 00:44:40 +0000
committerUlf Lamping <ulf.lamping@web.de>2006-04-21 00:44:40 +0000
commitc717489c7289f389503ecd5ad5cbdb56d0761630 (patch)
tree69d2fd0641c7f4fe39f9bceb5b009c607b8e5a11
parentada5c36ff33b627c06cffceaa0df74b7903ec11c (diff)
enhance the "File Sets" page (e.g. add a screenshot)
svn path=/trunk/; revision=17940
-rw-r--r--docbook/Makefile1
-rw-r--r--docbook/eug_src/EUG_chapter_io.xml58
-rw-r--r--docbook/graphics/ethereal-file-set-dialog.pngbin0 -> 24093 bytes
-rw-r--r--docbook/user-guide.xml1
4 files changed, 40 insertions, 20 deletions
diff --git a/docbook/Makefile b/docbook/Makefile
index f9d5b7b70c..1d03d267cb 100644
--- a/docbook/Makefile
+++ b/docbook/Makefile
@@ -89,6 +89,7 @@ EUG_GRAPHICS = \
graphics/ethereal-export-psml.png \
graphics/ethereal-export-selected.png \
graphics/ethereal-file-menu.png \
+ graphics/ethereal-file-set-dialog.png \
graphics/ethereal-filter-add-expression.png \
graphics/ethereal-filter-toolbar.png \
graphics/ethereal-filters-2.png \
diff --git a/docbook/eug_src/EUG_chapter_io.xml b/docbook/eug_src/EUG_chapter_io.xml
index 9533f7d4a1..26b32fa0c7 100644
--- a/docbook/eug_src/EUG_chapter_io.xml
+++ b/docbook/eug_src/EUG_chapter_io.xml
@@ -403,16 +403,37 @@
<section id="ChIOFileSetSection"><title>File Sets</title>
<para>
- When using the "Multiple Files" option while doing a capture,
+ When using the "Multiple Files" option while doing a capture
+ (see: <xref linkend="ChCapCaptureFiles"/>),
the capture data is spreaded over several capture files, called a file
- set. Ethereal tries to find the files matching the same filename pattern
- than the currently loaded file. This will only work, if all the files
- of the file set are located in the same directory.
+ set.
</para>
<para>
As it can become tedious to work with a file set by hand, Ethereal
- provides some features in the "File" menu to handle these file sets in
- a more convenient way:
+ provides some features to handle these file sets in a convenient way.
+ </para>
+ <sidebar><title>How does Ethereal detect the files of a file set?</title>
+ <para>
+ A filename in a file set uses the format Prefix_Number_DateTimeSuffix
+ which might look like this: "test_00001_20060420183910.pcap".
+ All files of a file set share the same prefix (e.g. "test") and suffix
+ (e.g. ".pcap") and a varying middle part.
+ </para>
+ <para>
+ To find the files of a file set, Ethereal scans the directory where the
+ currently loaded file resides and scans for files matching the same filename
+ pattern (prefix and suffix) than the currently loaded file.
+ </para>
+ <para>
+ This simple mechanism usually works well, but has it's drawbacks. If several
+ file sets were captured with the same prefix and suffix, Ethereal will detect
+ them as a single file set. If files were renamed or spreaded over several
+ directories the mechanism will fail to find all files of a set.
+ </para>
+ </sidebar>
+ <para>
+ The following features in the "File Set" submenu of the "File" menu are
+ available to work with file sets in a convenient way:
</para>
<itemizedlist>
<listitem><para>
@@ -420,28 +441,27 @@
Ethereal has recognized as being part of the current file set.
</para></listitem>
<listitem><para>
- <command>Next File</command> opens the next file in the file set.
+ <command>Next File</command> closes the current and opens the next
+ file in the file set.
</para></listitem>
<listitem><para>
- <command>Previous File</command> opens the previous file in
- the file set.
+ <command>Previous File</command> closes the current and opens the
+ previous file in the file set.
</para></listitem>
</itemizedlist>
- <para>
- XXX - add icons from the menu
- </para>
<section id="ChIOFileSetListDialog">
<title>The "List Files" dialog box</title>
- <!--<figure>
+ <figure>
<title>The "List Files" dialog box</title>
- <graphic entityref="EtherealExportPlainDialog" format="PNG"/>
- </figure>-->
- <para>XXX - add screenshot</para>
+ <graphic entityref="EtherealFileSetDialog" format="PNG"/>
+ </figure>
<para>
Each line contains information about a file of the file set:
<itemizedlist>
<listitem><para>
- <command>Filename</command> the name of the file
+ <command>Filename</command> the name of the file. If you click on
+ the filename (or the radio button left to it), the current file will
+ be closed and the corresponding capture file will be opened.
</para></listitem>
<listitem><para>
<command>Created</command> the creation time of the file
@@ -461,9 +481,7 @@
opened/closed.
</para>
<para>
- If you click on the radio button to the left of the line, the
- corresponding capture file will be opened. The Close button will, well,
- close the dialog box.
+ The Close button will, well, close the dialog box.
</para>
</section>
</section>
diff --git a/docbook/graphics/ethereal-file-set-dialog.png b/docbook/graphics/ethereal-file-set-dialog.png
new file mode 100644
index 0000000000..27123c6fa0
--- /dev/null
+++ b/docbook/graphics/ethereal-file-set-dialog.png
Binary files differ
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml
index c8e455b823..75993ee564 100644
--- a/docbook/user-guide.xml
+++ b/docbook/user-guide.xml
@@ -195,6 +195,7 @@ FILE SECTION
<!ENTITY EtherealEnabledProtocols SYSTEM "./graphics/ethereal-enabled-protocols.png" NDATA PNG>
<!ENTITY EtherealDecodeAs SYSTEM "./graphics/ethereal-decode-as.png" NDATA PNG>
<!ENTITY EtherealDecodeAsShow SYSTEM "./graphics/ethereal-decode-as-show.png" NDATA PNG>
+ <!ENTITY EtherealFileSetDialog SYSTEM "./graphics/ethereal-file-set-dialog.png" NDATA PNG>
<!-- Third Chapter Toolbar-->
<!ENTITY EtherealToolbarCaptureInterfaces SYSTEM "./graphics/toolbar/capture_interfaces_24.png" NDATA PNG>