aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reordercap.pod
diff options
context:
space:
mode:
authorMartin Mathieson <martin.r.mathieson@googlemail.com>2012-10-03 18:03:01 +0000
committerMartin Mathieson <martin.r.mathieson@googlemail.com>2012-10-03 18:03:01 +0000
commitafbf3cd59672be92968f0a65f8743765009ef348 (patch)
treea3c6a98f0e569add7d51cd1681cf6ea3d36b7a11 /doc/reordercap.pod
parent218aaf05e3a91dfd3f454b736183809fa1f2e5f1 (diff)
Add a command-line option to control how large the reordering list can
become. The default is now 0 (infinite). svn path=/trunk/; revision=45293
Diffstat (limited to 'doc/reordercap.pod')
-rw-r--r--doc/reordercap.pod11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/reordercap.pod b/doc/reordercap.pod
index cf8ee40a96..ad94b7cb12 100644
--- a/doc/reordercap.pod
+++ b/doc/reordercap.pod
@@ -6,6 +6,7 @@ reordercap - Reorder input file by timestamp into output file
=head1 SYNOPSIS
B<reorder>
+S<[ B<-l> E<lt>I<maximum reorder list length>E<gt> ]>
E<lt>I<infile>E<gt> E<lt>I<outfile>E<gt>
=head1 DESCRIPTION
@@ -16,11 +17,13 @@ timestamp.
This functionality may be useful when capture files have been created by
combining frames from more than one well-synchronised source, but the
-frames are still not in strict order.
+frames have not been combined in strict time order.
-It does this by maintaining an ordered list of information about frames it
-has read - at the moment the list has an arbitrary, fixed maximum length
-of 3000 frames.
+It does this by maintaining an ordered (by timestamp) list of information about
+frames it has read. The default is to let this list grow infinitely, but there
+is a command-line option to place a limit upon it. Using a smaller limit will
+allow for the reordering to complete more quickly, at the risk of not completely
+sorting the capture.
B<Reordercap> writes the output capture file in the same format as the input
capture file.