chiark / gitweb /
Many fixes.
[chiark-utils.git] / backup / readbuffer.1
1 .TH readbuffer 1 2001-10-21 chiark-backup
2 .SH NAME
3 readbuffer \- read input from devices which don't like constant stopping and starting
4 .SH SYNOPSIS
5 .B readbuffer
6 .RB [ --mlock ]
7 .RI [ size ]
8 .SH DESCRIPTION
9 .B readbuffer
10 reads data on standard input and writes it to standard output.  It
11 will internally buffer up to \fIsize\fR megabytes of data, and will
12 only read more data when the buffer is at least 75% empty.
13 .PP
14 It is intended for use in situations where many small
15 reads are undesirable for performance reasons, e.g. tape drives.
16 .SH OPTIONS
17 .TP
18 .B --mlock
19 Calls
20 .BR mlock (2)
21 to lock the buffer into memory.
22 .SH "SEE ALSO"
23 .BR writebuffer (1),
24 .BR mlock (2)