Introduce --time-stamp-precision

[tcpdump] / tcpdump.1.in

diff --git a/tcpdump.1.in b/tcpdump.1.in
index 0bf030c1197164f58f5e067a0b140495f1b23f3b..3cceb4683fba647570e997f6d6fa701db9f2fb6f 100644 (file)
--- a/tcpdump.1.in
+++ b/tcpdump.1.in
@@ -20,7 +20,7 @@
 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 .\"
 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 .\"

-.TH TCPDUMP 1  "13 December 2013"
+.TH TCPDUMP 1  "6 May 2014"

 .SH NAME
 tcpdump \- dump traffic on a network
 .SH SYNOPSIS
 .SH NAME
 tcpdump \- dump traffic on a network
 .SH SYNOPSIS


@@ -68,6 +68,9 @@ tcpdump \- dump traffic on a network
 .br
 .ti +8
 [
 .br
 .ti +8
 [

+.B \-\-number
+]
+[

 .B \-Q
 .I in|out|inout
 ]
 .B \-Q
 .I in|out|inout
 ]


@@ -120,6 +123,9 @@ tcpdump \- dump traffic on a network
 ]
 .ti +8
 [
 ]
 .ti +8
 [

+.B \-\-version
+]
+[

 .I expression
 ]
 .br
 .I expression
 ]
 .br


@@ -208,14 +214,18 @@ capturing web pages.
 Print the AS number in BGP packets in ASDOT notation rather than ASPLAIN
 notation.
 .TP
 Print the AS number in BGP packets in ASDOT notation rather than ASPLAIN
 notation.
 .TP

-.B \-B
+.BI \-B " buffer_size"
+.PD 0
+.TP
+.BI \-\-buffer\-size= buffer_size
+.PD

 Set the operating system capture buffer size to \fIbuffer_size\fP, in
 units of KiB (1024 bytes).
 .TP
 Set the operating system capture buffer size to \fIbuffer_size\fP, in
 units of KiB (1024 bytes).
 .TP

-.B \-c
+.BI \-c " count"

 Exit after receiving \fIcount\fP packets.
 .TP
 Exit after receiving \fIcount\fP packets.
 .TP

-.B \-C
+.BI \-C " file_size"

 Before writing a raw packet to a savefile, check whether the file is
 currently larger than \fIfile_size\fP and, if so, close the current
 savefile and open a new one.  Savefiles after the first savefile will
 Before writing a raw packet to a savefile, check whether the file is
 currently larger than \fIfile_size\fP and, if so, close the current
 savefile and open a new one.  Savefiles after the first savefile will


@@ -238,6 +248,10 @@ program fragment.
 Dump packet-matching code as decimal numbers (preceded with a count).
 .TP
 .B \-D
 Dump packet-matching code as decimal numbers (preceded with a count).
 .TP
 .B \-D

+.PD 0
+.TP
+.B \-\-list\-interfaces
+.PD

 Print the list of the network interfaces available on the system and on
 which
 .I tcpdump
 Print the list of the network interfaces available on the system and on
 which
 .I tcpdump


@@ -317,11 +331,11 @@ because the capture is being done on the Linux "any" interface, which
 can capture on more than one interface, this option will not work
 correctly.
 .TP
 can capture on more than one interface, this option will not work
 correctly.
 .TP

-.B \-F
+.BI \-F " file"

 Use \fIfile\fP as input for the filter expression.
 An additional expression given on the command line is ignored.
 .TP
 Use \fIfile\fP as input for the filter expression.
 An additional expression given on the command line is ignored.
 .TP

-.B \-G
+.BI \-G " rotate_seconds"

 If specified, rotates the dump file specified with the
 .B \-w
 option every \fIrotate_seconds\fP seconds.
 If specified, rotates the dump file specified with the
 .B \-w
 option every \fIrotate_seconds\fP seconds.


@@ -336,13 +350,25 @@ If used in conjunction with the
 option, filenames will take the form of `\fIfile\fP<count>'.
 .TP
 .B \-h
 option, filenames will take the form of `\fIfile\fP<count>'.
 .TP
 .B \-h

+.PD 0
+.TP
+.B \-\-help
+.PD

 Print the tcpdump and libpcap version strings, print a usage message,
 and exit.
 .TP
 Print the tcpdump and libpcap version strings, print a usage message,
 and exit.
 .TP

+.B \-\-version
+.PD
+Print the tcpdump and libpcap version strings and exit.
+.TP

 .B \-H
 Attempt to detect 802.11s draft mesh headers.
 .TP
 .B \-H
 Attempt to detect 802.11s draft mesh headers.
 .TP

-.B \-i
+.BI \-i " interface"
+.PD 0
+.TP
+.BI \-\-interface= interface
+.PD

 Listen on \fIinterface\fP.
 If unspecified, \fItcpdump\fP searches the system interface list for the
 lowest numbered, configured up interface (excluding loopback), which may turn
 Listen on \fIinterface\fP.
 If unspecified, \fItcpdump\fP searches the system interface list for the
 lowest numbered, configured up interface (excluding loopback), which may turn


@@ -362,6 +388,10 @@ used as the
 argument.
 .TP
 .B \-I
 argument.
 .TP
 .B \-I

+.PD 0
+.TP
+.B \-\-monitor\-mode
+.PD

 Put the interface in "monitor mode"; this is supported only on IEEE
 802.11 Wi-Fi interfaces, and supported only on some operating systems.
 .IP
 Put the interface in "monitor mode"; this is supported only on IEEE
 802.11 Wi-Fi interfaces, and supported only on some operating systems.
 .IP


@@ -382,7 +412,11 @@ monitor mode will be shown; if
 is specified, only those link-layer types available when in monitor mode
 will be shown.
 .TP
 is specified, only those link-layer types available when in monitor mode
 will be shown.
 .TP

-.B \-j
+.BI \-j " tstamp_type"
+.PD 0
+.TP
+.BI \-\-time\-stamp\-type= tstamp_type
+.PD

 Set the time stamp type for the capture to \fItstamp_type\fP.  The names
 to use for the time stamp types are given in
 .BR pcap-tstamp (@MAN_MISC_INFO@);
 Set the time stamp type for the capture to \fItstamp_type\fP.  The names
 to use for the time stamp types are given in
 .BR pcap-tstamp (@MAN_MISC_INFO@);


@@ -390,11 +424,28 @@ not all the types listed there will necessarily be valid for any given
 interface.
 .TP
 .B \-J
 interface.
 .TP
 .B \-J

+.PD 0
+.TP
+.B \-\-list\-time\-stamp\-types
+.PD

 List the supported time stamp types for the interface and exit.  If the
 time stamp type cannot be set for the interface, no time stamp types are
 listed.
 .TP
 List the supported time stamp types for the interface and exit.  If the
 time stamp type cannot be set for the interface, no time stamp types are
 listed.
 .TP

+.BI \-\-time\-stamp\-precision= tstamp_precision
+.PD
+Set the time stamp precision for the capture to
+\fItstamp_precision\fP. Currently supported are microseconds and
+nanoseconds. Note that availability of high precision time stamps (nanoseconds)
+and their actual accuracy is platform and HW dependent. Also note that when
+writing captures to the savefile, distinct magic number is used to distinguish
+savefiles which contains time stamps in nanoseconds.
+.TP

 .B \-K
 .B \-K

+.PD 0
+.TP
+.B \-\-dont\-verify\-checksums
+.PD

 Don't attempt to verify IP, TCP, or UDP checksums.  This is useful for
 interfaces that perform some or all of those checksum calculation in
 hardware; otherwise, all outgoing TCP checksums will be flagged as bad.
 Don't attempt to verify IP, TCP, or UDP checksums.  This is useful for
 interfaces that perform some or all of those checksum calculation in
 hardware; otherwise, all outgoing TCP checksums will be flagged as bad.


@@ -437,6 +488,10 @@ than at the end of each line; this is buffered on all platforms,
 including Windows.
 .TP
 .B \-L
 including Windows.
 .TP
 .B \-L

+.PD 0
+.TP
+.B \-\-list\-data\-link\-types
+.PD

 List the known data link types for the interface, in the specified mode,
 and exit.  The list of known data link types may be dependent on the
 specified mode; for example, on some platforms, a Wi-Fi interface might
 List the known data link types for the interface, in the specified mode,
 and exit.  The list of known data link types may be dependent on the
 specified mode; for example, on some platforms, a Wi-Fi interface might


@@ -447,12 +502,12 @@ and another set of data link types when in monitor mode (for example, it
 might support 802.11 headers, or 802.11 headers with radio information,
 only in monitor mode).
 .TP
 might support 802.11 headers, or 802.11 headers with radio information,
 only in monitor mode).
 .TP

-.B \-m
+.BI \-m " module"

 Load SMI MIB module definitions from file \fImodule\fR.
 This option
 can be used several times to load several MIB modules into \fItcpdump\fP.
 .TP
 Load SMI MIB module definitions from file \fImodule\fR.
 This option
 can be used several times to load several MIB modules into \fItcpdump\fP.
 .TP

-.B \-M
+.BI \-M " secret"

 Use \fIsecret\fP as a shared secret for validating the digests found in
 TCP segments with the TCP-MD5 option (RFC 2385), if present.
 .TP
 Use \fIsecret\fP as a shared secret for validating the digests found in
 TCP segments with the TCP-MD5 option (RFC 2385), if present.
 .TP


@@ -465,19 +520,34 @@ E.g.,
 if you give this flag then \fItcpdump\fP will print ``nic''
 instead of ``nic.ddn.mil''.
 .TP
 if you give this flag then \fItcpdump\fP will print ``nic''
 instead of ``nic.ddn.mil''.
 .TP

+.B \-\-number
+Print an optional packet number at the beginning of the line.
+.TP

 .B \-O
 .B \-O

+.PD 0
+.TP
+.B \-\-no\-optimize
+.PD

 Do not run the packet-matching code optimizer.
 This is useful only
 if you suspect a bug in the optimizer.
 .TP
 .B \-p
 Do not run the packet-matching code optimizer.
 This is useful only
 if you suspect a bug in the optimizer.
 .TP
 .B \-p

+.PD 0
+.TP
+.B \-\-no\-promiscuous\-mode
+.PD

 \fIDon't\fP put the interface
 into promiscuous mode.
 Note that the interface might be in promiscuous
 mode for some other reason; hence, `-p' cannot be used as an abbreviation for
 `ether host {local-hw-addr} or ether broadcast'.
 .TP
 \fIDon't\fP put the interface
 into promiscuous mode.
 Note that the interface might be in promiscuous
 mode for some other reason; hence, `-p' cannot be used as an abbreviation for
 `ether host {local-hw-addr} or ether broadcast'.
 .TP

-.B \-Q
+.BI \-Q " direction"
+.PD 0
+.TP
+.BI \-\-direction= direction
+.PD

 Choose send/receive direction \fIdirection\fR for which packets should be
 captured. Possible values are `in', `out' and `inout'. Not available
 on all platforms.
 Choose send/receive direction \fIdirection\fR for which packets should be
 captured. Possible values are `in', `out' and `inout'. Not available
 on all platforms.


@@ -493,16 +563,24 @@ If specified, \fItcpdump\fP will not print replay prevention field.
 Since there is no protocol version field in ESP/AH specification,
 \fItcpdump\fP cannot deduce the version of ESP/AH protocol.
 .TP
 Since there is no protocol version field in ESP/AH specification,
 \fItcpdump\fP cannot deduce the version of ESP/AH protocol.
 .TP

-.B \-r
+.BI \-r " file"

 Read packets from \fIfile\fR (which was created with the
 .B \-w
 Read packets from \fIfile\fR (which was created with the
 .B \-w

-option).
+option or by other tools that write pcap or pcap-ng files).

 Standard input is used if \fIfile\fR is ``-''.
 .TP
 .B \-S
 Standard input is used if \fIfile\fR is ``-''.
 .TP
 .B \-S

+.PD 0
+.TP
+.B \-\-absolute\-tcp\-sequence\-numbers
+.PD

 Print absolute, rather than relative, TCP sequence numbers.
 .TP
 Print absolute, rather than relative, TCP sequence numbers.
 .TP

-.B \-s
+.BI \-s " snaplen"
+.PD 0
+.TP
+.BI \-\-snapshot\-length= snaplen
+.PD

 Snarf \fIsnaplen\fP bytes of data from each packet rather than the
 default of 65535 bytes.
 Packets truncated because of a limited snapshot
 Snarf \fIsnaplen\fP bytes of data from each packet rather than the
 default of 65535 bytes.
 Packets truncated because of a limited snapshot


@@ -520,7 +598,7 @@ Setting
 for backwards compatibility with recent older versions of
 .IR tcpdump .
 .TP
 for backwards compatibility with recent older versions of
 .IR tcpdump .
 .TP

-.B \-T
+.BI \-T " type"

 Force packets selected by "\fIexpression\fP" to be interpreted the
 specified \fItype\fR.
 Currently known types are
 Force packets selected by "\fIexpression\fP" to be interpreted the
 specified \fItype\fR.
 Currently known types are


@@ -573,6 +651,10 @@ on each dump line.
 Print undecoded NFS handles.
 .TP
 .B \-U
 Print undecoded NFS handles.
 .TP
 .B \-U

+.PD 0
+.TP
+.B \-\-packet\-buffered
+.PD

 If the
 .B \-w
 option is not specified, make the printed packet output
 If the
 .B \-w
 option is not specified, make the printed packet output


@@ -623,11 +705,11 @@ With
 .B \-X
 Telnet options are printed in hex as well.
 .TP
 .B \-X
 Telnet options are printed in hex as well.
 .TP

-.B \-V
+.BI \-V " file"

 Read a list of filenames from \fIfile\fR. Standard input is used
 if \fIfile\fR is ``-''.
 .TP
 Read a list of filenames from \fIfile\fR. Standard input is used
 if \fIfile\fR is ``-''.
 .TP

-.B \-w
+.BI \-w " file"

 Write the raw packets to \fIfile\fR rather than parsing and printing
 them out.
 They can later be printed with the \-r option.
 Write the raw packets to \fIfile\fR rather than parsing and printing
 them out.
 They can later be printed with the \-r option.


@@ -700,10 +782,14 @@ each packet,
 .I including
 its link level header, in hex and ASCII.
 .TP
 .I including
 its link level header, in hex and ASCII.
 .TP

-.B \-y
+.BI \-y " datalinktype"
+.PD 0
+.TP
+.BI \-\-linktype= datalinktype
+.PD

 Set the data link type to use while capturing packets to \fIdatalinktype\fP.
 .TP
 Set the data link type to use while capturing packets to \fIdatalinktype\fP.
 .TP

-.B \-z
+.BI \-z " postrotate-command"

 Used in conjunction with the
 .B -C
 or
 Used in conjunction with the
 .B -C
 or


@@ -711,7 +797,7 @@ or
 options, this will make
 .I tcpdump
 run "
 options, this will make
 .I tcpdump
 run "

-.I command file
+.I postrotate-command file

 " where
 .I file
 is the savefile being closed after each rotation. For example, specifying
 " where
 .I file
 is the savefile being closed after each rotation. For example, specifying


@@ -728,7 +814,11 @@ different arguments, you can always write a shell script that will take the
 savefile name as the only argument, make the flags & arguments arrangements
 and execute the command that you want.
 .TP
 savefile name as the only argument, make the flags & arguments arrangements
 and execute the command that you want.
 .TP

-.B \-Z
+.BI \-Z " user"
+.PD 0
+.TP
+.BI \-\-relinquish\-privileges= user
+.PD

 If
 .I tcpdump
 is running as root, after opening the capture device or input savefile,
 If
 .I tcpdump
 is running as root, after opening the capture device or input savefile,


@@ -1410,43 +1500,45 @@ Sun NFS (Network File System) requests and replies are printed as:
 .RS
 .nf
 .sp .5
 .RS
 .nf
 .sp .5

-\fIsrc.xid > dst.nfs: len op args\fP
-\fIsrc.nfs > dst.xid: reply stat len op results\fP
+\fIsrc.sport > dst.nfs: NFS request xid xid len op args\fP
+\fIsrc.nfs > dst.dport: NFS reply xid xid reply stat len op results\fP

 .sp .5
 \f(CW
 .sp .5
 \f(CW

-sushi.6709 > wrl.nfs: 112 readlink fh 21,24/10.73165
-wrl.nfs > sushi.6709: reply ok 40 readlink "../var"
-sushi.201b > wrl.nfs:
+sushi.1023 > wrl.nfs: NFS request xid 26377
+       112 readlink fh 21,24/10.73165
+wrl.nfs > sushi.1023: NFS reply xid 26377
+       reply ok 40 readlink "../var"
+sushi.1022 > wrl.nfs: NFS request xid 8219

        144 lookup fh 9,74/4096.6878 "xcolors"
        144 lookup fh 9,74/4096.6878 "xcolors"

-wrl.nfs > sushi.201b:
+wrl.nfs > sushi.1022: NFS reply xid 8219

        reply ok 128 lookup fh 9,74/4134.3150
 \fR
 .sp .5
 .fi
 .RE
        reply ok 128 lookup fh 9,74/4134.3150
 \fR
 .sp .5
 .fi
 .RE

-In the first line, host \fIsushi\fP sends a transaction with id \fI6709\fP
+In the first line, host \fIsushi\fP sends a transaction with id \fI26377\fP

 to \fIwrl\fP.
 to \fIwrl\fP.

-(Note that for UDP NFS packets the standard UDP header isn't printed and the
-number following the src host is a transaction id, \fInot\fP the source port.
-The example above represents UDP NFS traffic.
-For TCP NFS packets port numbers are printed as part of the standard TCP header
-and the transaction id is printed separately as "xid" field of the packet.)

 The request was 112 bytes,
 excluding the UDP and IP headers.
 The operation was a \fIreadlink\fP
 (read symbolic link) on file handle (\fIfh\fP) 21,24/10.731657119.
 (If one is lucky, as in this case, the file handle can be interpreted
 as a major,minor device number pair, followed by the inode number and
 The request was 112 bytes,
 excluding the UDP and IP headers.
 The operation was a \fIreadlink\fP
 (read symbolic link) on file handle (\fIfh\fP) 21,24/10.731657119.
 (If one is lucky, as in this case, the file handle can be interpreted
 as a major,minor device number pair, followed by the inode number and

-generation number.)
-\fIWrl\fP replies `ok' with the contents of the link.
+generation number.) In the second line, \fIwrl\fP replies `ok' with
+the same transaction id and the contents of the link.
+.LP
+In the third line, \fIsushi\fP asks (using a new transaction id) \fIwrl\fP
+to lookup the name `\fIxcolors\fP' in directory file 9,74/4096.6878. In
+the fourth line, \fIwrl\fP sends a reply with the respective transaction id.

 .LP
 .LP

-In the third line, \fIsushi\fP asks \fIwrl\fP to lookup the name
-`\fIxcolors\fP' in directory file 9,74/4096.6878.

 Note that the data printed
 depends on the operation type.
 The format is intended to be self
 explanatory if read in conjunction with
 an NFS protocol spec.
 Note that the data printed
 depends on the operation type.
 The format is intended to be self
 explanatory if read in conjunction with
 an NFS protocol spec.

+Also note that older versions of tcpdump printed NFS packets in a
+slightly different format: the transaction id (xid) would be printed
+instead of the non-NFS port number of the packet.

 .LP
 If the \-v (verbose) flag is given, additional information is printed.
 For example:
 .LP
 If the \-v (verbose) flag is given, additional information is printed.
 For example:


@@ -1454,9 +1546,9 @@ For example:
 .nf
 .sp .5
 \f(CW
 .nf
 .sp .5
 \f(CW

-sushi.1372a > wrl.nfs:
+sushi.1023 > wrl.nfs: NFS request xid 79658

        148 read fh 21,11/12.195 8192 bytes @ 24576
        148 read fh 21,11/12.195 8192 bytes @ 24576

-wrl.nfs > sushi.1372a:
+wrl.nfs > sushi.1023: NFS reply xid 79658

        reply ok 1472 read REG 100664 ids 417/0 sz 29388
 \fP
 .sp .5
        reply ok 1472 read REG 100664 ids 417/0 sz 29388
 \fP
 .sp .5