Documentation: update (long) cmd line options

Documentation of the Tshark and dumpcap command line options between
help text, manual page and user's guide diverged over time. One aspect
of this is the implementation of more long options. This change tries to
update all documentation to be complete and in sync again.

Change-Id: Ie8bee013df8d209080fcf288072774f18f9ff51f
Reviewed-on: https://code.wireshark.org/review/35261
Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
Petri-Dish: Jaap Keuter <jaap.keuter@xs4all.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Michael Mann <mmann78@netscape.net>

1 files changed, 39 insertions, 24 deletions

diff --git a/tshark.c b/tshark.c
index 1ed0b065b7..bcd180e2e8 100644
--- a/tshark.c
+++ b/tshark.c
@@ -329,37 +329,48 @@ print_usage(FILE *output)
 
 #ifdef HAVE_LIBPCAP
   fprintf(output, "Capture interface:\n");
-  fprintf(output, "  -i <interface>           name or idx of interface (def: first non-loopback)\n");
+  fprintf(output, "  -i <interface>, --interface <interface>\n");
+  fprintf(output, "                           name or idx of interface (def: first non-loopback)\n");
   fprintf(output, "  -f <capture filter>      packet filter in libpcap filter syntax\n");
+  fprintf(output, "  -s <snaplen>, --snapshot-length <snaplen>\n");
 #ifdef HAVE_PCAP_CREATE
-  fprintf(output, "  -s <snaplen>             packet snapshot length (def: appropriate maximum)\n");
+  fprintf(output, "                           packet snapshot length (def: appropriate maximum)\n");
 #else
-  fprintf(output, "  -s <snaplen>             packet snapshot length (def: %u)\n", WTAP_MAX_PACKET_SIZE_STANDARD);
+  fprintf(output, "                           packet snapshot length (def: %u)\n", WTAP_MAX_PACKET_SIZE_STANDARD);
 #endif
-  fprintf(output, "  -p                       don't capture in promiscuous mode\n");
+  fprintf(output, "  -p, --no-promiscuous-mode\n");
+  fprintf(output, "                           don't capture in promiscuous mode\n");
 #ifdef HAVE_PCAP_CREATE
-  fprintf(output, "  -I                       capture in monitor mode, if available\n");
+  fprintf(output, "  -I, --monitor-mode       capture in monitor mode, if available\n");
 #endif
 #ifdef CAN_SET_CAPTURE_BUFFER_SIZE
-  fprintf(output, "  -B <buffer size>         size of kernel buffer (def: %dMB)\n", DEFAULT_CAPTURE_BUFFER_SIZE);
+  fprintf(output, "  -B <buffer size>, --buffer-size <buffer size>\n");
+  fprintf(output, "                           size of kernel buffer (def: %dMB)\n", DEFAULT_CAPTURE_BUFFER_SIZE);
 #endif
-  fprintf(output, "  -y <link type>           link layer type (def: first appropriate)\n");
+  fprintf(output, "  -y <link type>, --linktype <link type>\n");
+  fprintf(output, "                           link layer type (def: first appropriate)\n");
   fprintf(output, "  --time-stamp-type <type> timestamp method for interface\n");
-  fprintf(output, "  -D                       print list of interfaces and exit\n");
-  fprintf(output, "  -L                       print list of link-layer types of iface and exit\n");
+  fprintf(output, "  -D, --list-interfaces    print list of interfaces and exit\n");
+  fprintf(output, "  -L, --list-data-link-types\n");
+  fprintf(output, "                           print list of link-layer types of iface and exit\n");
   fprintf(output, "  --list-time-stamp-types  print list of timestamp types for iface and exit\n");
   fprintf(output, "\n");
   fprintf(output, "Capture stop conditions:\n");
   fprintf(output, "  -c <packet count>        stop after n packets (def: infinite)\n");
-  fprintf(output, "  -a <autostop cond.> ...  duration:NUM - stop after NUM seconds\n");
+  fprintf(output, "  -a <autostop cond.> ..., --autostop <autostop cond.> ...\n");
+  fprintf(output, "                           duration:NUM - stop after NUM seconds\n");
   fprintf(output, "                           filesize:NUM - stop this file after NUM KB\n");
   fprintf(output, "                              files:NUM - stop after NUM files\n");
+  fprintf(output, "                            packets:NUM - stop after NUM packets\n");
   /*fprintf(output, "\n");*/
   fprintf(output, "Capture output:\n");
-  fprintf(output, "  -b <ringbuffer opt.> ... duration:NUM - switch to next file after NUM secs\n");
-  fprintf(output, "                           interval:NUM - create time intervals of NUM secs\n");
+  fprintf(output, "  -b <ringbuffer opt.> ..., --ring-buffer <ringbuffer opt.>\n");
+  fprintf(output, "                           duration:NUM - switch to next file after NUM secs\n");
   fprintf(output, "                           filesize:NUM - switch to next file after NUM KB\n");
   fprintf(output, "                              files:NUM - ringbuffer: replace after NUM files\n");
+  fprintf(output, "                            packets:NUM - switch to next file after NUM packets\n");
+  fprintf(output, "                           interval:NUM - switch to next file when the time is\n");
+  fprintf(output, "                                          an exact multiple of NUM secs\n");
 #endif  /* HAVE_LIBPCAP */
 #ifdef HAVE_PCAP_REMOTE
   fprintf(output, "RPCAP options:\n");
@@ -367,15 +378,18 @@ print_usage(FILE *output)
 #endif
   /*fprintf(output, "\n");*/
   fprintf(output, "Input file:\n");
-  fprintf(output, "  -r <infile|->            set the filename to read from (or '-' for stdin)\n");
+  fprintf(output, "  -r <infile>, --read-file <infile>\n");
+  fprintf(output, "                           set the filename to read from (or '-' for stdin)\n");
 
   fprintf(output, "\n");
   fprintf(output, "Processing:\n");
   fprintf(output, "  -2                       perform a two-pass analysis\n");
   fprintf(output, "  -M <packet count>        perform session auto reset\n");
-  fprintf(output, "  -R <read filter>         packet Read filter in Wireshark display filter syntax\n");
+  fprintf(output, "  -R <read filter>, --read-filter <read filter>\n");
+  fprintf(output, "                           packet Read filter in Wireshark display filter syntax\n");
   fprintf(output, "                           (requires -2)\n");
-  fprintf(output, "  -Y <display filter>      packet displaY filter in Wireshark display filter\n");
+  fprintf(output, "  -Y <display filter>, --display-filter <display filter>\n");
+  fprintf(output, "                           packet displaY filter in Wireshark display filter\n");
   fprintf(output, "                           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");
@@ -401,6 +415,8 @@ print_usage(FILE *output)
   fprintf(output, "  -w <outfile|->           write packets to a pcap-format file named \"outfile\"\n");
 #endif
   fprintf(output, "                           (or '-' for stdout)\n");
+  fprintf(output, "  --capture-comment <comment>\n");
+  fprintf(output, "                           set the capture file comment, if supported\n");
   fprintf(output, "  -C <config profile>      start with specified configuration profile\n");
 #ifdef PCAP_NG_DEFAULT
   fprintf(output, "  -F <output file type>    set the output file type, default is pcapng\n");
@@ -411,7 +427,7 @@ print_usage(FILE *output)
   fprintf(output, "  -V                       add output of packet tree        (Packet Details)\n");
   fprintf(output, "  -O <protocols>           Only show packet details of these protocols, comma\n");
   fprintf(output, "                           separated\n");
-  fprintf(output, "  -P                       print packet summary even when writing to a file\n");
+  fprintf(output, "  -P, --print              print packet summary even when writing to a file\n");
   fprintf(output, "  -S <separator>           the line separator to print between packets\n");
   fprintf(output, "  -x                       add output of hex and ASCII dump (Packet Bytes)\n");
   fprintf(output, "  -T pdml|ps|psml|json|jsonraw|ek|tabs|text|fields|?\n");
@@ -432,7 +448,8 @@ print_usage(FILE *output)
   fprintf(output, "     aggregator=,|/s|<char> select comma, space, printable character as\n");
   fprintf(output, "                           aggregator\n");
   fprintf(output, "     quote=d|s|n           select double, single, no quotes for values\n");
-  fprintf(output, "  -t a|ad|d|dd|e|r|u|ud|?  output format of time stamps (def: r: rel. to first)\n");
+  fprintf(output, "  -t a|ad|adoy|d|dd|e|r|u|ud|udoy\n");
+  fprintf(output, "                           output format of time stamps (def: r: rel. to first)\n");
   fprintf(output, "  -u s|hms                 output format of seconds (def: s: seconds)\n");
   fprintf(output, "  -l                       flush standard output after each packet\n");
   fprintf(output, "  -q                       be more quiet on stdout (e.g. when using statistics)\n");
@@ -443,11 +460,9 @@ print_usage(FILE *output)
   fprintf(output, "  -X <key>:<value>         eXtension options, see the man page for details\n");
   fprintf(output, "  -U tap_name              PDUs export mode, see the man page for details\n");
   fprintf(output, "  -z <statistics>          various statistics, see the man page for details\n");
-  fprintf(output, "  --capture-comment <comment>\n");
-  fprintf(output, "                           add a capture comment to the newly created\n");
-  fprintf(output, "                           output file (only for pcapng)\n");
-  fprintf(output, "  --export-objects <protocol>,<destdir> save exported objects for a protocol to\n");
-  fprintf(output, "                           a directory named \"destdir\"\n");
+  fprintf(output, "  --export-objects <protocol>,<destdir>\n");
+  fprintf(output, "                           save exported objects for a protocol to a directory\n");
+  fprintf(output, "                           named \"destdir\"\n");
   fprintf(output, "  --color                  color output text similarly to the Wireshark GUI,\n");
   fprintf(output, "                           requires a terminal with 24-bit color support\n");
   fprintf(output, "                           Also supplies color attributes to pdml and psml formats\n");
@@ -460,8 +475,8 @@ print_usage(FILE *output)
 
   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, --help               display this help and exit\n");
+  fprintf(output, "  -v, --version            display version info and exit\n");
   fprintf(output, "  -o <name>:<value> ...    override preference setting\n");
   fprintf(output, "  -K <keytab>              keytab file to use for kerberos decryption\n");
   fprintf(output, "  -G [report]              dump one of several available reports and exit\n");