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 <guy@alum.mit.edu>
This commit is contained in:
Guy Harris 2017-04-16 20:47:34 -07:00
parent ea1f62a8e8
commit 067ef3e08a
4 changed files with 24 additions and 4 deletions

View File

@ -54,6 +54,10 @@ S<[ B<-Y> E<lt>displaY filterE<gt> ]>
S<[ B<-z> E<lt>statisticsE<gt> ]>
S<[ B<--capture-comment> E<lt>commentE<gt> ]>
S<[ B<--export-objects> E<lt>protocolE<gt>,E<lt>destdirE<gt> ]>
S<[ B<--enable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--disable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--enable-heuristic> E<lt>short_nameE<gt> ]>
S<[ B<--disable-heuristic> E<lt>short_nameE<gt> ]>
S<[ E<lt>capture filterE<gt> ]>
B<tshark>
@ -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 E<lt>commentE<gt>
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 E<lt>proto_nameE<gt>
Enable dissection of proto_name.
=item --disable-protocol E<lt>proto_nameE<gt>
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),

View File

@ -49,6 +49,10 @@ 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<-z> E<lt>statisticsE<gt> ]>
S<[ B<--enable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--disable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--enable-heuristic> E<lt>short_nameE<gt> ]>
S<[ B<--disable-heuristic> E<lt>short_nameE<gt> ]>
S<[ E<lt>infileE<gt> ]>
=head1 DESCRIPTION
@ -962,6 +966,12 @@ Show IEEE 802.11 network and station statistics.
Show WSP packet counters.
=back
=item --enable-protocol E<lt>proto_nameE<gt>
Enable dissection of proto_name.
=item --disable-protocol E<lt>proto_nameE<gt>
Disable dissection of proto_name.
@ -976,8 +986,6 @@ Disable dissection of heuristic protocol.
=back
=back
=head1 INTERFACE
=head2 MENU ITEMS

View File

@ -369,6 +369,8 @@ print_usage(FILE *output)
fprintf(output, " Example: tcp.port==8888,http\n");
fprintf(output, " -H <hosts file> 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 <proto_name>\n");
fprintf(output, " enable dissection of proto_name\n");
fprintf(output, " --disable-protocol <proto_name>\n");
fprintf(output, " disable dissection of proto_name\n");
fprintf(output, " --enable-heuristic <short_name>\n");

View File

@ -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 <proto_name>\n");
fprintf(output, " enable dissection of proto_name\n");
fprintf(output, " --disable-protocol <proto_name>\n");
fprintf(output, " disable dissection of proto_name\n");
fprintf(output, " --enable-heuristic <short_name>\n");