Changeset 1481ba7


Ignore:
Timestamp:
01/21/10 16:55:17 (11 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:
8bc167a
Parents:
c2afda6
Message:

Updated manpages for all existing tools

  • Ensure the SEE ALSO sections refers to *all* other tools (including tracediff which will be added shortly)
  • Corrected some errors due to careless copying of earlier manpages
  • Fixed some typos and grammatical errors as well
Location:
tools
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • tools/traceanon/traceanon.1

    r634089d r1481ba7  
    7575libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracestats(1),
    7676tracesummary(1), tracertstats(1), tracesplit(1), tracesplit_dir(1),
    77 tracereport(1), tracedump(1)
     77tracereport(1), tracepktdump(1), tracediff(1), tracereplay(1)
    7878
    7979.SH AUTHORS
  • tools/tracemerge/tracemerge.1

    r37f2a9b r1481ba7  
    5050.SH SEE ALSO
    5151libtrace(3), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    52 traceconvert(1), tracereport(1), tracertstats(1), tracestats(1), tracedump(1),
    53 traceanon(1), tracesummary(1)
     52traceconvert(1), tracereport(1), tracertstats(1), tracestats(1),
     53tracepktdump(1), traceanon(1), tracesummary(1), tracereplay(1),
     54tracediff(1)
    5455
    5556.SH AUTHORS
  • tools/tracepktdump/tracepktdump.1

    r83f2cbf r1481ba7  
    1 .TH TRACEDUMP "1" "November 2005" "tracedump (libtrace)" "User Commands"
     1.TH TRACEPKTDUMP "1" "November 2005" "tracepktdump (libtrace)" "User Commands"
    22.SH NAME
    3 tracedump \- output packets in human readable format
     3tracepktdump \- output packets in human readable format
    44.SH SYNOPSIS
    5 .B tracedump
     5.B tracepktdump
    66[ \fB-f\fR exp | \fB--filter=\fRexp ]
    77[ \fB-c\fR num | \fB--count=\fRnum ]
     
    99
    1010.SH DESCRPTION
    11 tracedump verbosely outputs packets in a human readable form, suitable for
     11tracepktdump verbosely outputs packets in a human readable form, suitable for
    1212diagnosing packets.
    1313
    14 tracedump uses the libpacketdump library.  There is an examlpe tracedump
     14tracepktdump uses the libpacketdump library.  There is an example tracepktdump
    1515program in the examples directory that shows how to use libpacketdump.
    1616
     
    3333
    3434.SH LINKS
    35 More details about tracedump (and libtrace) can be found at
     35More details about tracepktdump (and libtrace) can be found at
    3636http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    3737
    3838.SH SEE ALSO
    3939libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    40 tracestats(1), tracesummary(1), traceconvert(1), tracereport(1) tracertstats(1),
    41 traceanon(1)
     40tracestats(1), tracesummary(1), traceconvert(1), tracereport(1),
     41tracertstats(1), traceanon(1), tracereplay(1), tracediff(1)
    4242
    4343.SH AUTHORS
  • tools/tracereplay/tracereplay.1

    r706cd57 r1481ba7  
    1 .TH TRACEMERGE "1" "November 2009" "tracereplay (libtrace)" "User Commands"
     1.TH TRACEREPLAY "1" "November 2009" "tracereplay (libtrace)" "User Commands"
    22.SH NAME
    33tracereplay \- Replay a trace in trace time from one uri to another
     
    2727.PD
    2828.BI \-\^\-snaplength [snaplength]
    29 Truncate the packets to the length specified. This is only makes a difference
    30  if the inputuri is a capture device. The value should be > 0. Wrong values will
    31 be ignored, but a warning will be printed.
     29Truncate the packets to the length specified. This only makes a difference
     30if the inputuri is a capture device. The value should be > 0. Inappropriate
     31values will be ignored, but a warning will be printed.
    3232
    3333.TP
     
    4040
    4141.SH LINKS
    42 More details about tracemerge (and libtrace) can be found at
     42More details about tracereplay (and libtrace) can be found at
    4343http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    4444
    4545.SH SEE ALSO
    46 libtrace(3), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    47 traceconvert(1), tracereport(1), tracertstats(1), tracestats(1), tracedump(1),
    48 traceanon(1), tracesummary(1)
     46libtrace(3), tracesplit(1), tracesplit_dir(1), tracefilter(1), tracemerge(1),
     47traceconvert(1), tracereport(1), tracertstats(1), tracestats(1),
     48tracepktdump(1), traceanon(1), tracesummary(1), tracediff(1)
    4949
    5050.SH AUTHORS
  • tools/tracereport/tracereport.1

    r7be3cc4 r1481ba7  
    1 .TH TRACEMERGE "1" "October 2006" "tracereport (libtrace)" "User Commands"
     1.TH TRACEREPORT "1" "October 2006" "tracereport (libtrace)" "User Commands"
    22.SH NAME
    33tracereport \- produce various reports on a trace (or traceset)
     
    156156.SH SEE ALSO
    157157libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    158 traceconvert(1), tracestats(1), tracertstats(1), tracereport(1), tracedump(1),
    159 traceanon(1), tracesummary(1)
     158traceconvert(1), tracestats(1), tracertstats(1), tracereport(1),
     159tracepktdump(1), traceanon(1), tracesummary(1), tracereplay(1), tracediff(1)
    160160
    161161.SH AUTHORS
  • tools/tracertstats/tracertstats.1

    r67e9e2e r1481ba7  
    1 .TH TRACESTATS "1" "November 2006" "tracestats (libtrace)" "User Commands"
     1.TH TRACERTSTATS "1" "November 2006" "tracertstats (libtrace)" "User Commands"
    22.SH NAME
    33tracertstats \- perform simple filter based analysis on a trace
     
    100100.SH SEE ALSO
    101101libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    102 traceconvert(1), tracereport(1), tracedump(1), traceanon(1), tracesummary(1)
     102traceconvert(1), tracereport(1), tracepktdump(1), traceanon(1), tracesummary(1),
     103traceconvert(1), tracereplay(1), tracediff(1)
    103104
    104105.SH AUTHORS
  • tools/tracesplit/traceconvert.1

    r634089d r1481ba7  
    2222.SH SEE ALSO
    2323libtrace(3), tracemerge(1), tracesplit(1), tracefilter(1), tracesummary(1),
    24 tracereport(1), tracesplit_dir(1), tracestats(1), tracertstats(1), tracedump(1),
    25 traceanon(1), tracesummary(1)
     24tracereport(1), tracesplit_dir(1), tracestats(1), tracertstats(1),
     25tracepktdump(1), traceanon(1), tracereplay(1), tracediff(1)
    2626
    2727.SH AUTHORS
  • tools/tracesplit/tracefilter.1

    r634089d r1481ba7  
    1 .TH TRACECONVERT "1" "October 2005" "tracefilter (libtrace)" "User Commands"
     1.TH TRACEFILTER "1" "October 2005" "tracefilter (libtrace)" "User Commands"
    22.SH NAME
    33tracefilter \- apply a bpf filter to a trace
     
    1616.SH SEE ALSO
    1717libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), traceconvert(1),
    18 tracereport(1), tracestats(1), tracertstats(1), tracedump(1), traceanon(1),
    19 tracesummary(1)
     18tracereport(1), tracestats(1), tracertstats(1), tracepktdump(1), traceanon(1),
     19tracesummary(1), tracereplay(1), tracediff(1)
    2020
    2121.SH AUTHORS
  • tools/tracesplit/tracesplit.1

    r0bfd4a0 r1481ba7  
    6363.SH SEE ALSO
    6464libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit_dir(1),
    65 tracereport(1), tracertstats(1), tracestats(1), tracedump(1), traceanon(1),
    66 tracesummary(1)
     65tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
     66tracesummary(1), tracereplay(1), tracediff(1)
    6767
    6868.SH AUTHORS
  • tools/tracesplit/tracesplit_dir.1

    r634089d r1481ba7  
    1 .TH TRACESPLIT "1" "November 2006" "tracesplit (libtrace)" "User Commands"
     1.TH TRACESPLITDIR "1" "November 2006" "tracesplit_dir (libtrace)" "User Commands"
    22.SH NAME
    33tracesplit_dir \- split traces into two directions
    44.SH SYNOPSIS
    5 .B tracemerge
     5.B tracesplit_dir
    66inputuri outputuri_incoming outputuri_outgoing
    77.SH DESCRIPTION
    8 tracesplit splits one trace into two tracefiles, one for each direction.
     8tracesplit_dir splits one trace into two tracefiles, one for each direction.
    99
    1010.SH EXAMPLES
    1111.nf
    12 tracesplit erf:/traces/bigtrace.gz erf:in.gz erf:out.gz
     12tracesplit_dir erf:/traces/bigtrace.gz erf:in.gz erf:out.gz
    1313.fi
    1414
     
    1919.SH SEE ALSO
    2020libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit(1),
    21 tracereport(1), tracertstats(1), tracestats(1), tracedump(1), traceanon(1),
    22 tracesummary(1)
     21tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
     22tracesummary(1), tracereplay(1), tracediff(1)
    2323
    2424.SH AUTHORS
  • tools/tracestats/tracestats.1

    r634089d r1481ba7  
    3838.SH SEE ALSO
    3939libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit(1),
    40 tracesplit_dir(1), tracereport(1), tracertstats(1), tracedump(1), traceanon(1),
    41 tracesummary(1)
     40tracesplit_dir(1), tracereport(1), tracertstats(1), tracepktdump(1),
     41traceanon(1), tracesummary(1), tracereplay(1), tracediff(1)
    4242
    4343.SH AUTHORS
  • tools/tracestats/tracesummary.1

    r634089d r1481ba7  
    1616.SH SEE ALSO
    1717libtrace(3), tracemerge(1), tracesplit(1), tracesplit_dir(1), tracefilter(1),
    18 tracestats(1), tracereport(1), tracertstats(1), tracedump(1), traceanon(1),
    19 
     18tracestats(1), tracereport(1), tracertstats(1), tracepktdump(1), traceanon(1),
     19traceconvert(1), tracereplay(1), tracediff(1)
    2020.SH AUTHORS
    2121Perry Lorier <perry@cs.waikato.ac.nz>
  • tools/tracetop/tracetop.1

    rbdea38b r1481ba7  
    3737.SH SEE ALSO
    3838libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit_dir(1),
    39 tracereport(1), tracertstats(1), tracestats(1), tracedump(1), traceanon(1),
    40 tracesummary(1)
     39tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
     40tracesummary(1), tracereplay(1), tracediff(1)
    4141
    4242.SH AUTHORS
Note: See TracChangeset for help on using the changeset viewer.