chiark / gitweb /
@@ -1,3 +1,9 @@
[chiark-utils.git] / cprogs / writebuffer.1
1 .TH writebuffer 1 2001-10-21 chiark-backup
2 .SH NAME
3 writebuffer \- write output to devices which don't like constant stopping and starting
4 .SH SYNOPSIS
5 .B writebuffer
6 .RB [ --mlock ]
7 .RI [ size ]
8 .SH DESCRIPTION
9 .B writebuffer
10 reads data on standard input and writes it to standard output.  It
11 will buffer internally up to \fIsize\fR megabytes and will only write
12 data when the buffer is at least 75% full or when there is no more
13 input to fill the buffer.
14 .PP
15 \fIsize\fR may also be suffixed with
16 .BR m ", " k ", or " b
17 to indicate that it is in megabytes (2^20), kilobytes (2^10) or bytes.
18 .PP
19 It is intended for use in situations where many small writes are
20 undesirable for performance reasons, e.g. tape drives.
21 .SH OPTIONS
22 .TP
23 .B --mlock
24 Calls
25 .BR mlock (2)
26 to lock the buffer into memory.
27 .SH "SEE ALSO"
28 .BR readbuffer (1),
29 .BR mlock (2)