aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/README.extcap4
-rw-r--r--doc/extcap.pod5
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/README.extcap b/doc/README.extcap
index 50dc1a82f3..7b53b7fcfd 100644
--- a/doc/README.extcap
+++ b/doc/README.extcap
@@ -150,6 +150,10 @@ These options do have types, for which the following types are being supported:
the user input for validity beyond normal data type or range checks. Back-slashes
must be escaped (as in \\b for \b)
+ * PASSWORD - Let the user provide a masked string to the capture
+
+ arg {number=0}{call=--password}{display=The user password}{tooltip=The password for the connection}{type=password}
+
* BOOLEAN,BOOLFLAG - this provides the possibility to set a true/false value.
BOOLFLAG values will only appear in the command-line if set to true, otherwise they
will not be added to the command-line call for the extcap interface
diff --git a/doc/extcap.pod b/doc/extcap.pod
index 511e1a59cd..05cbdcbb93 100644
--- a/doc/extcap.pod
+++ b/doc/extcap.pod
@@ -46,6 +46,7 @@ Argument type for UI filtering for raw, or UI type for selector:
radio (display group of radio buttons with provided values, all values as strings)
fileselect (display a dialog to select a file from the filesystem, value as string)
multicheck (display a textbox for selecting multiple options, values as strings)
+ password (display a textbox with masked text)
=item value (options)
@@ -79,6 +80,10 @@ Example 3:
arg {number=1}{call=--server}{display=IP address for log server}{type=string}{validation=(?:\d{1,3}\.){3}\d{1,3}}
flag {failure=Permission denied opening Ubertooth device}
+Example 4:
+ arg {number=0}{call=--username}{display=Username}{type=string}
+ arg {number=1}{call=--password}{display=Password}{type=password}
+
=head1 Security awareness
=over 4