Changeset e86a0c6


Ignore:
Timestamp:
12/03/18 14:27:53 (23 months ago)
Author:
Shane Alcock <salcock@…>
Branches:
develop
Children:
c337c62f
Parents:
99ee456
Message:

Update manpages for traceends and tracetopends

Updated to reflect new CLI options that have been added in the
recent re-write of these tools.

Location:
tools/traceends
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • tools/traceends/traceends.1

    rd6dc0f6 re86a0c6  
    1 .TH TRACEENDS "1" "September 2011" "traceends (libtrace)" "User Commands"
     1.TH TRACEENDS "1" "December 2018" "traceends (libtrace)" "User Commands"
    22.SH NAME
    33traceends \- summarise traffic done by every endpoint observed in a trace
    44.SH SYNOPSIS
    5 .B tracetopends
    6 [ \fB-f \fRbpf | \fB--filter=\fRbpf]
    7 [ \fB-a \fRaddrtype | \fB--address=\fRaddrtype]
     5.B traceends
     6[ \fB-t \fRthreads | \fB--threads=\fRthreads ]
     7[ \fB-f \fRbpf | \fB--filter=\fRbpf ]
     8[ \fB-a \fRaddrtype | \fB--address=\fRaddrtype ]
     9[ \fB-S \fR| \fB--ignore-source\fR ]
     10[ \fB-D \fR| \fB--ignore-dest\fR ]
    811[ \fB-H | \fB--help]
    912
     
    1417program directly \-\- see \fBtracetopends\fR instead.
    1518
     19.SH OPTIONS
     20.TP
     21\fB\-t\fR threads
     22Use the given number of threads for packet processing. Defaults to 1 thread.
     23
    1624.TP
    1725\fB\-f\fR bpf filter
    18 output only packets that match tcpdump style bpf filter
     26Ignore packets that do not match this tcpdump style bpf filter.
    1927
    2028.TP
     
    2331and "v6" which will report endpoint stats for each observed MAC address, IPv4
    2432address and IPv6 address respectively.
     33
     34.TP
     35\fB\-S, --ignore-source\fR
     36Do not track endpoints which are sending traffic. Mutually exclusive with the
     37\fBignore-dest\fR option.
     38
     39.TP
     40\fB\-D, --ignore-dest\fR
     41Do not track endpoints which are receiving traffic. Mutually exclusive with the
     42\fBignore-source\fR option.
    2543
    2644.SH OUTPUT
  • tools/traceends/tracetopends.1

    rd6dc0f6 re86a0c6  
    1 .TH TRACETOPENDS "1" "September 2011" "tracetopends (libtrace)" "User Commands"
     1.TH TRACETOPENDS "1" "December 2018" "tracetopends (libtrace)" "User Commands"
    22.SH NAME
    33tracetopends \- reports the endpoints that are responsible for the most traffic
     
    55.SH SYNOPSIS
    66.B tracetopends
     7[ \fB-t \fRthreads ]
    78[ \fB-f \fRbpf ]
    89[ \fB-A \fRaddrtype ]
     10[ \fB-S ]
     11[ \fb-D ]
    912[ \fB-s ]
    1013[ \fB-d ]
     
    1720tracetopends reports the number of bytes and packets sent and received by the
    1821busiest endpoints observed in the input trace(s).
     22
     23.SH OPTIONS
     24
     25.TP
     26\fB\-t\fR threads
     27Use the given number of threads for packet processing. Defaults to 1 thread.
    1928
    2029.TP
     
    3140and "v6" which will report endpoint stats for each observed MAC address, IPv4
    3241address and IPv6 address respectively.
     42
     43.TP
     44\fB\-S
     45Do not track endpoints which are sending traffic. Mutually exclusive with the
     46\fB\-D \fRoption.
     47
     48.TP
     49\fB\-D
     50Do not track endpoints which are receiving traffic. Mutually exclusive with the
     51\fB\-S \fRoption.
    3352
    3453.TP
     
    7392Find the IPv4 addresses that are sending the most traffic.
    7493.nf
    75 tracetopends -A v4 -b -s erf:trace.erf.gz
     94tracetopends -A v4 -b -s -S erf:trace.erf.gz
    7695.fi
    7796
Note: See TracChangeset for help on using the changeset viewer.