aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHadriel Kaplan <hadrielk@yahoo.com>2014-03-19 12:57:13 -0400
committerAlexis La Goutte <alexis.lagoutte@gmail.com>2014-03-19 17:03:42 +0000
commit7e423a3a1f136ede404b7af40c96279e5a7c7940 (patch)
tree6ccf132709d310dba1a655ad53a0b7bf7127b790
parentc8a98f37ec300b522a732c349a7d3f0c17b7168d (diff)
Add read_format extension to manual pages
The -X read_format extension was added in code but in the manuals. Change-Id: I21692120229ef531671fc3db247809ace69d23b3 Reviewed-on: https://code.wireshark.org/review/742 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
-rw-r--r--doc/tshark.pod8
-rw-r--r--doc/wireshark.pod.template3
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/tshark.pod b/doc/tshark.pod
index c195a87659..83b4222ecc 100644
--- a/doc/tshark.pod
+++ b/doc/tshark.pod
@@ -785,16 +785,20 @@ after printing the summary and/or details, if either are also being displayed.
Specify an option to be passed to a B<TShark> module. The eXtension option
is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
-B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
+B<lua_script>:I<lua_script_filename> tells B<TShark> to load the given script in addition to the
default Lua scripts.
-B<lua_script>I<num>:I<argument> tells B<Wireshark> to pass the given argument
+B<lua_script>I<num>:I<argument> tells B<TShark> to pass the given argument
to the lua script identified by 'num', which is the number indexed order of the 'lua_script' command.
For example, if only one script was loaded with '-X lua_script:my.lua', then '-X lua_script1:foo'
will pass the string 'foo' to the 'my.lua' script. If two scripts were loaded, such as '-X lua_script:my.lua'
and '-X lua_script:other.lua' in that order, then a '-X lua_script2:bar' would pass the string 'bar' to the second lua
script, namely 'other.lua'.
+B<read_format>:I<file_format> tells B<TShark> to use the given file format to read in the
+file (the file given in the B<-r> command option). Providing no I<file_format> argument, or
+an invalid one, will produce a file of available file formats to use.
+
=item -y E<lt>capture link typeE<gt>
Set the data link type to use while capturing packets. The values
diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template
index 2c93582afa..16d6766f73 100644
--- a/doc/wireshark.pod.template
+++ b/doc/wireshark.pod.template
@@ -611,6 +611,9 @@ will pass the string 'foo' to the 'my.lua' script. If two scripts were loaded,
and '-X lua_script:other.lua' in that order, then a '-X lua_script2:bar' would pass the string 'bar' to the second lua
script, namely 'other.lua'.
+B<read_format>:I<file_format> tells B<Wireshark> to use the given file format to read in the
+file (the file given in the B<-r> command option).
+
B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
capturing from standard input (B<-i ->).