Added a help button in the Interface Options dialog.

Added the Interface Options docbook chapter.


git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@25502 f5534014-38df-0310-8fa8-9805f1628bb7

6 files changed, 58 insertions, 12 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
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
diff --git a/gtk/help_dlg.c b/gtk/help_dlg.c
index 1d6b7f4e6f..5ffdb85dfd 100644
--- a/gtk/help_dlg.c
+++ b/gtk/help_dlg.c
@@ -78,14 +78,9 @@ static GSList *help_text_pages = NULL;
 
 
 
-gboolean topic_available(topic_action_e action) {
+gboolean topic_available(topic_action_e action _U_) {
 
-    if(action == HELP_CAPTURE_INTERFACES_DETAILS_DIALOG) {
-        /* XXX - add the page HELP_CAPTURE_INTERFACES_DETAILS_DIALOG and remove this if */
-        /* page currently not existing in user's guide */
-        return FALSE;
-    }
-    /* online: we have almost all possible pages available */
+    /* online: we have all possible pages available */
     return TRUE;
 }
 
@@ -302,8 +297,8 @@ topic_action(topic_action_e action)
     case(HELP_FILESET_DIALOG):
         help_topic_html("ChIOFileSetSection.html");
         break;
-    case(HELP_CAPTURE_INTERFACES_DETAILS_DIALOG):
-        help_topic_html("ChCapInterfaceDetailsSection.html");
+    case(HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG):
+        help_topic_html("ChCustInterfaceOptionsSection.html");
         break;
     case(HELP_PREFERENCES_DIALOG):
         help_topic_html("ChCustPreferencesSection.html");
diff --git a/gtk/help_dlg.h b/gtk/help_dlg.h
index 6b04474d75..26dc404211 100644
--- a/gtk/help_dlg.h
+++ b/gtk/help_dlg.h
@@ -80,7 +80,7 @@ typedef enum {
     HELP_STATS_CONVERSATIONS_DIALOG,
     HELP_STATS_IO_GRAPH_DIALOG,
     HELP_STATS_WLAN_TRAFFIC_DIALOG,
-    HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
+    HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
     HELP_PREFERENCES_DIALOG,
     HELP_CAPTURE_INFO_DIALOG,
     HELP_EXPORT_FILE_DIALOG,
diff --git a/gtk/prefs_capture.c b/gtk/prefs_capture.c
index 5baa1cdd31..3a032fabe7 100644
--- a/gtk/prefs_capture.c
+++ b/gtk/prefs_capture.c
@@ -45,6 +45,7 @@
 #include "gtk/dlg_utils.h"
 #include "gtk/main.h"
 #include "gtk/main_welcome.h"
+#include "gtk/help_dlg.h"
 #include "gtk/stock_icons.h"
 #include <epan/strutil.h>
 
@@ -255,11 +256,12 @@ ifopts_edit_cb(GtkWidget *w, gpointer data _U_)
 	GtkWidget	*ifopts_edit_dlg, *cur_scr_win, *main_hb, *main_tb,
 				*cur_opts_fr, *ed_opts_fr, *main_vb,
 				*if_linktype_lb, *if_descr_lb, *if_hide_lb,
-				*bbox, *ok_bt, *cancel_bt;
+				*bbox, *ok_bt, *cancel_bt, *help_bt;
 	const gchar *cur_titles[] = { "Device", "Description", "Default link-layer", "Comment", "Hide?", "" };
 	int row = 0;
 
 	GtkWidget *caller = gtk_widget_get_toplevel(w);
+	GtkTooltips	*tooltips = gtk_tooltips_new();
 
 	/* Has an edit dialog box already been opened for that top-level
 	   widget? */
@@ -391,16 +393,25 @@ ifopts_edit_cb(GtkWidget *w, gpointer data _U_)
         row++;
 
 	/* button row: OK and Cancel buttons */
-	bbox = dlg_button_row_new(GTK_STOCK_OK, GTK_STOCK_CANCEL, NULL);
+	bbox = dlg_button_row_new(GTK_STOCK_OK, GTK_STOCK_CANCEL, GTK_STOCK_HELP, NULL);
 	gtk_box_pack_start(GTK_BOX(main_vb), bbox, FALSE, FALSE, 0);
 	gtk_widget_show(bbox);
 
 	ok_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_OK);
+	gtk_tooltips_set_tip(tooltips, ok_bt,
+			     "Save changes and exit dialog", NULL);
 	g_signal_connect(ok_bt, "clicked", G_CALLBACK(ifopts_edit_ok_cb), ifopts_edit_dlg);
 
 	cancel_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
+	gtk_tooltips_set_tip(tooltips, cancel_bt,
+			     "Cancel and exit dialog", NULL);
         window_set_cancel_button(ifopts_edit_dlg, cancel_bt, window_cancel_button_cb);
 
+	help_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_HELP);
+	g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), 
+			 (gpointer)HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG);
+	gtk_tooltips_set_tip (tooltips, help_bt, "Show topic specific help", NULL);
+
 	gtk_widget_grab_default(ok_bt);
 
 	g_signal_connect(ifopts_edit_dlg, "delete_event", G_CALLBACK(window_delete_event_cb),