Changeset ba91618 for tools

Timestamp:

04/23/10 11:34:08 (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:

83a1f4e

Parents:

db9fa93

Message:

• Updated manpages for traceanon and tracemerge to reflect new -Z option.
• Attempted to add some consistency in the naming of long options for -z and -Z across tools

Location:

tools

Files:

• traceanon/traceanon.1 (modified) (3 diffs)
• traceanon/traceanon.c (modified) (2 diffs)
• tracemerge/tracemerge.1 (modified) (2 diffs)
• tracemerge/tracemerge.c (modified) (2 diffs)
• tracesplit/tracesplit.1 (modified) (1 diff)
• tracesplit/tracesplit.c (modified) (2 diffs)

tools/traceanon/traceanon.1

@@ -8 +8 @@
 [ \-p prefix | \-\^\-prefix=prefix ]
 [ \-c key | \-\^\-cryptopan=key ]
+[ \-z level | \-\^\-compress-level=level ]
+[ \-Z method | \-\^\-compress-type=method ]
 sourceuri
 desturi
@@ -51 +53 @@
 encrypt the IP addresses using the prefix-preserving cryptopan method using
 the key "key".  The key can be up to 32 bytes long, and will be padded with
-NUL charactors.
+NULL characters.
 
+.TP
+.PD 0
+.BI \-z 
+.TP
+.PD
+.BI \-\^\-compress-level=level
+compress the output trace using a compression level of "level". Compression
+level can range from 0 (no compression) through to 9. Higher compression levels
+require more CPU to compress data. Defaults to no compression.
+
+.TP
+.PD 0
+.BI \-Z 
+.TP
+.PD
+.BI \-\^\-compress-type=method
+compress the output trace using the compression algorithm "method". Possible
+algorithms are "gzip", "bzip2", "lzo" and "none". Default is "none".
 
 .SH EXAMPLES
@@ -59 +79 @@
         \-\^\-encrypt-source \\
         \-\^\-encrypt-dest \\
+        \-\^\-compress-level=1 \\
+        \-\^\-compress-type=gzip \\
         erf:/traces/unenc.gz \\
         erf:/traces/enc.gz \\

tools/traceanon/traceanon.c

@@ -22 +22 @@
         "-p --prefix=C.I.D.R/bits Substitute the prefix of the address\n"
         "-H --libtrace-help     Print libtrace runtime documentation\n"
-        "-z --compression-level Compress the output trace at the specified level\n"
-        "-Z --compression-type  Compress the output trace using the specified"
+        "-z --compress-level    Compress the output trace at the specified level\n"
+        "-Z --compress-type     Compress the output trace using the specified"
         "                       compression algorithm\n"
         ,argv0);
@@ -128 +128 @@
                         { "cryptopan",          1, 0, 'c' },
                         { "prefix",             1, 0, 'p' },
-                        { "compression-level",  1, 0, 'z' },
-                        { "compression-type",   1, 0, 'Z' },
+                        { "compress-level",     1, 0, 'z' },
+                        { "compress-type",      1, 0, 'Z' },
                         { "libtrace-help",      0, 0, 'H' },
                         { NULL,                 0, 0, 0   },

tools/tracemerge/tracemerge.1

@@ -5 +5 @@
 .B tracemerge 
 [ \-i [ interfaces_per_input ] | \-\^\-set-interface [ interfaces_per_input ] ]
-[ \-u | \-\^\-unique-packets ]
+[ \-u | \-\^\-unique-packets ] [ \-z | \-\^\-compress-level <level> ] 
+[ \-Z | \-\^\-compress-type <method> ]
 outputuri inputuri...
 .SH DESCRPTION
@@ -37 +38 @@
 .TP
 .PD 0
-.BI \-z [ compression_level ]
+.BI \-z level
 .TP
 .PD
-.BI \-\^\-compression [ compression_level ]
-Sets the amount of compression performed on the output file.  Currently libtrace will always write
-out compressed files, even when -z0 is given.
+.BI \-\^\-compress-level level
+Sets the amount of compression performed on the output file. This value can
+range from 0 (no compression) to 9 (maximum compression). Higher compression
+levels require more CPU to compress data. Defaults to 0.
+
+.TP
+.PD 0
+.BI \-Z method 
+.TP
+.PD
+.BI \-\^\-compress-type method 
+Describes the compression algorithm to be used when writing the output trace.
+Possible methods are "gzip", "bzip2", "lzo" and "none". Defaults to "none".
+
 
 .SH LINKS

tools/tracemerge/tracemerge.c

@@ -16 +16 @@
         "                       read from the original traces, if appropriate\n"
         "-u --unique-packets    Discard duplicate packets\n"
-        "-z level --compression level\n"
+        "-z level --compress-level level\n"
         "                       Compression level\n"
-        "-Z method --compression-type method\n"
+        "-Z method --compress-type method\n"
         "                       Compression method\n"
         "-H --libtrace-help     Print libtrace runtime documentation\n"
@@ -54 +54 @@
                         { "unique-packets",     0, 0, 'u' },
                         { "libtrace-help",      0, 0, 'H' },
-                        { "compression",        1, 0, 'z' },
-                        { "compression-type",   1, 0, 'Z' },
+                        { "compress-level",     1, 0, 'z' },
+                        { "compress-type",      1, 0, 'Z' },
                         { NULL,                 0, 0, 0   },
                 };

tools/tracesplit/tracesplit.1

@@ -12 +12 @@
 [ \fB-m \fRmaxfiles | \fB--maxfiles=\fRmaxfiles]
 [ \fB-S \fRsnaplen | \fB--snaplen=\fRsnaplen]
-[ \fB-z \fRlevel | \fB--compress=\fRlevel]
+[ \fB-z \fRlevel | \fB--compress-level=\fRlevel]
 [ \fB-Z \fRmethod | \fB--compress-type=\fRmethod]
 inputuri outputuri ...

tools/tracesplit/tracesplit.c

@@ -41 +41 @@
         "-S --snaplen           Snap packets at the specified length\n"
         "-v --verbose           Output statistics\n"
-        "-z --compress          Set compression level\n"
+        "-z --compress-level    Set compression level\n"
         "-Z --compress-type     Set compression type\n"
         ,argv0);
@@ -99 +99 @@
                         { "snaplen",       1, 0, 'S' },
                         { "verbose",       0, 0, 'v' },
-                        { "compress",      1, 0, 'z' },
+                        { "compress-level", 1, 0, 'z' },
                         { "compress-type", 1, 0, 'Z' },
                         { NULL,            0, 0, 0   },