bwbar/debian/bwbar.8
2015-06-15 10:17:20 -07:00

78 lines
2.1 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35.
.TH BWBAR "8" "Apr. 18, 2006" "bwbar 1.2.3"
.SH NAME
bwbar \- generates text and graphical readout of current bandwidth use.
.SH SYNOPSIS
.B bwbar
[\fB\-i|-o\fR] [\fB\-g|-G|-k|-K|-m|-M\fR] [\fIOPTION\fR]... \fIINTERFACE\fR \fIMAX_MBPS\fR
.SH DESCRIPTION
Generates text and graphical readout of current bandwidth use.
.SH OPTIONS
.TP
\fB\-b\fR, \fB\-\-border\fR=\fIN\fR
Set border width of the graphical bar to N (default 1 pixel).
.TP
\fB\-d\fR, \fB\-\-directory\fR=\fIN\fR
Output directory is N.
.TP
\fB\-f\fR, \fB\-\-text\-file\fR=\fIN\fR
Set N as name of the text output file (default ubar.txt).
.TP
\fB\-h\fR, \fB\-\-help\fR
Display usage.
.TP
\fB\-p\fR, \fB\-\-png\-file\fR=\fIN\fR
Set N as name of the graphical bar file (default ubar.png).
.TP
\fB\-t\fR, \fB\-\-interval\fR=\fIN\fR
The poll interval in seconds is N (default 15 seconds).
.TP
\fB\-x\fR, \fB\-\-width\fR=\fIN\fR
Set the width of the graphical bar to N (default 600 pixels).
.TP
\fB\-y\fR, \fB\-\-height\fR=\fIN\fR
Set the height of the graphical bar to N (default 4 pixels).
.SH FLAGS
.TP
\fB\-i\fR, \fB\-\-input\fR
Measure input bandwidth.
.TP
\fB\-g\fR, \fB\-\-GBps\fR
Bandwidth is measured in GB/s.
.TP
\fB\-G\fR, \fB\-\-Gbps\fR
Bandwidth is measured in Gbit/s.
.TP
\fB\-k\fR, \fB\-\-kbps\fR
Bandwidth is measured in kbit/s.
.TP
\fB\-K\fR, \fB\-\-KBps\fR
Bandwidth is measured in KB/s.
.TP
\fB\-m\fR, \fB\-\-MBps\fR
Bandwidth is measured in MB/s.
.TP
\fB\-M\fR, \fB\-\-Mbps\fR
Bandwidth is measured in Mbit/s.
.TP
\fB\-o\fR, \fB\-\-output\fR
Measure output bandwidth.
.PP
Default values are \fB\-M\fR and \fB\-o\fR.
.SH AUTHOR
Written by Nacho Barrientos Arias <chipi@criptonita.com>.
.SH BUGS
Report bugs to <hpa@zytor.com>.
.SH COPYRIGHT
Copyright \(co 1999-2001 H. Peter Anvin - All Rights Reserved
.br
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, Inc.
.SH "SEE ALSO"
You can get all the available information for
.B bwbar
in:
.IP
.B http://www.kernel.org/pub/software/web/bwbar/
.PP