| blob | 3cc1772e74cf6fde0091c0789816e9a906a56662 |
1 .\" -*-Nroff-*-
2 .\"
3 .TH wmnet 1x "4 May 2000"
4 .SH NAME
5 wmnet \- an IP accounting monitoring tool
6 .SH SYNOPSIS
7 .B wmnet
8 .RB [\| -h,--help \|]
9 .RB [\| -v,--version \|]
10 .RB [\| -T,--txrule=\fINUM \|]
11 .RB [\| -R,--rxrule=\fINUM \|]
12 .RB [\| -l,--logscale \|]
13 .RB [\| -t,--txcolor=\fICOLOR \|]
14 .RB [\| -r,--rxcolor=\fICOLOR \|]
15 .RB [\| -d\ \fIDELAY \|]
16 .RB [\| -x,--maxrate=\fIBYTES \|]
17 .RB [\| -F,--labelfg=\fICOLOR \|]
18 .RB [\| -B,--labelbg=\fICOLOR \|]
19 .RB [\| -L,--label=\fILABEL \|]
20 .RB [\| -e,--execute=\fICOMMAND \|]
21 .RB [\| -p,--promisc=\fIDEVICE \|]
22 .RB [\| -u,--unpromisc=\fIDEVICE \|]
23 .RB [\| -w,--withdrawn\ |\ -n,--normalstate \|]
24 .RB [\| -D,--driver=\fIDRIVER \|]
25 .RB [\| -W,--device=\fIDEVICE \|]
26 .SH DESCRIPTION
27 \fBwmnet\fP polls network statistics and does a few things with
28 the data it gets. It has small blinking lights for the rx and tx of IP
29 packets, a digital speedometer of your networks current
30 speed and a bar graph like xload plotting your throughput. It
31 has a tx speed graph from bottom-up and rx speed graph from the top-down.
32 The speedometer keeps track of the current speed per second and shows
33 it in a color corresponding to which of rx or tx that has the highest
34 speed at the moment. Also, the graph is drawn in a way that the highest
35 speed is drawn on top of the other while the other is in the background.
36 .SS OPTIONS
37 .TP
38 .B \-h,--help
39 displays a brief help message
40 .TP
41 .B -v,--version
42 displays version information
43 .TP
44 .B \-T,--txrule=\fINUM or NAME
45 in the case of the ipfwadm driver, this is the accounting rule number
46 to monitor for tx. For the ipchains driver, this is the chain name to
47 watch.
48 .TP
49 .B \-R,--rxrule=\fINUM or NAME
50 in the case of the ipfwadm driver, this is the accounting rule number
51 to monitor for rx. For the ipchains, this is the chain name to watch.
52 .TP
53 .B \-t,--txcolor=\fICOLOR
54 specifies the tx color
55 .TP
56 .B \-r,--rxcolor=\fICOLOR
57 specifies the rx color
58 .TP
59 .B \-x,--maxrate=\fIBYTES
60 maximum transfer rate for graph scale. Defaults to 6000, which should
61 be in the right area for modem connections. The key is to experiment
62 with this setting and the --logscale option to get the kind of graph
63 that fits your connection type. A general rule of thumb is to set this
64 to 4 to 5 times greater than your maximum throughput. The author finds
65 using --logscale and --maxrate=10000000 to work nicely for the entire range
66 of his dorms ethernet based connection to the internet.
68 .TP
69 .B \-l,--logscale
70 sets logarithmic scale, which is good for fast connections. This will
71 allow, for example, the graph still being informative at extremely low
72 speeds (telnet), and extremely fast speeds (local FTP) simultaneously
73 without the scale constantly being blank or solid at those respective
74 extremes.
75 .TP
76 .B -L,--label=\fILABEL
77 prints a given text label on the bottom of the window
78 .TP
79 .B -F,--labelfg=\fICOLOR
80 specifies the color for the text of the label
81 .TP
82 .B -B,--labelbg=\fICOLOR
83 specifies the color for the background of the label text
84 .TP
85 .B --withdrawn
86 .TP
87 .B --normalstate
88 sets the initial state of wmnet. WMnet tries to automatically determine which
89 state to start up in by starting up in withdrawn state if a WindowMaker
90 defined atom is present, and in normalstate otherwise. This behavior is
91 overriden by specifying one of these options.
92 .TP
93 .B -e,--execute=\fICOMMAND
94 executes \fICOMMAND \fPon a single click from button 1 (left mouse button).
95 .TP
96 .B -u,--unpromisc=\fIDEVICE
97 .TP
98 .B -p,--promisc=\fIDEVICE
99 put \fIDEVICE \fPin promiscuous mode to start applying accounting rules to all
100 network packets on your network segment. You either need to be root or
101 have the wmnet binary suid root to use this feature. This option may be
102 given more than once on the command line to specify more than one device.
103 .TP
104 .B \-d \fIDELAY
105 delay time for polling /proc/net/ip_account (in
106 microseconds). Defaults to 25000, that is 0.025 seconds, or 40 Hz
107 .TP
108 .B -D,--driver=\fIDRIVER
109 use \fIDRIVER \fP to get the stats we monitor. Compiled in drivers can be listed
110 with the -h switch.
111 .TP
112 .B -W,--device=\fIDEVICE
113 watch statistics for \fIDEVICE \fP. This option is only used for certain
114 stat drivers, namely: kmem, devstats, and pppstats. The ipchains and ipfwadm
115 stat drivers do not use this parameter.
116 .SH STAT DRIVERS
117 wmnet uses different stat drivers to get the stats it needs to monitor your
118 network. Exactly what drivers are available is determined at compile time. The
119 driver wmnet ultimately uses at runtime is dependent on your system. There
120 are 4 drivers specific to Linux and 1 to *BSD. The driver used can be overridden
121 by the --driver option. The available drivers are \fIpppstats, devstats, ipfwadm,
122 ipchains\fP and \fIkmem\fP.
123 .TP
124 .B pppstats
125 this driver works on Linux 2.0 or Linux 2.1 for ONLY ppp type devices.
126 Specify the \fI--device\fP option for the interface to monitor. By default it
127 uses interface ppp0. Please note, that if the ppp device is not available or active, wmnet
128 will continue to try in the hopes that it is only temporarily offline.
129 .TP
130 .B devstats
131 use this driver on Linux 2.1 kernels for any interface. Pass the \fI--device\fP option
132 for the device you want monitored, otherwise, the default is eth0. This will be available
133 for ONLY Linux 2.1 kernels and will always be there on those kernels.
134 .TP
135 .B ipfwadm
136 use this driver on Linux 2.0 kernels compiled with IP accounting. It won't work on Linux 2.1.
137 You'll also need to specify the \fI--txrule\fP and \fI--rxrule\fP options. By default, wmnet uses
138 the first two rules it finds.
139 .TP
140 .B ipchains
141 this driver will only work in Linux 2.1 kernels with IP chains compiled in. You'll want to also
142 specify the \fI--txrule\fP and \fI--rxrule\fP options and specify the chain names. By default it
143 uses the chains "acctin" and "acctout"
144 There must be at least one rule on the named ipchain, if there is more
145 than one rule in the specified chain, it uses the first. The chain
146 must not immediately return to the parent chain, it has to pass through a rule first.
147 Otherwise, the kernel will not collect the stats we need.
148 .TP
149 .B kmem
150 this driver is available on FreeBSD and OpenBSD systems and must be passed
151 a device through the \fI--device\fP option. By default, it uses ec0 but
152 will accept any valid device name.
153 .SH FILES
154 .TP
155 .I /proc/net/ip_acct /proc/net/dev /proc/net/ipchains
156 kernel net accounting information
157 .SH AUTHORS
158 \fBwmnet\fP was created by \fIJesse B. Off <joff@iastate.edu>\fP and is
159 maintained by \fIKatharine Osborne <kaos@digitalkaos.net>\fP.
161 This manpange was originally written by \fIMarcelo Magallon
162 <mmagallo@debian.org>\fP for the \fIDebian Project\fP, and is GNU
163 Copyright 1998 Marcelo Magallon and later modifed by \fIJesse Off\fP
164 and \fIKatharine Osborne\fP for WMnet versions 1.05 and above.
165 .SH "SEE ALSO"
166 .BR wmaker (1x)