aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.extcap
diff options
context:
space:
mode:
authorRoland Knall <roland.knall@br-automation.com>2016-09-05 07:54:47 +0200
committerRoland Knall <rknall@gmail.com>2016-09-07 09:09:30 +0000
commitee1a4109cfc8fb314d151f59859a348765ba9dbf (patch)
tree36f0efeb8e85e339824ce3d63841f87385ab971b /doc/README.extcap
parent859cf86c8d25b7ead113821ece4e9dec853e70d6 (diff)
extcap: Add tool-specified helppage
Allow the tool to provide a link to a helppage, displayed by clicking on help in the configuration dialog. The URL will be opened using an URL based service, therefore local as well as remote URLs are possible. Change-Id: I58b30244e97919d5cf6892faf96536ddc30fb5a7 Reviewed-on: https://code.wireshark.org/review/17549 Reviewed-by: Roland Knall <rknall@gmail.com>
Diffstat (limited to 'doc/README.extcap')
-rw-r--r--doc/README.extcap4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/README.extcap b/doc/README.extcap
index 6a4f33f44d..fb901a73ea 100644
--- a/doc/README.extcap
+++ b/doc/README.extcap
@@ -44,7 +44,7 @@ in the doc/extcap.4 generated man page (in the build dir).
Example:
$ extcapbin --extcap-interfaces
-extcap {version=1.0}
+extcap {version=1.0}{help=Some help url}
interface {value=example1}{display=Example interface 1 for extcap}
interface {value=example2}{display=Example interface 2 for extcap}
@@ -55,6 +55,8 @@ interface in the about dialog of Wireshark (Qt only).
The value for each interface will be used in subsequent calls as the interface
name IFACE.
+Using the help argument, an interface may provide a generic help url for the extcap utility.
+
STEP2: the extcap is queried for valid DLTs (Data Link Types) for all the
interfaces returned by the step 1.