chiark / gitweb /
changelog: Document -t option
[chiark-utils.git] / cprogs / 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 \fIsize\fR may also be suffixed with
15 .BR m ", " k ", or " b
16 to indicate that it is in megabytes (2^20), kilobytes (2^10) or bytes.
17 .PP
18 It is intended for use in situations where many small
19 reads are undesirable for performance reasons, e.g. tape drives.
20 .SH OPTIONS
21 .TP
22 .B --mlock
23 Calls
24 .BR mlock (2)
25 to lock the buffer into memory.
26 .SH "SEE ALSO"
27 .BR writebuffer (1),
28 .BR mlock (2)