Update user guide for development release
authorPascal Quantin <pascal.quantin@gmail.com>
Wed, 11 Nov 2015 17:19:50 +0000 (18:19 +0100)
committerPascal Quantin <pascal.quantin@gmail.com>
Wed, 11 Nov 2015 17:31:31 +0000 (17:31 +0000)
Change-Id: I9b4c5ab2e98ad6daa618bcda20b53a23467e16e0
Reviewed-on: https://code.wireshark.org/review/11734
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
13 files changed:
capinfos.c
captype.c
docbook/developer-guide-docinfo.xml
docbook/user-guide-docinfo.xml
docbook/user-guide.asciidoc
docbook/wsug_src/WSUG_app_tools.asciidoc
docbook/wsug_src/WSUG_chapter_customize.asciidoc
editcap.c
mergecap.c
rawshark.c
reordercap.c
text2pcap.c
wireshark-qt.cpp

index 49fb8db56774b43541800bfce8126b0f3518a485..4742d2adb8b8de8173296bfc52c3031509b408f2 100644 (file)
@@ -1617,7 +1617,7 @@ DIAG_ON(cast-qual)
       case 'h':
         printf("Capinfos (Wireshark) %s\n"
                "Print various information (infos) about capture files.\n"
-               "See http://www.wireshark.org for more information.\n",
+               "See https://www.wireshark.org for more information.\n",
                get_ws_vcs_version_info());
         print_usage(stdout);
         exit(0);
index 64f22d449b37993b63e9a3278499f593e8f198b2..49cb3e05c5dd26d7ab9c48bded9f8c9079fc0f1c 100644 (file)
--- a/captype.c
+++ b/captype.c
@@ -189,7 +189,7 @@ DIAG_ON(cast-qual)
       case 'h':
         printf("Captype (Wireshark) %s\n"
                "Print the file types of capture files.\n"
-               "See http://www.wireshark.org for more information.\n",
+               "See https://www.wireshark.org for more information.\n",
                get_ws_vcs_version_info());
         print_usage(stdout);
         exit(0);
index 532377d7d0d046e375f8bd9aa839e5e2873fa77f..1c94e38e12183343f8cfbc0f630dbfb1873e29fa 100644 (file)
@@ -1,6 +1,6 @@
 <!-- Document information for the Developer's Guide. -->
 
-<subtitle>For Wireshark 1.99</subtitle>
+<subtitle>For Wireshark 2.1</subtitle>
 
   <!-- <title><inlinegraphic entityref="WiresharkLogo" valign="middle" format="PNG"/> &DocumentTitle;</title> -->
 
index 35b9cd66279917c2f3efc12fa00ed9c8e4aa3f4d..ef11764a0e113fabbfb521548996c23bb24198ca 100644 (file)
@@ -1,6 +1,6 @@
 <!-- Document information for the User's Guide. -->
 
-<subtitle>For Wireshark 1.99</subtitle>
+<subtitle>For Wireshark 2.1</subtitle>
 
 <!--
   <title><inlinegraphic entityref="WiresharkLogo" valign="middle" format="PNG"/> &DocumentTitle;</title>
index ee0c2ccd9899ae4cd2579080dc597c549629e474..abb0fae7651f9ac9acaa7dbd6ed351dd3fb61dc0 100644 (file)
@@ -1,4 +1,4 @@
-= Wireshark User's Guide
+= Wireshark User Guide
 //v1.0, February 2014: Finished conversion from DocBook to AsciiDoc
 :doctype: book
 
index ad5c02ecae43797daded344af538e5a8ad50e4e3..df66220bb3226863cdfe7d1d6c86254ca9ef9cdc 100644 (file)
@@ -28,13 +28,9 @@ available. It supports the same options as `wireshark`. For more information on
 [[AppToolstsharkEx]]
 .Help information available from `tshark`
 ----
-TShark 1.12.1 (Git Rev Unknown from unknown)
+TShark (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Dump and analyze network traffic.
-See http://www.wireshark.org for more information.
-
-Copyright 1998-2014 Gerald Combs <gerald@wireshark.org> and contributors.
-This is free software; see the source for copying conditions. There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See https://www.wireshark.org for more information.
 
 Usage: tshark [options] ...
 
@@ -58,6 +54,8 @@ 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 (- to read from stdin)
 
@@ -73,13 +71,12 @@ Processing:
                            Example: tcp.port==8888,http
   -H <hosts file>          read a list of entries from a hosts file, which will
                            then be written to a capture file. (Implies -W n)
-  --disable-protocol <proto_name> disable dissection of proto_name
-                           Repeat option for each protocol
-  --enable-heuristic <short_name> enable dissection of heuristic protocol
-                           Repeat option for each protocol
-  --disable-heuristic <short_name> disable dissection of heuristic protocol
-                           Repeat option for each protocol
-
+  --disable-protocol <proto_name>
+                           disable dissection of proto_name
+  --enable-heuristic <short_name>
+                           enable dissection of heuristic protocol
+  --disable-heuristic <short_name>
+                           disable dissection of heuristic protocol
 Output:
   -w <outfile|->           write packets to a pcap-format file named "outfile"
                            (or to the standard output for "-")
@@ -172,9 +169,9 @@ follows the rules of the pcap library.
 [[AppToolsdumpcapEx]]
 .Help information available from dumpcap
 ----
-Dumpcap 1.12.1 (Git Rev Unknown from unknown)
-Capture network packets and dump them into a pcapng file.
-See http://www.wireshark.org for more information.
+Dumpcap (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
+Capture network packets and dump them into a pcapng or pcap file.
+See https://www.wireshark.org for more information.
 
 Usage: dumpcap [options] ...
 
@@ -196,6 +193,13 @@ Capture interface:
   -S                       print statistics for each interface once per second
   -M                       for -D, -L, and -S, produce machine-readable output
 
+RPCAP options:
+  -r                       don't ignore own RPCAP traffic in capture
+  -u                       use UDP for RPCAP data transfer
+  -A <user>:<password>     use RPCAP password authentication
+  -m <sampling type>       use packet sampling
+                           count:NUM - capture one packet of every NUM
+                           timer:NUM - capture no more than 1 packet in NUM ms
 Stop conditions:
   -c <packet count>        stop after n packets (def: infinite)
   -a <autostop cond.> ...  duration:NUM - stop after NUM seconds
@@ -241,15 +245,17 @@ Use Ctrl-C to stop capturing at any time.
 [[AppToolscapinfosEx]]
 .Help information available from capinfos
 ----
-Capinfos 1.12.1 (Git Rev Unknown from unknown)
-Prints various information (infos) about capture files.
-See http://www.wireshark.org for more information.
+Capinfos (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
+Print various information (infos) about capture files.
+See https://www.wireshark.org for more information.
 
 Usage: capinfos [options] <infile> ...
 
 General infos:
   -t display the capture file type
   -E display the capture file encapsulation
+  -I display the capture file interface information
+  -F display additional capture file information
   -H display the SHA1, RMD160, and MD5 hashes of the file
   -k display the capture comment
 
@@ -312,13 +318,9 @@ stdout.
 [[AppToolsrawsharkEx]]
 .Help information available from rawshark
 ----
-Rawshark 1.12.1 (Git Rev Unknown from unknown)
+Rawshark (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Dump and analyze network traffic.
-See http://www.wireshark.org for more information.
-
-Copyright 1998-2014 Gerald Combs <gerald@wireshark.org> and contributors.
-This is free software; see the source for copying conditions. There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See https://www.wireshark.org for more information.
 
 Usage: rawshark [options] ...
 
@@ -360,9 +362,9 @@ information about capture files.
 [[AppToolseditcapEx]]
 .Help information available from editcap
 ----
-Editcap 1.12.1 (Git Rev Unknown from unknown)
+Editcap (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Edit and/or translate the format of capture files.
-See http://www.wireshark.org for more information.
+See https://www.wireshark.org for more information.
 
 Usage: editcap [options] ... <infile> <outfile> [ <packet#>[-<packet#>] ... ]
 
@@ -386,6 +388,15 @@ Duplicate packet removal:
                          LESS THAN <dup time window> prior to current packet.
                          A <dup time window> is specified in relative seconds
                          (e.g. 0.000001).
+  -a <framenum>:<comment>  Add or replace comment for given frame number
+
+  -I <bytes to ignore>   ignore the specified bytes at the beginning of
+                         the frame during MD5 hash calculation
+                         Useful to remove duplicated packets taken on
+                         several routers(differents mac addresses for
+                         example)
+                         e.g. -I 26 in case of Ether/IP/ will ignore
+                         ether(14) and IP header(20 - 4(src ip) - 4(dst ip)).
 
            NOTE: The use of the 'Duplicate packet removal' options with
            other editcap options except -v may not always work as expected.
@@ -403,7 +414,8 @@ Packet manipulation:
                          this option more than once, allowing up to 2 chopping
                          regions within a packet provided that at least 1
                          choplen is positive and at least 1 is negative.
-  -L                     adjust the frame length when chopping and/or snapping
+  -L                     adjust the frame (i.e. reported) length when chopping
+                         and/or snapping
   -t <time adjustment>   adjust the timestamp of each packet;
                          <time adjustment> is in relative seconds (e.g. -0.5).
   -S <strict adjustment> adjust timestamp of packets if necessary to insure
@@ -416,6 +428,9 @@ Packet manipulation:
                          all packets to the timestamp of the first packet.
   -E <error probability> set the probability (between 0.0 and 1.0 incl.) that
                          a particular packet byte will be randomly changed.
+  -o <change offset>     When used in conjuction with -E, skip some bytes from the
+                         beginning of the packet. This allows to preserve some
+                         bytes, in order to have some headers untouched.
 
 Output File(s):
   -c <packets per file>  split the packet output to different files based on
@@ -473,6 +488,7 @@ editcap: The available capture file types for the "-F" flag are:
     nstrace10 - NetScaler Trace (Version 1.0)
     nstrace20 - NetScaler Trace (Version 2.0)
     nstrace30 - NetScaler Trace (Version 3.0)
+    nstrace35 - NetScaler Trace (Version 3.5)
     pcap - Wireshark/tcpdump/... - pcap
     pcapng - Wireshark/... - pcapng
     rf5 - Tektronix K12xx 32-bit .rf5 format
@@ -556,6 +572,7 @@ editcap: The available encapsulation types for the "-T" flag are:
     isdn - ISDN
     ixveriwave - IxVeriWave header and stats block
     jfif - JPEG/JFIF
+    json - JavaScript Object Notation
     juniper-atm1 - Juniper ATM1
     juniper-atm2 - Juniper ATM2
     juniper-chdlc - Juniper C-HDLC
@@ -584,6 +601,7 @@ editcap: The available encapsulation types for the "-T" flag are:
     logcat_thread - Android Logcat Thread text format
     logcat_threadtime - Android Logcat Threadtime text format
     logcat_time - Android Logcat Time text format
+    loop - OpenBSD loopback
     ltalk - Localtalk
     mime - MIME
     most - Media Oriented Systems Transport
@@ -601,7 +619,8 @@ editcap: The available encapsulation types for the "-T" flag are:
     nstrace10 - NetScaler Encapsulation 1.0 of Ethernet
     nstrace20 - NetScaler Encapsulation 2.0 of Ethernet
     nstrace30 - NetScaler Encapsulation 3.0 of Ethernet
-    null - NULL
+    nstrace35 - NetScaler Encapsulation 3.5 of Ethernet
+    null - NULL/Loopback
     packetlogger - PacketLogger
     pflog - OpenBSD PF Firewall logs
     pflog-old - OpenBSD PF Firewall logs, pre-3.4
@@ -718,9 +737,9 @@ FDDI capture if an Ethernet capture is read and `-T fddi` is specified).
 [[AppToolsmergecapEx]]
 .Help information available from mergecap
 ----
-Mergecap 1.12.1 (Git Rev Unknown from unknown)
+Mergecap (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Merge two or more capture files into one.
-See http://www.wireshark.org for more information.
+See https://www.wireshark.org for more information.
 
 Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]
 
@@ -731,9 +750,8 @@ Output:
   -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.
   -F <capture type> set the output file type; default is pcapng.
                     an empty "-F" option will list the file types.
-  -T <encap type>   set the output file encapsulation type;
-                    default is the same as the first input file.
-                    an empty "-T" option will list the encapsulation types.
+  -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.
+                    an empty "-I" option will list the merge modes.
 
 Miscellaneous:
   -h                display this help and exit.
@@ -812,9 +830,9 @@ full-packet decoder to handle these dumps.
 .Help information available from text2pcap
 
 ----
-Text2pcap 1.12.1 (Git Rev Unknown from unknown)
+Text2pcap (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Generate a capture file from an ASCII hexdump of packets.
-See http://www.wireshark.org for more information.
+See https://www.wireshark.org for more information.
 
 Usage: text2pcap [options] <infile> <outfile>
 
@@ -902,9 +920,9 @@ Miscellaneous:
 [[AppToolsreordercapEx]]
 .Help information available from reordercap
 ----
-Reordercap 1.12.1
+Reordercap (Wireshark) 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Reorder timestamps of input file frames into output file.
-See http://www.wireshark.org for more information.
+See https://www.wireshark.org for more information.
 
 Usage: reordercap [options] <infile> <outfile>
 
index 5f3d44caefbe697e2e37d792279dee814b226e64..ae920cdf71cfa0c76d1f11b16ba42bded71cea9b 100644 (file)
@@ -38,14 +38,10 @@ are, simply enter the command _wireshark -h_ and the help information shown in
 .Help information available from Wireshark
 ====
 ----
-Wireshark 1.12.1 (Git Rev Unknown from unknown)
+Wireshark 2.1.0 (v2.1.0rc0-502-g328fbc0 from master)
 Interactively dump and analyze network traffic.
 See https://www.wireshark.org for more information.
 
-Copyright 1998-2014 Gerald Combs <gerald@wireshark.org> and contributors.
-This is free software; see the source for copying conditions. There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-
 Usage: wireshark [options] ... [ <infile> ]
 
 Capture interface:
@@ -71,6 +67,8 @@ 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!)
 
@@ -78,12 +76,12 @@ Processing:
   -R <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): "mnNtCd"
-  --disable-protocol <proto_name> disable dissection of proto_name
-                           Repeat option for each protocol
-  --enable-heuristic <short_name> enable dissection of heuristic protocol
-                           Repeat option for each protocol
-  --disable-heuristic <short_name> disable dissection of heuristic protocol
-                           Repeat option for each protocol
+  --disable-protocol <proto_name>
+                           disable dissection of proto_name
+  --enable-heuristic <short_name>
+                           enable dissection of heuristic protocol
+  --disable-heuristic <short_name>
+                           disable dissection of heuristic protocol
 
 User interface:
   -C <config profile>      start with specified configuration profile
@@ -108,7 +106,6 @@ Miscellaneous:
                            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
 ----
 ====
 
index ab929c5eb78d9fb6e7b5f84886e93f62a50c4cdf..3775dbeac58061d5fe58775a525a1d7fd73b9dd6 100644 (file)
--- a/editcap.c
+++ b/editcap.c
@@ -1160,7 +1160,7 @@ DIAG_ON(cast-qual)
         case 'h':
             printf("Editcap (Wireshark) %s\n"
                    "Edit and/or translate the format of capture files.\n"
-                   "See http://www.wireshark.org for more information.\n",
+                   "See https://www.wireshark.org for more information.\n",
                get_ws_vcs_version_info());
             print_usage(stdout);
             exit(0);
index 146864dc897cc5236242b92113fbe84704429d5f..287653621c9bfcc5ce792cbfa0bbc155e18636d4 100644 (file)
@@ -322,7 +322,7 @@ DIAG_ON(cast-qual)
     case 'h':
       printf("Mergecap (Wireshark) %s\n"
              "Merge two or more capture files into one.\n"
-             "See http://www.wireshark.org for more information.\n",
+             "See https://www.wireshark.org for more information.\n",
              get_ws_vcs_version_info());
       print_usage(stdout);
       exit(0);
index 1becd58a046e0fc51584f6535ae853b17b310d68..b3c26eb63246c2c0b692dd8f2b8dd4bbbdfc2bdf 100644 (file)
@@ -605,7 +605,7 @@ DIAG_ON(cast-qual)
             case 'h':        /* Print help and exit */
                 printf("Rawshark (Wireshark) %s\n"
                        "Dump and analyze network traffic.\n"
-                       "See http://www.wireshark.org for more information.\n",
+                       "See https://www.wireshark.org for more information.\n",
                        get_ws_vcs_version_info());
                 print_usage(stdout);
                 exit(0);
index fef413dd7561a4fa8d51e06fb1c01a91c32d3328..e680dba2bb27b606f81ad1dc71e716a63137c494 100644 (file)
@@ -229,7 +229,7 @@ DIAG_ON(cast-qual)
             case 'h':
                 printf("Reordercap (Wireshark) %s\n"
                        "Reorder timestamps of input file frames into output file.\n"
-                       "See http://www.wireshark.org for more information.\n",
+                       "See https://www.wireshark.org for more information.\n",
                        get_ws_vcs_version_info());
                 print_usage(stdout);
                 exit(0);
index 89a93a2cc6d4dbb07ec4cc936846e35b2eef837c..ccc2a187b94fa4e29ee9413a7de4c15bff8776e6 100644 (file)
@@ -1564,7 +1564,7 @@ DIAG_ON(cast-qual)
         case 'h':
             printf("Text2pcap (Wireshark) %s\n"
                    "Generate a capture file from an ASCII hexdump of packets.\n"
-                   "See http://www.wireshark.org for more information.\n",
+                   "See https://www.wireshark.org for more information.\n",
                    get_ws_vcs_version_info());
             print_usage(stdout);
             exit(0);
index 8e4e4633307381fd741d04f65ae5d01074a1622b..64604c3cb4f8debaf5e419ab3feee7074adac58a 100644 (file)
@@ -164,7 +164,7 @@ print_usage(gboolean for_help_option) {
         output = stdout;
         fprintf(output, "Wireshark %s\n"
                 "Interactively dump and analyze network traffic.\n"
-                "See http://www.wireshark.org for more information.\n",
+                "See https://www.wireshark.org for more information.\n",
                 get_ws_vcs_version_info());
     } else {
         output = stderr;