From 718216e36afc7ae645dce2558a00aa6bc2aaa078 Mon Sep 17 00:00:00 2001 From: Tobias Klauser Date: Tue, 14 May 2013 17:21:15 +0200 Subject: man: netsniff-ng: Minor fixes Fix wording in some places, make some sentences a bit shorter and replace "on default" by "by default". Signed-off-by: Tobias Klauser --- netsniff-ng.8 | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/netsniff-ng.8 b/netsniff-ng.8 index c569380..a8018ab 100644 --- a/netsniff-ng.8 +++ b/netsniff-ng.8 @@ -63,7 +63,7 @@ determined automatically by the pcap file magic. In case of stdin, it is assumed that the input stream is a pcap file. .SS -o , --out -Defines the output device, that can either be a networking device, a pcap file, +Defines the output device. This can either be a networking device, a pcap file, a folder, a trafgen(8) configuration file or stdout (``-''). In case of a pcap file, that should not have the default pcap type (0xa1b2c3d4), the additional option ``-T'' must be provided. If a directory is given, then, instead of a @@ -96,7 +96,7 @@ following values are possible ``KiB/MiB/GiB'' while as a time parameter it can be ``s/sec/min/hrs''. .SS -J, --jumbo-support -On default netsniff-ng's ring buffer frames are of a fixed size of 2048 bytes. +By default netsniff-ng'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 @@ -115,8 +115,8 @@ Otherwise, a number given as an unsigned integer will limit processing. .SS -P , --prefix When dumping pcap files into a folder, a file name prefix can be defined with -this option. If not otherwise specified, the default prefix is ``dump-'' followed -by a unix timestamp. +this option. If none is specified, the default prefix is ``dump-'' followed by a +unix timestamp. .SS -T , --magic Specify a pcap type for storage. Different pcap types with their various meta @@ -126,7 +126,7 @@ used. Pcap files with swapped endianess are also supported. .SS -D, --dump-pcap-types Dump all available pcap types with their capabilities and magic numbers that -can be used with option ``-T'' and exit. +can be used with option ``-T'' to stdout and exit. .SS -B, --dump-bpf If a Berkeley Packet Filter is given, e.g. via option ``-f'', then dump the BPF @@ -138,7 +138,7 @@ If the input and output device are both networking devices, then this option wil randomize packet order in the output ring buffer. .SS -M, --no-promisc -The networking interface will not be put into promiscuous mode. On default, +The networking interface will not be put into promiscuous mode. By default, promiscuous mode is turned on. .SS -A, --no-sock-mem @@ -164,7 +164,7 @@ default the size is being determined based on the network connectivity rate. .SS -k , --kernel-pull 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 -b , --bind-cpu @@ -211,10 +211,10 @@ addresses can be placed into geoip.conf, separated by a newline. Be more verbose during startup, i.e. show detailled ring setup information. .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 -- cgit v1.2.3-54-g00ecf From 6b1f666dd643660847fa54199fc93ae2c8e14b24 Mon Sep 17 00:00:00 2001 From: Tobias Klauser Date: Tue, 14 May 2013 17:26:23 +0200 Subject: man: trafgen: Complete documentation for option -p/--cpp Add complete description of the commandline option -p/--cpp to the manpage. Signed-off-by: Tobias Klauser --- trafgen.8 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/trafgen.8 b/trafgen.8 index 30638aa..dd8e54b 100644 --- a/trafgen.8 +++ b/trafgen.8 @@ -76,7 +76,9 @@ passed through stdin, only 1 CPU will be used. Defines the outgoing networking device such as eth0, wlan0 and others. .SS -p, --cpp -Pass the packet configuration to +Pass the packet configuration to the C preprocessor before reading it into +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. -- cgit v1.2.3-54-g00ecf From 84d5f6dd4987bb78f85a706b0fc689d5b51bbba0 Mon Sep 17 00:00:00 2001 From: Tobias Klauser 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 --- 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