Add some info about extended value string to section 1.7.1
[obnox/wireshark/wip.git] / doc / capinfos.pod
index 3ceda565698f0e98d93a6bc5a55a45f26bd1d8cd..33f58cf489f8b52a290b466f6be5951b8a195121 100644 (file)
@@ -6,32 +6,35 @@ capinfos - Prints information about capture files
 =head1 SYNOPSIS
 
 B<capinfos>
-S<[ B<-t> ]>
-S<[ B<-E> ]>
+S<[ B<-a> ]>
+S<[ B<-A> ]>
+S<[ B<-b> ]>
+S<[ B<-B> ]>
 S<[ B<-c> ]>
-S<[ B<-s> ]>
+S<[ B<-C> ]>
 S<[ B<-d> ]>
-S<[ B<-u> ]>
-S<[ B<-a> ]>
 S<[ B<-e> ]>
-S<[ B<-y> ]>
-S<[ B<-i> ]>
-S<[ B<-z> ]>
-S<[ B<-x> ]>
+S<[ B<-E> ]>
+S<[ B<-h> ]>
 S<[ B<-H> ]>
+S<[ B<-i> ]>
+S<[ B<-l> ]>
 S<[ B<-L> ]>
-S<[ B<-T> ]>
-S<[ B<-R> ]>
-S<[ B<-r> ]>
-S<[ B<-B> ]>
 S<[ B<-m> ]>
-S<[ B<-b> ]>
 S<[ B<-N> ]>
+S<[ B<-o> ]>
 S<[ B<-q> ]>
 S<[ B<-Q> ]>
-S<[ B<-h> ]>
-S<[ B<-C> ]>
-S<[ B<-A> ]>
+S<[ B<-r> ]>
+S<[ B<-R> ]>
+S<[ B<-s> ]>
+S<[ B<-S> ]>
+S<[ B<-t> ]>
+S<[ B<-T> ]>
+S<[ B<-u> ]>
+S<[ B<-x> ]>
+S<[ B<-y> ]>
+S<[ B<-z> ]>
 E<lt>I<infile>E<gt>
 I<...>
 
@@ -66,22 +69,57 @@ the same way B<Capinfos> handles this.
 
 =over 4
 
-=item -t
+=item -a
 
-Displays the capture type of the capture file.
+Displays the start time of the capture.  B<Capinfos> considers
+the earliest timestamp seen to be the start time, so the
+first packet in the capture is not necessarily the earliest -
+if packets exist "out-of-order", time-wise, in the capture,
+B<Capinfos> detects this.
 
-=item -E
+=item -
 
-Displays the per-file encapsulation of the capture file.
+Generate all infos. By default capinfos will display 
+all infos values for each input file, but enabling 
+any of the individual display infos options will 
+disable the generate all option.  
+
+=item -b 
+
+Separate infos with ASCII SPACE (0x20) characters.
+This option is only useful when generating a table 
+style report (-T).  The various info values will be 
+separated (delimited) from one another with a single 
+ASCII SPACE character.  
+
+NOTE: Since some of the header labels as well as some 
+of the value fields contain SPACE characters.  This 
+option is of limited value unless one of the quoting 
+options (-q or -Q) is also specified.
+
+=item -B 
+
+Separate the infos with ASCII TAB characters.  
+This option is only useful when generating a table 
+style report (-T).  The various info values will be 
+separated (delimited) from one another with a single 
+ASCII TAB character.  The TAB character is the default 
+delimiter when -T style report is enabled.
 
 =item -c
 
 Displays the number of packets in the capture file.
 
-=item -s
+=item -
 
-Displays the size of the file, in bytes.  This reports
-the size of the capture file itself.
+Cancel processing any additional files if and
+when capinfos should fail to open an input file.  
+By default capinfos will attempt to open each and 
+every file name argument.  
+
+Note: An error message will be written to stderr 
+whenever capinfos fails to open a file regardless
+of whether the -C option is specified or not.
 
 =item -d
 
@@ -93,20 +131,6 @@ For example, if a packet was originally 1514 bytes and only
 were captured with a snaplen or other slicing option),
 B<Capinfos> will consider the packet to have been 1514 bytes.
 
-=item -u
-
-Displays the capture duration, in seconds.  This is the
-difference in time between the earliest packet seen and
-latest packet seen.
-
-=item -a
-
-Displays the start time of the capture.  B<Capinfos> considers
-the earliest timestamp seen to be the start time, so the
-first packet in the capture is not necessarily the earliest -
-if packets exist "out-of-order", time-wise, in the capture,
-B<Capinfos> detects this.
-
 =item -e
 
 Displays the end time of the capture.  B<Capinfos> considers
@@ -115,25 +139,33 @@ last packet in the capture is not necessarily the latest -
 if packets exist "out-of-order", time-wise, in the capture,
 B<Capinfos> detects this.
 
-=item -y
+=item -E
 
-Displays the average data rate, in bytes/sec
+Displays the per-file encapsulation of the capture file.
 
-=item -i
+=item -h
 
-Displays the average data rate, in bits/sec
+Prints the help listing and exits.
 
-=item -z
+=item -H
 
-Displays the average packet size, in bytes
+Displays the SHA1, RIPEMD160, and MD5 hashes for the file.
 
-=item -x
+=item -i
 
-Displays the average packet rate, in packets/sec
+Displays the average data rate, in bits/sec
 
-=item -H
+=item -
 
-Displays the SHA1, RIPEMD160, and MD5 hashes for the file.
+Display the snaplen (if any) for a file.
+snaplen (if available) is determined from the capture file header
+and by looking for truncated records in the capture file.
+
+=item -o
+
+Displays "True" if packets exist in strict chronological order 
+or "False" if one or more packets in the capture exists 
+"out-of-order" time-wise.
 
 =item -L 
 
@@ -142,40 +174,6 @@ different styles of reports.  The "long" report is
 the default style of output and is suitable for a 
 human to use.
 
-=item -T 
-
-Generate a table report. A table report is a text file
-that is suitable for importing into a spreadsheet or 
-database.  Capinfos can build a tab delimited text file 
-(the default) or several variations on Comma-separated 
-values (CSV) files.
-
-=item -R 
-
-Generate header record.  This option is only useful 
-when generating a table style report (-T).  A header
-is generated by default.  A header record (if generated) 
-is the first line of data reported and includes labels 
-for all the columns included within the table report.  
-
-
-=item -r 
-
-Do not generate header record.  This option is only 
-useful when generating a table style report (-T).
-If this option is specified then B<no> header record will be 
-generated within the table report.
-
-
-=item -B 
-
-Separate the infos with ASCII TAB characters.  
-This option is only useful when generating a table 
-style report (-T).  The various info values will be 
-separated (delimited) from one another with a single 
-ASCII TAB character.  The TAB character is the default 
-delimiter when -T style report is enabled.
-
 =item -m 
 
 Separate the infos with comma (,) characters.  This option 
@@ -183,19 +181,6 @@ is only useful when generating a table style report (-T).
 The various info values will be separated (delimited)
 from one another with a single comma "," character.
 
-=item -b 
-
-Separate infos with ASCII SPACE (0x20) characters.
-This option is only useful when generating a table 
-style report (-T).  The various info values will be 
-separated (delimited) from one another with a single 
-ASCII SPACE character.  
-
-NOTE: Since some of the header labels as well as some 
-of the value fields contain SPACE characters.  This 
-option is of limited value unless one of the quoting 
-options (-q or -Q) is also specified.
-
 =item -N 
 
 Do not quote the infos.  This option is only useful 
@@ -205,7 +190,6 @@ using a TAB delimiter produces a very "clean" table
 report that is easily parsed with CLI tools.  By 
 default infos are B<NOT> quoted.
 
-
 =item -q 
 
 Quote infos with single quotes ('). This option is 
@@ -226,28 +210,60 @@ characters.  This option (when used with the -m
 option) is useful for generating the most common
 type of CSV style file report.
 
-=item -h
+=item -
 
-Prints the help listing and exits.
+Do not generate header record.  This option is only 
+useful when generating a table style report (-T).
+If this option is specified then B<no> header record will be 
+generated within the table report.
 
-=item -C 
+=item -R 
 
-Cancel processing any additional files if and
-when capinfos should fail to open an input file.  
-By default capinfos will attempt to open each and 
-every file name argument.  
+Generate header record.  This option is only useful 
+when generating a table style report (-T).  A header
+is generated by default.  A header record (if generated) 
+is the first line of data reported and includes labels 
+for all the columns included within the table report.  
 
-Note: An error message will be written to stderr 
-whenever capinfos fails to open a file regardless
-of whether the -C option is specified or not.
+=item -s
 
-=item -A 
+Displays the size of the file, in bytes.  This reports
+the size of the capture file itself.
 
-Generate all infos. By default capinfos will display 
-all infos values for each input file, but enabling 
-any of the individual display infos options will 
-disable the generate all option.  
+=item -S
+
+Display the start and end times as seconds since January
+1, 1970. Handy for synchronizing dumps using B<editcap -t>.
+
+=item -t
+
+Displays the capture type of the capture file.
+
+=item -T 
+
+Generate a table report. A table report is a text file
+that is suitable for importing into a spreadsheet or 
+database.  Capinfos can build a tab delimited text file 
+(the default) or several variations on Comma-separated 
+values (CSV) files.
+
+=item -u
+
+Displays the capture duration, in seconds.  This is the
+difference in time between the earliest packet seen and
+latest packet seen.
+
+=item -x
+
+Displays the average packet rate, in packets/sec
 
+=item -y
+
+Displays the average data rate, in bytes/sec
+
+=item -z
+
+Displays the average packet size, in bytes
 
 =back