From 84d5f6dd4987bb78f85a706b0fc689d5b51bbba0 Mon Sep 17 00:00:00 2001
From: Tobias Klauser <tklauser@distanz.ch>
Date: Wed, 15 May 2013 11:00:09 +0200
Subject: man: trafgen: Minor fixes

Replace "on default" by "by default", make it a bit more clear what the
seed in the -E/--seed option is for and mention exit after display of
information on --version and --help.

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
---
 astraceroute.8 |  4 ++--
 bpfc.8         |  4 ++--
 bpfc.c         |  4 ++--
 flowtop.8      |  4 ++--
 flowtop.c      |  4 ++--
 ifpps.8        | 44 ++++++++++++++++++++++----------------------
 ifpps.c        |  4 ++--
 netsniff-ng.c  |  2 +-
 trafgen.8      | 27 ++++++++++++++-------------
 trafgen.c      |  2 +-
 10 files changed, 50 insertions(+), 49 deletions(-)

diff --git a/astraceroute.8 b/astraceroute.8
index 28d1948..05273c8 100644
--- a/astraceroute.8
+++ b/astraceroute.8
@@ -125,10 +125,10 @@ Set the IP's no fragmentation flag.
 Show and dissect the returned packet.
 
 .SS -v, --version
-Show versioning information.
+Show versioning information and exit.
 
 .SS -h, --help
-Show user help.
+Show user help and exit.
 
 .SH USAGE EXAMPLE
 
diff --git a/bpfc.8 b/bpfc.8
index 622014c..055c18c 100644
--- a/bpfc.8
+++ b/bpfc.8
@@ -73,10 +73,10 @@ Be more verbose and display some bpfc debugging information.
 Dump all supported instructions to stdout.
 
 .SS -v, --version
-Show versioning information.
+Show versioning information and exit.
 
 .SS -h, --help
-Show user help.
+Show user help and exit.
 
 .SH SYNTAX
 
diff --git a/bpfc.c b/bpfc.c
index 2045512..1b29bb3 100644
--- a/bpfc.c
+++ b/bpfc.c
@@ -42,8 +42,8 @@ static void help(void)
 	     "  -b|--bypass             Bypass filter validation (e.g. for bug testing)\n"
 	     "  -V|--verbose            Be more verbose\n"
 	     "  -d|--dump               Dump supported instruction table\n"
-	     "  -v|--version            Print version\n"
-	     "  -h|--help               Print this help\n\n"
+	     "  -v|--version            Print version and exit\n"
+	     "  -h|--help               Print this help and exit\n\n"
 	     "Examples:\n"
 	     "  bpfc fubar\n"
 	     "  bpfc fubar > foo (bpfc -f C -i fubar > foo) -->  netsniff-ng -f foo ...\n"
diff --git a/flowtop.8 b/flowtop.8
index fd2393c..bd3c84e 100644
--- a/flowtop.8
+++ b/flowtop.8
@@ -82,10 +82,10 @@ limit policy), different hosts or IP addresses can be placed into geoip.conf,
 separated by a newline.
 
 .SS -v, --version
-Show versioning information.
+Show versioning information and exit.
 
 .SS -h, --help
-Show user help.
+Show user help and exit.
 
 .SH USAGE EXAMPLE
 
diff --git a/flowtop.c b/flowtop.c
index 43d770e..1050fc5 100644
--- a/flowtop.c
+++ b/flowtop.c
@@ -240,8 +240,8 @@ static void help(void)
 	     "  -S|--sctp              Show only SCTP flows\n"
 	     "  -s|--show-src          Also show source, not only dest\n"
 	     "  -u|--update            Update GeoIP databases\n"
-	     "  -v|--version           Print version\n"
-	     "  -h|--help              Print this help\n\n"
+	     "  -v|--version           Print version and exit\n"
+	     "  -h|--help              Print this help and exit\n\n"
 	     "Examples:\n"
 	     "  flowtop\n"
 	     "  flowtop -46UTDISs\n\n"
diff --git a/ifpps.8 b/ifpps.8
index 8f802e9..46088dd 100644
--- a/ifpps.8
+++ b/ifpps.8
@@ -15,24 +15,24 @@ ifpps \- top-like networking and system statistics
 ifpps is a small utility which periodically provides top-like networking
 and system statistics from the kernel. ifpps gathers its data directly
 from procfs files and does not apply any user space monitoring libraries
-which could falsify statistics on high load.
+which would falsify statistics on high load.
 
 For instance, consider the following scenario: two directly connected
-Linux machines, each with an Intel Core 2 Quad Q6600 2.40GHz CPUs, 4 GB
-RAM, and an Intel 82566DC-2 Gigabit Ethernet NIC, are used for performance
-evaluation. One machine generates 64 byte network packets by using the
-kernel space packet generator, pktgen, with a maximum possible packet rate.
-The other machine displays statistics about incoming network packets by
-using i) iptraf(8) and ii) ifpps.
-
-iptraf which incorporates pcap(3) shows an average packet rate of
-246,000 pps, while on the other hand, ifpps shows an average packet rate
-of 1,378,000 pps. Hence, due to packet copies and deferring statistical
-calculations to user space, a measurement error of approx. 460 per cent
+Linux machines with Intel Core 2 Quad Q6600 2.40GHz CPUs, 4 GB RAM, and
+an Intel 82566DC-2 Gigabit Ethernet NIC are used for performance evaluation.
+One machine generates 64 byte network packets by using the kernel space
+packet generator pktgen with a maximum possible packet rate. The other
+machine displays statistics about incoming network packets by using i)
+iptraf(8) and ii) ifpps.
+
+iptraf that incorporates pcap(3) shows an average packet rate of
+246,000 pps while on the other hand ifpps shows an average packet rate of
+1,378,000 pps. Hence, due to copying packets and deferring statistics
+creation into user space, measurement error of approx. 460 per cent
 occurs. Tools like iptraf might display much more information such as
 TCP per flow statistics (therefore the use of the pcap library), which
-is not implemented in ifpps, because overall networking statistics is
-our focus; statistics, which are also fairly reliable under high packet
+is not implemented in ifpps, because overall networking statistics are
+in our focus; statistics, which are also fairly reliable under high packet
 load.
 
 .SH OPTIONS
@@ -41,7 +41,7 @@ load.
 Networking device to fetch statistics from, e.g. eth0, wlan0.
 
 .SS -t <time>, --interval <time>
-Statistics refresh interval in milliseconds, default is 1000ms(1 sec).
+Statistics refresh interval in milliseconds, default is 1000 ms.
 
 .SS -p, --promisc
 Turn on promiscuous mode for the given networking device.
@@ -51,12 +51,12 @@ Output (once) the ncurses data to the terminal as gnuplot(1)-ready data.
 
 .SS -l, --loop
 Continuously output the terminal data after a refresh interval. This option
-is available only if option ``-c'' is given. For ``-l'' it is usually
-recommended to redirect the output into a file that will be processed
+only is available, if option ``-c'' is given. For ``-l'' it is usually
+recommended to redirect the output into a file that is later being processed
 with gnuplot(1).
 
 .SS -v, --version
-Show version information.
+Show versioning information.
 
 .SS -h, --help
 Show user help.
@@ -74,12 +74,12 @@ Continuous terminal output for the wlan0 device in promiscuous mode.
 
 .SH NOTE
 On 10Gbit/s cards or higher, receive and transmit statistics are usually
-accumulated at a higher duration interval than 1 second. Thus, it might
-be advised to alter the timing option to a longer interval for such cards.
+accumulated each > 1sec. Thus, it might be advised to alter the timing
+option to a higher accumulation interval for such cards.
 
 .SH BUGS
-Systems with a fairly high number of cores (> 32) are currently not
-supported. This should, however, not be a big deal to fix. The only
+Systems with a failry high number of cores (> 32) are currently not
+supported. This should however not be a big deal to fix that. The only
 challenge would be to display the presented information in a sane way,
 probably by selectively hiding uninteresting statistics.
 
diff --git a/ifpps.c b/ifpps.c
index f52a10b..eb95439 100644
--- a/ifpps.c
+++ b/ifpps.c
@@ -105,8 +105,8 @@ static void help(void)
 	     "  -p|--promisc           Promiscuous mode\n"
 	     "  -c|--csv               Output to terminal as Gnuplot-ready data\n"
 	     "  -l|--loop              Continuous CSV output\n"
-	     "  -v|--version           Print version\n"
-	     "  -h|--help              Print this help\n\n"
+	     "  -v|--version           Print version and exit\n"
+	     "  -h|--help              Print this help and exit\n\n"
 	     "Examples:\n"
 	     "  ifpps eth0\n"
 	     "  ifpps -pd eth0\n"
diff --git a/netsniff-ng.c b/netsniff-ng.c
index b4a239e..82ab73c 100644
--- a/netsniff-ng.c
+++ b/netsniff-ng.c
@@ -1045,7 +1045,7 @@ static void help(void)
 	     "  -l|--ascii                     Print human-readable packet data\n"
 	     "  -U|--update                    Update GeoIP databases\n"
 	     "  -V|--verbose                   Be more verbose\n"
-	     "  -v|--version                   Show version\n"
+	     "  -v|--version                   Show version and exit\n"
 	     "  -h|--help                      Guess what?!\n\n"
 	     "Examples:\n"
 	     "  netsniff-ng --in eth0 --out dump.pcap -s -T 0xa1b2c3d4 --b 0 tcp or udp\n"
diff --git a/trafgen.8 b/trafgen.8
index dd8e54b..effd073 100644
--- a/trafgen.8
+++ b/trafgen.8
@@ -28,7 +28,7 @@ minimal and to the point. trafgen makes use of packet(7) socket's TX_RING
 interface of the Linux kernel, which is a mmap(2)'ed ring buffer shared between
 user and kernel space.
 
-On default, trafgen starts as many processes as CPUs that are online, pins each
+By default, trafgen starts as many processes as CPUs that are online, pins each
 of them to their respective CPU and sets up the ring buffer each in their own
 process space after having compiled a list of packets to transmit. Thus, this is
 likely the fastest one can get out of the box in terms of transmission performance
@@ -81,7 +81,7 @@ trafgen. This allows #define and #include directives (e.g. to include
 definitions from system headers) to be used in the trafgen configuration file.
 
 .SS -J, --jumbo-support
-On default trafgen's ring buffer frames are of a fixed size of 2048 bytes.
+By default trafgen's ring buffer frames are of a fixed size of 2048 bytes.
 This means that if you're expecting jumbo frames or even super jumbo frames to
 pass your line, then you need to enable support for that with the help of this
 option. However, this has the disadvantage of a performance regression and a
@@ -112,13 +112,13 @@ this is equivalent to infinite packets resp. processing until interrupted.
 Otherwise, a number given as an unsigned integer will limit processing.
 
 .SS -r, --rand
-Randomize the packet selection of the configuration file. On default, if more
+Randomize the packet selection of the configuration file. By default, if more
 than one packet is defined in a packet configuration, packets are scheduled for
 transmission in a round robin fashion. With this option, they are selected
 randomly instread.
 
 .SS -P <uint>, --cpus <uint>
-Specify the number of processes trafgen shall fork(2) off. On default trafgen
+Specify the number of processes trafgen shall fork(2) off. By default trafgen
 will start as many processes as CPUs that are online and pin them to each,
 respectively. Allowed value must be within interval [1,CPUs].
 
@@ -137,17 +137,18 @@ default the size is being determined based on the network connectivity rate.
 
 .SS -k <uint>, --kernel-pull <uint>
 Manually define the interval in micro-seconds where the kernel should be triggered
-to batch process the ring buffer frames. On default, it is every 10us, but it can
+to batch process the ring buffer frames. By default, it is every 10us, but it can
 manually be prolonged, for instance..
 
 .SS -E <uint>, --seed <uint>
-Manually set the seed for trafgen. On default, a random seed from /dev/urandom
-is being used to feed glibc's pseudo random number generator. If that fails, it
-falls back to the unix timestamp. It can be useful to set it up manually to be
-able to reproduce a trafgen session, e.g. after fuzz testing.
+Manually set the seed for pseudo random number generator (PRNG) in trafgen. By
+default, a random seed from /dev/urandom is used to feed glibc's PRNG. If that
+fails, it falls back to the unix timestamp. It can be useful to set the seed
+manually in order to be able to reproduce a trafgen session, e.g. after fuzz
+testing.
 
 .SS -u <uid>, --user <uid> resp. -g <gid>, --group <gid>
-After ring setup drop privileges to a non-root user/group combination.
+After ring setup, drop privileges to a non-root user/group combination.
 
 .SS -V, --verbose
 Let trafgen be more talkative and let it print the parsed configuration and
@@ -158,10 +159,10 @@ Show a built-in packet configuration example. This might be a good starting
 point for an initial packet configuration scenario.
 
 .SS -v, --version
-Show versioning information.
+Show version information and exit.
 
 .SS -h, --help
-Show user help.
+Show user help and exit.
 
 .SH SYNTAX
 trafgen's packet configuration syntax is fairly simple. The very basic things
@@ -173,7 +174,7 @@ enclosed by opening '{' and closing '}' braces, for example:
    { /* packet 2 content goes here ... */ }
 
 When trafgen is started using multiple CPUs (default), then each of those packets
-will be scheduled for transmission on all CPUs on default. However, it is possible
+will be scheduled for transmission on all CPUs by default. However, it is possible
 to tell trafgen to schedule a packet only on a particular CPU:
 
    cpu(1): { /* packet 1 content goes here ... */ }
diff --git a/trafgen.c b/trafgen.c
index 4e670ed..5ec837b 100644
--- a/trafgen.c
+++ b/trafgen.c
@@ -179,7 +179,7 @@ static void help(void)
 	     "  -u|--user <userid>             Drop privileges and change to userid\n"
 	     "  -g|--group <groupid>           Drop privileges and change to groupid\n"
 	     "  -V|--verbose                   Be more verbose\n"
-	     "  -v|--version                   Show version\n"
+	     "  -v|--version                   Show version and exit\n"
 	     "  -e|--example                   Show built-in packet config example\n"
 	     "  -h|--help                      Guess what?!\n\n"
 	     "Examples:\n"
-- 
cgit v1.2.3-54-g00ecf