summaryrefslogtreecommitdiff
path: root/docbook
diff options
context:
space:
mode:
authorStig Bjørlykke <stig@bjorlykke.org>2008-06-21 13:08:02 +0000
committerStig Bjørlykke <stig@bjorlykke.org>2008-06-21 13:08:02 +0000
commit960d9138af26399091de315d0b030d0d91d330d7 (patch)
treeb2e76f0236e32858a78ca1b2e45eb2441fe9b76e /docbook
parent7ed148d6ec77ea81390dc9270797d0c43ecea968 (diff)
downloadwireshark-960d9138af26399091de315d0b030d0d91d330d7.tar.gz
Added a help button in the Interface Options dialog.
Added the Interface Options docbook chapter. svn path=/trunk/; revision=25502
Diffstat (limited to 'docbook')
-rw-r--r--docbook/user-guide.xml1
-rw-r--r--docbook/wsug_graphics/ws-gui-interface-options.pngbin0 -> 32900 bytes
-rw-r--r--docbook/wsug_src/WSUG_chapter_customize.xml39
3 files changed, 40 insertions, 0 deletions
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml
index d8cc810a17..05368e7963 100644
--- a/docbook/user-guide.xml
+++ b/docbook/user-guide.xml
@@ -173,6 +173,7 @@ FILE SECTION
<!ENTITY WiresharkFindPacket SYSTEM "./wsug_graphics/ws-find-packet.png" NDATA PNG>
<!ENTITY WiresharkGoToPacket SYSTEM "./wsug_graphics/ws-goto-packet.png" NDATA PNG>
<!ENTITY WiresharkGUIPreferences SYSTEM "./wsug_graphics/ws-gui-preferences.png" NDATA PNG>
+ <!ENTITY WiresharkGUIInterfaceOptions SYSTEM "./wsug_graphics/ws-gui-interface-options.png" NDATA PNG>
<!ENTITY WiresharkGUILayoutPreferences SYSTEM "./wsug_graphics/ws-gui-layout-preferences.png" NDATA PNG>
<!ENTITY WiresharkGUIColumnsPreferences SYSTEM "./wsug_graphics/ws-gui-columns-preferences.png" NDATA PNG>
<!ENTITY WiresharkGUIFontPreferences SYSTEM "./wsug_graphics/ws-gui-font-preferences.png" NDATA PNG>
diff --git a/docbook/wsug_graphics/ws-gui-interface-options.png b/docbook/wsug_graphics/ws-gui-interface-options.png
new file mode 100644
index 0000000000..8d00029e6b
--- /dev/null
+++ b/docbook/wsug_graphics/ws-gui-interface-options.png
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_customize.xml b/docbook/wsug_src/WSUG_chapter_customize.xml
index 5304693657..8da8030568 100644
--- a/docbook/wsug_src/WSUG_chapter_customize.xml
+++ b/docbook/wsug_src/WSUG_chapter_customize.xml
@@ -940,7 +940,46 @@ standard libpcap format.
<title>The preferences dialog box</title>
<graphic entityref="WiresharkGUIPreferences" format="PNG"/>
</figure>
+
+ <section id="ChCustInterfaceOptionsSection"><title>Interface Options</title>
+ <para>
+ In the Capture preferences it is possible to configure several options for the interfaces
+ available on your computer. Select the <command>Capture</command> phane and press the
+ Interfaces: <command>Edit</command> button. In this window it is possible to change the
+ default link-layer header type for the interface, add a comment or choose to hide a
+ interface from other parts of the program.
+ </para>
+ <figure id="ChCustInterfaceOptionsPage">
+ <title>The interface options dialog box</title>
+ <graphic entityref="WiresharkGUIInterfaceOptions" format="PNG"/>
+ </figure>
+ <para>Each row contains options for each interface available on your computer.</para>
+ <itemizedlist>
+ <listitem>
+ <para><command>Device</command>: the device name provided by the operating system.</para>
+ </listitem>
+ <listitem>
+ <para><command>Description</command>: provided by the operating system.</para>
+ </listitem>
+ <listitem>
+ <para><command>Default link-layer</command>: each interface may provide several
+ link-layer header types. The default link-layer choosen here is the one used when you
+ first start Wireshark. It is also possible to change this value in
+ <xref linkend="ChCapCaptureOptions"/> when you start a capture.</para>
+ </listitem>
+ <listitem>
+ <para><command>Comment</command>: a user provided description of the interface.
+ This comment will be used as a description instead of the operating system
+ description.</para>
+ </listitem>
+ <listitem>
+ <para><command>Hide?</command>: enable this option to hide the interface from other
+ parts of the program.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
+
<section id="ChCustConfigProfilesSection"><title>Configuration Profiles</title>
<para>
Configuration Profiles can be used to configure and use more than one set of preferences