Ignore:
Timestamp:
09/09/11 11:35:01 (10 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:
fc01bee
Parents:
c29a0e0
Message:
  • Updated traceends and tracetopends manpages to be about them instead of tracesplit
  • Updated all other manpages to include new tools in their "See also" lists
  • Changed -a argument for traceends to -A to be consistent with tracetopends
File:
1 edited

Legend:

Unmodified
Added
Removed
  • tools/traceends/traceends.1

    rc29a0e0 rd6dc0f6  
    1 .TH TRACESPLIT "1" "January 2011" "tracesplit (libtrace)" "User Commands"
     1.TH TRACEENDS "1" "September 2011" "traceends (libtrace)" "User Commands"
    22.SH NAME
    3 tracesplit \- split traces
     3traceends \- summarise traffic done by every endpoint observed in a trace
    44.SH SYNOPSIS
    5 .B tracesplit
     5.B tracetopends
    66[ \fB-f \fRbpf | \fB--filter=\fRbpf]
    7 [ \fB-c \fRcount | \fB--count=\fRcount]
    8 [ \fB-b \fRbytes | \fB--bytes=\fRbytes]
    9 [ \fB-i \fRseconds | \fB--seconds=\fRseconds]
    10 [ \fB-s \fRunixtime | \fB--starttime=\fRunixtime]
    11 [ \fB-e \fRunixtime | \fB--endtime=\fRunixtime]
    12 [ \fB-m \fRmaxfiles | \fB--maxfiles=\fRmaxfiles]
    13 [ \fB-S \fRsnaplen | \fB--snaplen=\fRsnaplen]
    14 [ \fB-z \fRlevel | \fB--compress-level=\fRlevel]
    15 [ \fB-Z \fRmethod | \fB--compress-type=\fRmethod]
    16 inputuri [inputuri ...] outputuri
     7[ \fB-a \fRaddrtype | \fB--address=\fRaddrtype]
     8[ \fB-H | \fB--help]
     9
     10inputuri [inputuri ...]
    1711.SH DESCRIPTION
    18 tracesplit splits the given input traces into multiple tracefiles
     12traceends reports the number of bytes and packets sent and received by each
     13endpoint observed in the input trace(s). Usually, you don't want to run this
     14program directly \-\- see \fBtracetopends\fR instead.
     15
    1916.TP
    2017\fB\-f\fR bpf filter
     
    2219
    2320.TP
    24 \fB\-c\fR count
    25 output count packets per output file.  The output file will be named after
    26 the basename given in the outputuri with the packet number of the first packet
    27 in this file.
     21\fB\-A\fR address type
     22Specifies how an endpoint should be defined. Suitable options are "mac", "v4"
     23and "v6" which will report endpoint stats for each observed MAC address, IPv4
     24address and IPv6 address respectively.
    2825
    29 .TP
    30 \fB\-b\fR bytes
    31 output bytes bytes per file
     26.SH OUTPUT
     27Output is written to stdout in columns separated by blank space.
    3228
    33 .TP
    34 \fB\-i\fR seconds
    35 start a new tracefile after "seconds" seconds
    36 
    37 .TP
    38 \fB\-s\fR unixtime
    39 don't output any packets before unixtime
    40 
    41 .TP
    42 \fB\-e\fR unixtime
    43 don't output any packets after unixtime
    44 
    45 .TP
    46 \fB\-m\fR maxfiles
    47 do not create more than "maxfiles" trace files
    48 
    49 .TP
    50 \fB\-S\fR snaplen
    51 Truncate packets to "snaplen" bytes long.  The default is collect the entire
    52 packet.
    53 
    54 .TP
    55 \fB\-z\fR level
    56 Compress the data using the specified compression level, ranging from 0 to 9.
    57 Higher compression levels tend to result in better compression but require
    58 more processing power to compress.
    59 
    60 .TP
    61 \fB-Z\fR compression-method
    62 Compress the data using the specified compression algorithm. Accepted methods
    63 are "gzip", "bzip2", "lzo" or "none". Default value is none unless a
    64 compression level is specified, in which case gzip will be used.
     29The columns are (in order):
     30 * Endpoint address
     31 * Time last observed
     32 * Packets originating from the endpoint
     33 * Bytes originating from the endpoint (IP header onwards)
     34 * Payload originating from the endpoint (post transport header)
     35 * Packets sent to the endpoint
     36 * Bytes sent to the endpoint (IP header onwards)
     37 * Payload sent to the endpoint (post transport header)
    6538
    6639.SH EXAMPLES
    67 create a 1MB erf trace of port 80 traffic.
     40Get stats for each individual MAC address in a trace:
    6841.nf
    69 tracesplit \-z 1 -Z gzip \-f 'port 80' \-b $[ 1024 * 1024 ]
    70 erf:/traces/bigtrace.gz erf:/traces/port80.gz
     42traceends -a mac erf:trace.erf.gz
    7143.fi
    7244
    7345.SH LINKS
    74 More details about tracesplit (and libtrace) can be found at
     46More details about traceends (and libtrace) can be found at
    7547http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    7648
     
    7850libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit_dir(1),
    7951tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
    80 tracesummary(1), tracereplay(1), tracediff(1)
     52tracesummary(1), tracereplay(1), tracediff(1), tracetopends(1)
    8153
    8254.SH AUTHORS
    83 Perry Lorier <perry@cs.waikato.ac.nz>
     55Shane Alcock <salcock@cs.waikato.ac.nz>
Note: See TracChangeset for help on using the changeset viewer.