Skip to content

Commit

Permalink
Mention bytes for --buffersize, be clear is just a number, and add no…
Browse files Browse the repository at this point in the history
…te about rotation.
  • Loading branch information
reedjc committed May 10, 2018
1 parent df39011 commit 06ddc76
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions man/fstrm_capture.1
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,22 @@ specified, concurrent connections are not limited.

.TP
.B -b \fIbuffersize\fB | --buffersize \fIbuffersize\fB
Set read buffer size to \fIbuffersize\fR. Combined with \fB-c\fR,
Set read buffer size to \fIbuffersize\fR bytes. Combined with \fB-c\fR,
this can be used to limit the total memory usage of \fBfstrm_capture\fR.
The \fIbuffersize\fR also affects the maximum frame size which
\fBfstrm_capture\fR will accept. Frames larger than \fIbuffersize\fR,
including the 4-byte framing overhead, will be discarded.

The default \fIbuffersize\fR is 256KiB.
The default \fIbuffersize\fR is 262144 (256KiB).

.TP
.B -s \fIinterval\fB | --split \fIinterval\fB
Reopen output file every \fIinterval\fR seconds. Requires the use of
either the \fB--gmtime\fR or \fB--localtime\fR options.

Note that this file rotation is triggered by incoming data,
so it may be delayed after the interval.

.TP
.B --gmtime
Process the \fB--write\fR filename through \fBstrftime()\fR with the current
Expand Down

0 comments on commit 06ddc76

Please sign in to comment.