osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Document long command line options. 

Bug: 16168
Change-Id: Ifdfa9092b632171c461430bc3e9de32ec1ed46f4
Reviewed-on: https://code.wireshark.org/review/34996
Petri-Dish: Dario Lombardo <lomato@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
This commit is contained in:
Dario Lombardo 2019-11-05 13:49:17 +00:00 committed by Anders Broman
parent ca2316069e
commit 69356f1b60
4 changed files with 56 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/wireshark-filter.pod
View File

@ -11,7 +11,7 @@ wireshark-filter - Wireshark display filter syntax and reference
=head1 SYNOPSIS
B<wireshark> [other options]
S<[ B<-Y> "display filter expression" ]>
S<[ B<-Y> "display filter expression" | b<--display-filter> "display filter expression" ]>
B<tshark> [other options]
S<[ B<-Y> "display filter expression" ]>

22
doc/wireshark.pod.template
View File

@ -47,7 +47,7 @@ S<[ B<-v> ]>
S<[ B<-w> E<lt>outfileE<gt> ]>
S<[ B<-X> E<lt>eXtension optionE<gt> ]>
S<[ B<-y> E<lt>capture link typeE<gt> ]>
S<[ B<-Y> E<lt>displaY filterE<gt> ]>
S<[ B<-Y> E<lt>displaY filterE<gt> | B<--display-filter> E<lt>display filterE<gt> ]>
S<[ B<-z> E<lt>statisticsE<gt> ]>
S<[ B<--enable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--disable-protocol> E<lt>proto_nameE<gt> ]>
@ -1008,6 +1008,26 @@ set, no time stamp types are listed.
Change the interface's timestamp method.
=item --read-file E<lt>infileE<gt>
Same as -r option.
=item --read-filter E<lt>read filterE<gt>
Same as -R option.
=item --display-filter E<lt>display filterE<gt>
Same as -Y option.
=item --verbose
Same as -v option.
=item --help
Same as -h option.
=back
=head1 INTERFACE

34
docbook/wsug_src/WSUG_chapter_customize.adoc
View File

@ -36,7 +36,7 @@ are, simply enter the command _wireshark -h_ and the help information shown in
.Help information available from Wireshark
====
----
Wireshark 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
Wireshark 3.1.1 (v3.1.1rc0-629-ge1dc9f82a63c)
Interactively dump and analyze network traffic.
See https://www.wireshark.org for more information.
@ -44,10 +44,9 @@ Usage: wireshark [options] ... [ <infile> ]
Capture interface:
-i <interface> name or idx of interface (def: first non-loopback)
-f <capfilter|predef:> packet filter in libpcap filter syntax or
predef:filtername - predefined filtername from GUI
-s <snaplen> packet snapshot length (def: 262144)
-p don’t capture in promiscuous mode
-f <capture filter> packet filter in libpcap filter syntax
-s <snaplen> packet snapshot length (def: appropriate maximum)
-p don't capture in promiscuous mode
-k start capturing immediately (def: do nothing)
-S update packet display when new packets are captured
-l turn on automatic scrolling while -S is in use
@ -68,18 +67,21 @@ Capture output:
-b <ringbuffer opt.> ... duration:NUM - switch to next file after NUM secs
filesize:NUM - switch to next file after NUM KB
files:NUM - ringbuffer: replace after NUM files
RPCAP options:
-A <user>:<password> use RPCAP password authentication
Input file:
-r <infile> set the filename to read from (no pipes or stdin!)
-r <infile>
--read-file <infile> set the filename to read from (no pipes or stdin!)
Processing:
-R <read filter> packet filter in Wireshark display filter syntax
-R <read filter>
--read-filter <read filter>
packet filter in Wireshark display filter syntax
-n disable all name resolutions (def: all enabled)
-N <name resolve flags> enable specific name resolution(s): "mnNtdv"
-d <layer_type>==<selector>,<decode_as_protocol> ...
"Decode As”, see the man page for details
"Decode As", see the man page for details
Example: tcp.port==8888,http
--enable-protocol <proto_name>
enable dissection of proto_name
--disable-protocol <proto_name>
disable dissection of proto_name
--enable-heuristic <short_name>
@ -89,7 +91,9 @@ Processing:
User interface:
-C <config profile> start with specified configuration profile
-Y <display filter> start with the given display filter
-Y <display filter>
--display-filter <display filter>
start with the given display filter
-g <packet number> go to specified packet number after "-r"
-J <jump filter> jump to the first packet matching the (display)
filter
@ -104,12 +108,16 @@ Output:
-w <outfile|-> set the output filename (or '-' for stdout)
Miscellaneous:
-h display this help and exit
-v display version info and exit
-h
--help display this help and exit
-v
--version display version info and exit
-P <key>:<path> persconf:path - personal configuration files
persdata:path - personal data files
-o <name>:<value> ... override preference or recent setting
-K <keytab> keytab file to use for kerberos decryption
--display DISPLAY X display to use
--fullscreen start Wireshark in full screen
----
====

19
ui/commandline.c
View File

@ -114,11 +114,14 @@ commandline_print_usage(gboolean for_help_option) {
#endif
/*fprintf(output, "\n");*/
fprintf(output, "Input file:\n");
fprintf(output, " -r <infile> set the filename to read from (no pipes or stdin!)\n");
fprintf(output, " -r <infile>\n");
fprintf(output, " --read-file <infile> set the filename to read from (no pipes or stdin!)\n");
fprintf(output, "\n");
fprintf(output, "Processing:\n");
fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
fprintf(output, " -R <read filter>\n");
fprintf(output, " --read-filter <read filter>\n");
fprintf(output, " packet filter in Wireshark display filter syntax\n");
fprintf(output, " -n disable all name resolutions (def: all enabled)\n");
fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtdv\"\n");
fprintf(output, " -d %s ...\n", DECODE_AS_ARG_TEMPLATE);
@ -136,7 +139,9 @@ commandline_print_usage(gboolean for_help_option) {
fprintf(output, "\n");
fprintf(output, "User interface:\n");
fprintf(output, " -C <config profile> start with specified configuration profile\n");
fprintf(output, " -Y <display filter> start with the given display filter\n");
fprintf(output, " -Y <display filter>\n");
fprintf(output, " --display-filter <display filter>\n");
fprintf(output, " start with the given display filter\n");
fprintf(output, " -g <packet number> go to specified packet number after \"-r\"\n");
fprintf(output, " -J <jump filter> jump to the first packet matching the (display)\n");
fprintf(output, " filter\n");
@ -153,14 +158,16 @@ commandline_print_usage(gboolean for_help_option) {
fprintf(output, "\n");
fprintf(output, "Miscellaneous:\n");
fprintf(output, " -h display this help and exit\n");
fprintf(output, " -v display version info and exit\n");
fprintf(output, " -h\n");
fprintf(output, " --help display this help and exit\n");
fprintf(output, " -v\n");
fprintf(output, " --version display version info and exit\n");
fprintf(output, " -P <key>:<path> persconf:path - personal configuration files\n");
fprintf(output, " persdata:path - personal data files\n");
fprintf(output, " -o <name>:<value> ... override preference or recent setting\n");
fprintf(output, " -K <keytab> keytab file to use for kerberos decryption\n");
#ifndef _WIN32
fprintf(output, " --display DISPLAY X display to use\n");
fprintf(output, " --display <X display> X display to use\n");
#endif
fprintf(output, " --fullscreen start Wireshark in full screen\n");