| 1 | .TH TRACEREPORT "1" "October 2006" "tracereport (libtrace)" "User Commands" |
|---|
| 2 | .SH NAME |
|---|
| 3 | tracereport \- produce various reports on a trace (or traceset) |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .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-m \fR| \fB --misc \fR] |
|---|
| 10 | [ \fB-P \fR| \fB --protocol \fR] |
|---|
| 11 | [ \fB-p \fR| \fB --port \fR] |
|---|
| 12 | [ \fB-T \fR| \fB --tos \fR] |
|---|
| 13 | [ \fB-t \fR| \fB --ttl \fR] |
|---|
| 14 | [ \fB-O \fR| \fB --tcpoptions \fR] |
|---|
| 15 | [ \fB-o \fR| \fB --synoptions \fR] |
|---|
| 16 | [ \fB-n \fR| \fB --nlp \fR] |
|---|
| 17 | [ \fB-d \fR| \fB --direction \fR] |
|---|
| 18 | [ \fB-C \fR| \fB --ecn \fR] |
|---|
| 19 | [ \fB-s \fR| \fB --tcpsegment \fR] |
|---|
| 20 | inputuri... |
|---|
| 21 | .P |
|---|
| 22 | .B tracereport |
|---|
| 23 | -H | --help |
|---|
| 24 | |
|---|
| 25 | .SH DESCRIPTION |
|---|
| 26 | tracereport can produce a variety of reports on the properties of a trace. |
|---|
| 27 | The user specifies the reports required using command-line options. |
|---|
| 28 | .TP |
|---|
| 29 | .PD 0 |
|---|
| 30 | .BI \-f " bpf-filter" |
|---|
| 31 | .TP |
|---|
| 32 | .PD 0 |
|---|
| 33 | .BI \-\^\-filter " bpf-filter" |
|---|
| 34 | Only report on packets that match the provided bpf filter. See |
|---|
| 35 | tcpdump(1) for the syntax of the bpf-filter expression. |
|---|
| 36 | |
|---|
| 37 | .TP |
|---|
| 38 | .PD 0 |
|---|
| 39 | .BI \-e |
|---|
| 40 | .TP |
|---|
| 41 | .PD 0 |
|---|
| 42 | .BI \-\^\-error |
|---|
| 43 | Produce a report on packet errors (e.g checksum failures, rxerrors) |
|---|
| 44 | |
|---|
| 45 | .TP |
|---|
| 46 | .PD 0 |
|---|
| 47 | .BI \-F |
|---|
| 48 | .TP |
|---|
| 49 | .PD 0 |
|---|
| 50 | .BI \-\^\-flow |
|---|
| 51 | Produces a report on the number of flows observed in the trace |
|---|
| 52 | |
|---|
| 53 | .TP |
|---|
| 54 | .PD 0 |
|---|
| 55 | .BI \-m |
|---|
| 56 | .TP |
|---|
| 57 | .PD 0 |
|---|
| 58 | .BI \-\^\-misc |
|---|
| 59 | Provides a report listing the time of the first packet, and the time of the |
|---|
| 60 | last packet in the trace, the duration, the total number of packets in the |
|---|
| 61 | trace, and the average number of packets per second. |
|---|
| 62 | |
|---|
| 63 | .TP |
|---|
| 64 | .PD 0 |
|---|
| 65 | .BI \-P |
|---|
| 66 | .TP |
|---|
| 67 | .PD 0 |
|---|
| 68 | .BI \-\^\-protocol |
|---|
| 69 | Produces a report on which transport layer protocols are observed in the trace |
|---|
| 70 | |
|---|
| 71 | .TP |
|---|
| 72 | .PD 0 |
|---|
| 73 | .BI \-p |
|---|
| 74 | .TP |
|---|
| 75 | .PD 0 |
|---|
| 76 | .BI \-\^\-port |
|---|
| 77 | Produces a report on which port numbers are observed in the trace |
|---|
| 78 | |
|---|
| 79 | .TP |
|---|
| 80 | .PD 0 |
|---|
| 81 | .BI \-T |
|---|
| 82 | .TP |
|---|
| 83 | .PD 0 |
|---|
| 84 | .BI \-\^\-tos |
|---|
| 85 | Produces a report on the contents of the IP header's ToS field |
|---|
| 86 | |
|---|
| 87 | .TP |
|---|
| 88 | .PD 0 |
|---|
| 89 | .BI \-t |
|---|
| 90 | .TP |
|---|
| 91 | .PD 0 |
|---|
| 92 | .BI \-\^\-ttl |
|---|
| 93 | Produces a report on the TTL of packets in the trace |
|---|
| 94 | |
|---|
| 95 | .TP |
|---|
| 96 | .PD 0 |
|---|
| 97 | .BI \-O |
|---|
| 98 | .TP |
|---|
| 99 | .PD 0 |
|---|
| 100 | .BI \-\^\-tcpoptions |
|---|
| 101 | Produces a report on which TCP options are observed on all packets in the trace |
|---|
| 102 | |
|---|
| 103 | .TP |
|---|
| 104 | .PD 0 |
|---|
| 105 | .BI \-o |
|---|
| 106 | .TP |
|---|
| 107 | .PD 0 |
|---|
| 108 | .BI \-\^\-synoptions |
|---|
| 109 | Produces a report on which combinations of TCP options are observed on SYN packets in the trace |
|---|
| 110 | |
|---|
| 111 | .TP |
|---|
| 112 | .PD 0 |
|---|
| 113 | .BI \-n |
|---|
| 114 | .TP |
|---|
| 115 | .PD 0 |
|---|
| 116 | .BI \-\^\-nlp |
|---|
| 117 | Produces a report on the network layer protocols observed in the trace |
|---|
| 118 | |
|---|
| 119 | .TP |
|---|
| 120 | .PD 0 |
|---|
| 121 | .BI \-d |
|---|
| 122 | .TP |
|---|
| 123 | .PD 0 |
|---|
| 124 | .BI \-\^\-direction |
|---|
| 125 | Produces a report on how much traffic is travelling in each direction |
|---|
| 126 | |
|---|
| 127 | .TP |
|---|
| 128 | .PD 0 |
|---|
| 129 | .BI \-C |
|---|
| 130 | .TP |
|---|
| 131 | .PD 0 |
|---|
| 132 | .BI \-\^\-ecn |
|---|
| 133 | Produces a report on the usage of the ECN field of the TCP header |
|---|
| 134 | |
|---|
| 135 | .TP |
|---|
| 136 | .PD 0 |
|---|
| 137 | .BI \-s |
|---|
| 138 | .TP |
|---|
| 139 | .PD 0 |
|---|
| 140 | .BI \-\^\-tcpsegment |
|---|
| 141 | Produces a report on the sizes of TCP segments in the trace |
|---|
| 142 | |
|---|
| 143 | .TP |
|---|
| 144 | .PD 0 |
|---|
| 145 | .BI \-H |
|---|
| 146 | .TP |
|---|
| 147 | .PD 0 |
|---|
| 148 | .BI \-\^\-help |
|---|
| 149 | Provides usage instructions |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | .SH LINKS |
|---|
| 153 | More details about tracereport (and libtrace) can be found at |
|---|
| 154 | http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation |
|---|
| 155 | |
|---|
| 156 | .SH SEE ALSO |
|---|
| 157 | libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), tracefilter(1), |
|---|
| 158 | traceconvert(1), tracestats(1), tracertstats(1), tracereport(1), |
|---|
| 159 | tracepktdump(1), traceanon(1), tracesummary(1), tracereplay(1), tracediff(1) |
|---|
| 160 | |
|---|
| 161 | .SH AUTHORS |
|---|
| 162 | Perry Lorier <perry@cs.waikato.ac.nz> |
|---|
