ratepipe.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
.TH RATEPIPE "1" "August 2009" "ratepipe 0.1" "User Commands"
.SH NAME
ratepipe \- Rate limits a stream through stdin/stdout
.SH SYNOPSIS
.B ratelimit
[\fIOPTION\fR]...
.SH DESCRIPTION
.\" Add any additional description here
.PP
Rate limits a stream through stdin/stdout.
.TP
\fB\-r\fR
the rate cap.  Currently an integer number of megabytes per second.
.TP
\fB\-d\fR
debug.  Repeat up to 5 times for more detailed output.
.TP
\fB\-h\fR
display this help and exit
.TP
\fB\-v\fR
output version information and exit
.PP
.SH EXAMPLES
.TP
ratelimit -r 5 < foo | nc -l 1234
Writes the contents of foo to the port opened by nc, no faster than 5MB (~50Mb) per second.
.SH AUTHOR
Written by Derry Hamilton
.SH "REPORTING BUGS"
Report bugs at http://code.google.com/p/ratepipe/issues/entry
.SH COPYRIGHT
Copyright \(co 2009 Derry Hamilton
.br
This is free software.  You may redistribute copies of it under the terms of
the New BSD License
There is NO WARRANTY, to the extent permitted by law.