Changeset e86a0c6

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:

• traceends.1 (modified) (3 diffs)
• tracetopends.1 (modified) (5 diffs)

tools/traceends/traceends.1

@@ -1 @@
-.TH TRACEENDS "1" "September 2011" "traceends (libtrace)" "User Commands"
+.TH TRACEENDS "1" "December 2018" "traceends (libtrace)" "User Commands"
 .SH NAME
 traceends \- summarise traffic done by every endpoint observed in a trace
 .SH SYNOPSIS
-.B tracetopends
-[ \fB-f \fRbpf | \fB--filter=\fRbpf]
-[ \fB-a \fRaddrtype | \fB--address=\fRaddrtype]
+.B traceends
+[ \fB-t \fRthreads | \fB--threads=\fRthreads ]
+[ \fB-f \fRbpf | \fB--filter=\fRbpf ]
+[ \fB-a \fRaddrtype | \fB--address=\fRaddrtype ]
+[ \fB-S \fR| \fB--ignore-source\fR ]
+[ \fB-D \fR| \fB--ignore-dest\fR ]
 [ \fB-H | \fB--help]
 
@@ -14 +17 @@
 program directly \-\- see \fBtracetopends\fR instead.
 
+.SH OPTIONS
+.TP
+\fB\-t\fR threads
+Use the given number of threads for packet processing. Defaults to 1 thread.
+
 .TP
 \fB\-f\fR bpf filter
-output only packets that match tcpdump style bpf filter
+Ignore packets that do not match this tcpdump style bpf filter.
 
 .TP
@@ -23 +31 @@
 and "v6" which will report endpoint stats for each observed MAC address, IPv4
 address and IPv6 address respectively.
+
+.TP
+\fB\-S, --ignore-source\fR
+Do not track endpoints which are sending traffic. Mutually exclusive with the
+\fBignore-dest\fR option.
+
+.TP
+\fB\-D, --ignore-dest\fR
+Do not track endpoints which are receiving traffic. Mutually exclusive with the
+\fBignore-source\fR option.
 
 .SH OUTPUT

tools/traceends/tracetopends.1

@@ -1 @@
-.TH TRACETOPENDS "1" "September 2011" "tracetopends (libtrace)" "User Commands"
+.TH TRACETOPENDS "1" "December 2018" "tracetopends (libtrace)" "User Commands"
 .SH NAME
 tracetopends \- reports the endpoints that are responsible for the most traffic
@@ -5 +5 @@
 .SH SYNOPSIS
 .B tracetopends
+[ \fB-t \fRthreads ]
 [ \fB-f \fRbpf ]
 [ \fB-A \fRaddrtype ]
+[ \fB-S ]
+[ \fb-D ]
 [ \fB-s ]
 [ \fB-d ]
@@ -17 +20 @@
 tracetopends reports the number of bytes and packets sent and received by the
 busiest endpoints observed in the input trace(s). 
+
+.SH OPTIONS
+
+.TP
+\fB\-t\fR threads
+Use the given number of threads for packet processing. Defaults to 1 thread.
 
 .TP
@@ -31 +40 @@
 and "v6" which will report endpoint stats for each observed MAC address, IPv4
 address and IPv6 address respectively.
+
+.TP
+\fB\-S
+Do not track endpoints which are sending traffic. Mutually exclusive with the
+\fB\-D \fRoption.
+
+.TP
+\fB\-D
+Do not track endpoints which are receiving traffic. Mutually exclusive with the
+\fB\-S \fRoption.
 
 .TP
@@ -73 +92 @@
 Find the IPv4 addresses that are sending the most traffic.
 .nf
-tracetopends -A v4 -b -s erf:trace.erf.gz
+tracetopends -A v4 -b -s -S erf:trace.erf.gz
 .fi