From 067ef3e08a4728d37c64a50da81087cc7b3ad2e0 Mon Sep 17 00:00:00 2001 From: Guy Harris Date: Sun, 16 Apr 2017 20:47:34 -0700 Subject: [PATCH] Clean up documentation and help messages for protocol enabling/disabling. List all of --enable-protocol, --disable-protocol, --enable-heuristic, and --disable-heuristic in the SYNOPSIS section of the man pages. Undent after the list of taps for the -z option, so the following options are at the same indentation as other options. List --enable-protocol in the DESCRIPTION, above --disable-protocol. Include --enable-protocol in the help message. Change-Id: I680a54430789f3543b2d539fbded22b0b57f7f76 Reviewed-on: https://code.wireshark.org/review/21159 Reviewed-by: Guy Harris --- doc/tshark.pod | 12 ++++++++++-- doc/wireshark.pod.template | 12 ++++++++++-- tshark.c | 2 ++ ui/commandline.c | 2 ++ 4 files changed, 24 insertions(+), 4 deletions(-) diff --git a/doc/tshark.pod b/doc/tshark.pod index 817170f183..100049609d 100644 --- a/doc/tshark.pod +++ b/doc/tshark.pod @@ -54,6 +54,10 @@ S<[ B<-Y> EdisplaY filterE ]> S<[ B<-z> EstatisticsE ]> S<[ B<--capture-comment> EcommentE ]> S<[ B<--export-objects> EprotocolE,EdestdirE ]> +S<[ B<--enable-protocol> Eproto_nameE ]> +S<[ B<--disable-protocol> Eproto_nameE ]> +S<[ B<--enable-heuristic> Eshort_nameE ]> +S<[ B<--disable-heuristic> Eshort_nameE ]> S<[ Ecapture filterE ]> B @@ -1588,6 +1592,8 @@ on those calls that match that filter. Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will only collect stats for SMB packets exchanged by the host at IP address 1.2.3.4 . +=back + =item --capture-comment EcommentE Add a capture comment to the output file. @@ -1607,6 +1613,10 @@ before the file extension. This interface is subject to change, adding the possibility to filter on files. +=item --enable-protocol Eproto_nameE + +Enable dissection of proto_name. + =item --disable-protocol Eproto_nameE Disable dissection of proto_name. @@ -1621,8 +1631,6 @@ Disable dissection of heuristic protocol. =back -=back - =head1 CAPTURE FILTER SYNTAX See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8), diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template index a4ade52e26..1213c290bc 100644 --- a/doc/wireshark.pod.template +++ b/doc/wireshark.pod.template @@ -49,6 +49,10 @@ S<[ B<-X> EeXtension optionE ]> S<[ B<-y> Ecapture link typeE ]> S<[ B<-Y> EdisplaY filterE ]> S<[ B<-z> EstatisticsE ]> +S<[ B<--enable-protocol> Eproto_nameE ]> +S<[ B<--disable-protocol> Eproto_nameE ]> +S<[ B<--enable-heuristic> Eshort_nameE ]> +S<[ B<--disable-heuristic> Eshort_nameE ]> S<[ EinfileE ]> =head1 DESCRIPTION @@ -962,6 +966,12 @@ Show IEEE 802.11 network and station statistics. Show WSP packet counters. +=back + +=item --enable-protocol Eproto_nameE + +Enable dissection of proto_name. + =item --disable-protocol Eproto_nameE Disable dissection of proto_name. @@ -976,8 +986,6 @@ Disable dissection of heuristic protocol. =back -=back - =head1 INTERFACE =head2 MENU ITEMS diff --git a/tshark.c b/tshark.c index 4a0680e214..78252a1438 100644 --- a/tshark.c +++ b/tshark.c @@ -369,6 +369,8 @@ print_usage(FILE *output) fprintf(output, " Example: tcp.port==8888,http\n"); fprintf(output, " -H read a list of entries from a hosts file, which will\n"); fprintf(output, " then be written to a capture file. (Implies -W n)\n"); + fprintf(output, " --enable-protocol \n"); + fprintf(output, " enable dissection of proto_name\n"); fprintf(output, " --disable-protocol \n"); fprintf(output, " disable dissection of proto_name\n"); fprintf(output, " --enable-heuristic \n"); diff --git a/ui/commandline.c b/ui/commandline.c index acd4d40d6b..127bb6a4af 100644 --- a/ui/commandline.c +++ b/ui/commandline.c @@ -135,6 +135,8 @@ commandline_print_usage(gboolean for_help_option) { fprintf(output, " -d %s ...\n", DECODE_AS_ARG_TEMPLATE); fprintf(output, " \"Decode As\", see the man page for details\n"); fprintf(output, " Example: tcp.port==8888,http\n"); + fprintf(output, " --enable-protocol \n"); + fprintf(output, " enable dissection of proto_name\n"); fprintf(output, " --disable-protocol \n"); fprintf(output, " disable dissection of proto_name\n"); fprintf(output, " --enable-heuristic \n");