Annotation of embedaddon/bmon/man/bmon.8, revision 1.1
1.1 ! misho 1: .TH "bmon" "8" "" "Bandwidth Monitor" "bmon"
! 2: .SH "NAME"
! 3: bmon \- bandwidth monitor and rate estimator
! 4: .SH "SYNOPSIS"
! 5: .B bmon
! 6: [\fB\-\-show\-all\fR]
! 7: [\fB\-\-use\-si\fR]
! 8: [\fB\-\-input\fR=\fIMODULE\fR]
! 9: [\fB\-\-output\fR=\fIMODULE\fR]
! 10: [OPTIONS...]
! 11:
! 12: .SH "DESCRIPTION"
! 13: bmon is a monitoring and debugging tool to capture networking related
! 14: statistics and prepare them visually in a human friendly way. It
! 15: features various output methods including an interactive curses user
! 16: interface and a programmable text output for scripting.
! 17:
! 18: .SH "OPTIONS"
! 19: .PP
! 20: \fB \-h\fR, \fB\-\-help\fR
! 21: .RS 4
! 22: Prints a short help text and exits\&.
! 23: .RE
! 24: .PP
! 25: \fB \-V\fR, \fB\-\-version\fR
! 26: .RS 4
! 27: Prints the versioning identifier and exits\&.
! 28: .RE
! 29: .PP
! 30: \fB \-i\fR, \fB\-\-input=\fRMODULE[:OPTIONS][,MODULE...]
! 31: .RS 4
! 32: Set list of input modules to load and use. Multiple modules can be used
! 33: in parallel. bmon automatically loads a useful and working input module
! 34: by default. See INPUT MODULES for more details.
! 35: .RE
! 36: .PP
! 37: \fB \-o\fR, \fB\-\-ouptut\fRMODULE[:OPTIONS][,MODULE...]
! 38: .RS 4
! 39: Set list of output modules to load and use. Multiple modules can be used
! 40: in parallel. By default, bmon will use the curses output mode, if that is
! 41: not available due to an incompatible console it will fall back to a simple
! 42: text mode. See OUTPUT MODULES for more details.
! 43: .RE
! 44: .PP
! 45: \fB \-U\fR, \fB\-\-use\-si\fR
! 46: .RS 4
! 47: Use SI unit system instead of 1KB = 1'024 bytes.
! 48: .RE
! 49: .PP
! 50: \fB \-f\fR, \fB\-\-configfile=\fRFILE
! 51: .RS 4
! 52: Set alternative path to configuration file.
! 53: .RE
! 54: .PP
! 55: \fB \-p\fR, \fB\-\-policy=\fRPOLICY
! 56: .RS 4
! 57: Set policy defining which network interfaces to display. See
! 58: INTERFACE SELECTION for more details.
! 59: .RE
! 60: .PP
! 61: \fB \-a\fR, \fB\-\-show\-all=\fR
! 62: .RS 4
! 63: Display all interfaces, even interface that are administratively down.
! 64: .RE
! 65: .PP
! 66: \fB \-r\fR, \fB\-\-read\-interval=\fRFLOAT
! 67: .RS 4
! 68: Set interval in seconds in which input modules read statistics from their
! 69: source. The default is 1.0 seconds.
! 70: .RE
! 71: .PP
! 72: \fB \-R\fR, \fB\-\-rate\-interval=\fRFLOAT
! 73: .RS 4
! 74: Set interval in seconds in which the rate per counter is calculated.
! 75: The default is 1.0 seconds.
! 76: .RE
! 77: .PP
! 78: \fB \-L\fR, \fB\-\-lifetime=\fRFLOAT
! 79: .RS 4
! 80: Set lifetime of an element in seconds before it is no longer displayed
! 81: without receiving any statistical updates. The default is 30 seconds.
! 82: .RE
! 83:
! 84: .SH "INPUT MODULES"
! 85: .PP
! 86: Input modules provide statistical data about elements. Each element consists
! 87: of attributes which represents a counter, a rate, or a percentage. Elements
! 88: may carry additional child elements to represent a hierarchy. Each element is
! 89: assigned to a group defined by the input module. Input modules are polled in
! 90: the frequence of the configured read interval.
! 91: .PP
! 92: The following input modules are available:
! 93: .TP
! 94: \fBnetlink\fR
! 95: Uses the Netlink protocol to collect interface and traffic control statistics
! 96: from the kernel. This is the default input module.
! 97:
! 98: .TP
! 99: \fBproc\fR
! 100: Reads interface statistics from the /proc/net/dev file. This is considered a
! 101: legacy interface and provided for backwards compatibily reasons. This is a
! 102: fallback module if the Netlink interface is not available.
! 103:
! 104: .TP
! 105: \fBdummy\fR
! 106: Programmable input module for debugging and testing purposes.
! 107:
! 108: .TP
! 109: \fBnull\fR
! 110: No data collected.
! 111:
! 112: .PP
! 113: To receive additional information about a module, run the module with the
! 114: "help" option set like this:
! 115:
! 116: .PP
! 117: .RS 4
! 118: bmon \-i netlink:help
! 119: .RE
! 120:
! 121: See MODULE CONFIGURATION for more details.
! 122:
! 123: .SH "OUTPUT MODULES"
! 124: .PP
! 125: Output modules display or export the statistical data collected by input
! 126: modules. Multiple output modules can be run at the same time. bmon will
! 127: not prevent possible conflicts such as multiple output modules writing to
! 128: the console.
! 129: .PP
! 130: The following output modules exist:
! 131:
! 132: .TP
! 133: \fBcurses\fR
! 134: Interactive curses based text user interface providing real time rate
! 135: estimations and a graphical representatio nof each attribute. Press '?'
! 136: to display the quick reference guide. This is the default output mode.
! 137:
! 138: .TP
! 139: \fBascii\fR
! 140: Simple programmable text output intended for human consumption. Capable
! 141: of printing list of interfaces, detailed counters and graphs to the
! 142: console. This is the default fallback output mode if curses is not
! 143: available.
! 144:
! 145: .TP
! 146: \fBformat\fR
! 147: Fully scriptable output mode inteded for consumption by other programs.
! 148: See the module help text for additional information.
! 149:
! 150: .TP
! 151: \fBnull\fR
! 152: Disable output.
! 153:
! 154: .PP
! 155: To receive additional information about a module, run the module with the
! 156: "help" option set like this:
! 157:
! 158: .PP
! 159: .RS 4
! 160: bmon \-o curses:help
! 161: .RE
! 162:
! 163: See MODULE CONFIGURATION for more details.
! 164:
! 165: .SH "MODULE CONFIGURATION"
! 166: .PP
! 167: The syntax to configure modules is as follows:
! 168: .PP
! 169: .RS 4
! 170: ARGUMENT ::= mod1[:OPTS][,mod2[:OPTS]...]
! 171: .br
! 172: OPTS ::= OPTION[;OPTION...]
! 173: .br
! 174: OPTION ::= option[=value]
! 175: .RE
! 176:
! 177: .PP
! 178: Run the module with option "help" to receive the list of options for each
! 179: module:
! 180:
! 181: .PP
! 182: .RS 4
! 183: bmon \-i module:help
! 184: .RE
! 185:
! 186: .SH "INTERFACE SELECTION"
! 187: .PP
! 188: The following syntax is used to define the interface selection policy:
! 189: .PP
! 190: .RS 4
! 191: SELECTION ::= NAME[,NAME[,...]]
! 192: .br
! 193: NAME ::= [!]interface
! 194: .RE
! 195:
! 196: .PP
! 197: The interface name may contain the character '*' which will act as a wildcard
! 198: and represents any number of any character type, e.g. eth*, h*0, ...
! 199:
! 200: .PP
! 201: Examples:
! 202:
! 203: .PP
! 204: .RS 4
! 205: lo,eth0,eth1
! 206: .br
! 207: eth*,!eth0
! 208: .RE
! 209:
! 210: .SH "EXAMPLES"
! 211: .PP
! 212: To run bmon in curses mode monitoring the interfaces eth0
! 213: and eth1:
! 214: .PP
! 215: .RS 4
! 216: \fBbmon \-p eth0,eth1 \-o curses\fP
! 217: .RE
! 218:
! 219: .SH "FILES"
! 220: /etc/bmon.conf
! 221: .br
! 222: $HOME/.bmonrc
! 223:
! 224: .SH "SEE ALSO"
! 225: .PP
! 226: \fBip\fR(8),
! 227: \fBnetstat\fR(8),
! 228: \fBifconfig\fR(8),
! 229: \fBnetlink\fR(7),
! 230:
! 231: .SH "AUTHOR"
! 232: Thomas Graf <tgraf@suug.ch>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to bmon.8 CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / bmon / man