Ignore:
Timestamp:
02/28/07 14:30:16 (15 years ago)
Author:
Shane Alcock <salcock@…>
Branches:
4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes
Children:
28d81c8
Parents:
3bfeb7d
Message:

Bringing a lot of the manpages up to date as well as adding a link to the wiki

File:
1 edited

Legend:

Unmodified
Added
Removed
  • tools/tracereport/tracereport.1

    r67825b2 r634089d  
    11.TH TRACEMERGE "1" "October 2006" "tracereport (libtrace)" "User Commands"
    22.SH NAME
    3 tracereport \- Report summary statistics on a trace
     3tracereport \- produce various reports on a trace (or traceset)
    44.SH SYNOPSIS
    55.B tracereport
     6[ \fB-f \fRbpf | \fB--filter=\fRbpf ]
     7[ \fB-e \fR| \fB --error \fR]
     8[ \fB-F \fR| \fB --flow \fR]
     9[ \fB-P \fR| \fB --protocol \fR]
     10[ \fB-p \fR| \fB --port \fR]
     11[ \fB-T \fR| \fB --tos \fR]
     12[ \fB-t \fR| \fB --ttl \fR]
     13[ \fB-O \fR| \fB --tcpoptions \fR]
     14[ \fB-o \fR| \fB --synoptions \fR]
     15[ \fB-n \fR| \fB --nlp \fR]
     16[ \fB-d \fR| \fB --direction \fR]
     17[ \fB-C \fR| \fB --ecn \fR]
     18[ \fB-s \fR| \fB --tcpsegment \fR]
    619inputuri...
    7 .SH DESCRPTION
    8 tracereport lists various summary statistics about a trace.
     20.P
     21.B tracereport
     22-H | --help
    923
    10 The sections are:
    11 .IP \(bu 4
    12 Errors
    13 .IP \(bu 4
    14 Flows
    15 .IP \(bu 4
    16 Type of Service
    17 .IP \(bu 4
    18 Protocol breakdown
    19 .IP \(bu 4
    20 Port breakdown
    21 .IP \(bu 4
    22 TTL breakdown
    23 .IP \(bu 4
    24 Direction
     24.SH DESCRIPTION
     25tracereport can produce a variety of reports on the properties of a trace.
     26The user specifies the reports required using command-line options.
     27.TP
     28.PD 0
     29.BI \-f " bpf-filter"
     30.TP
     31.PD 0
     32.BI \-\^\-filter " bpf-filter"
     33Only report on packets that match the provided bpf filter. See
     34tcpdump(1) for the syntax of the bpf-filter expression.
     35
     36.TP
     37.PD 0
     38.BI \-e
     39.TP
     40.PD 0
     41.BI \-\^\-error
     42Produce a report on packet errors (e.g checksum failures, rxerrors)
     43
     44.TP
     45.PD 0
     46.BI \-F
     47.TP
     48.PD 0
     49.BI \-\^\-flow
     50Produces a report on the number of flows observed in the trace
     51
     52.TP
     53.PD 0
     54.BI \-P
     55.TP
     56.PD 0
     57.BI \-\^\-protocol
     58Produces a report on which transport layer protocols are observed in the trace
     59
     60.TP
     61.PD 0
     62.BI \-p
     63.TP
     64.PD 0
     65.BI \-\^\-port
     66Produces a report on which port numbers are observed in the trace
     67
     68.TP
     69.PD 0
     70.BI \-T
     71.TP
     72.PD 0
     73.BI \-\^\-tos
     74Produces a report on the contents of the IP header's ToS field
     75
     76.TP
     77.PD 0
     78.BI \-t
     79.TP
     80.PD 0
     81.BI \-\^\-ttl
     82Produces a report on the TTL of packets in the trace
     83
     84.TP
     85.PD 0
     86.BI \-O
     87.TP
     88.PD 0
     89.BI \-\^\-tcpoptions
     90Produces a report on which TCP options are observed on all packets in the trace
     91
     92.TP
     93.PD 0
     94.BI \-o
     95.TP
     96.PD 0
     97.BI \-\^\-synoptions
     98Produces a report on which combinations of TCP options are observed on SYN packets in the trace
     99
     100.TP
     101.PD 0
     102.BI \-n
     103.TP
     104.PD 0
     105.BI \-\^\-nlp
     106Produces a report on the network layer protocols observed in the trace
     107
     108.TP
     109.PD 0
     110.BI \-d
     111.TP
     112.PD 0
     113.BI \-\^\-direction
     114Produces a report on how much traffic is travelling in each direction
     115
     116.TP
     117.PD 0
     118.BI \-C
     119.TP
     120.PD 0
     121.BI \-\^\-ecn
     122Produces a report on the usage of the ECN field of the TCP header
     123
     124.TP
     125.PD 0
     126.BI \-s
     127.TP
     128.PD 0
     129.BI \-\^\-tcpsegment
     130Produces a report on the sizes of TCP segments in the trace
     131
     132.TP
     133.PD 0
     134.BI \-H
     135.TP
     136.PD 0
     137.BI \-\^\-help
     138Provides usage instructions
     139
     140
     141.SH LINKS
     142More details about tracereport (and libtrace) can be found at
     143http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    25144
    26145.SH SEE ALSO
Note: See TracChangeset for help on using the changeset viewer.