wmweather+: Remove from repository.
[dockapps.git] / wmppp.app / wmppp / wmppp.1
blob081a1e6bbf84f3d022d9fcee480e7f4aeb16d43a
1 .\"             -*-Nroff-*-
2 .\"
3 .TH wmppp.app 1 "September 1998" "Debian Project" "Debian GNU/Linux"
4 .SH NAME
5 wmppp \- Graphically monitor the average PPP load
6 .P
7 .SH SYNOPSIS
8 .B wmppp
9 .RB [\| \-display
10 .IR <display\ name> \|]
11 .RB [\| \-t \|]
12 .RB [\| \-u
13 .IR <update\ rate> \|]
14 .RB [\| \-i
15 .IR <device> \|]
16 .RB [\| \-h \|]
17 .RB [\| \-v \|]
18 .SH DESCRIPTION
19 \fBwmppp.app\fP displays a dynamic representation of the load on the
20 PPP line on a 64x64 miniwindow. It also starts and stops the
21 connection and displays the time enlapsed since the it came up. The
22 traffic on the interface is also monitored.
23 .SH OPTIONS
24 .TP
25 .B \-display <display\ name>
26 name of display to use
27 .TP
28 .B \-t
29 sets the on-line timer to display MM:SS instead of the default HH:MM.
30 .TP
31 .B \-u <update rate>
32 sets the frequency, in seconds, for updates to the display.  Valid
33 range is 1-10, default value is 5.
34 .TP
35 .B \-i <device>
36 choose the net device (ppp1, ippp0, etc.) to monitor.  (Note that this
37 feature is EXPERIMENTAL and should be used with caution.  Bug reports
38 are welcomed.)
39 .TP
40 .B \-h
41 displays a command line summary
42 .TP
43 .B \-v
44 displays the version number.
45 .SH CONFIGURATION
46 The configuration file (see below) may contain any of the following
47 key-value pairs. The format is \fIkey: value\fP.
48 .TP
49 .I start
50 The program that starts the connection
51 .TP
52 .I stop
53 The program that stops the connection
54 .TP
55 .I speed
56 This program reports the speed of the connection. This program should
57 output \fI<speed>\fP, that is, a \fInumber\fP is expected and not the
58 whole \"CONNECT\" line the modem outputs.
59 .TP
60 .I ifdown
61 This program is run if the line goes down, and the \fIstop\fP program
62 hasn't been run. (Redial program)
63 .TP
64 .I stampfile
65 The modification time of this file is used to calculate the amount of
66 time the connection has been up. Something like \fItouch <stampfile>\fP
67 should be run for this to work.
68 .SH FILES
69 .TP
70 /var/run/wmppp.\fIppp0\fP
71 this is the stamp file use to determine the ammount of time enlapsed
72 since the connection came up. This file should be managed by the ip-up
73 and ip-down scripts. On Debian systems, \fI/etc/ppp/ip-up.d/00wmppp\fP
74 creates the file, and \fI/etc/ppp/ip-down.d/00wmppp\fP removes it.
75 .TP
76 /etc/wmppprc
77 System wide defaults
78 .TP
79 $HOME/.wmppprc
80 User defined settings
81 .TP
82 /etc/wmppprc.fixed
83 System wide fixed options, this overrides the user settings
84 .SH AUTHORS
85 \fBwmppp.app\fP was written by \fIMartijn Pieterse
86 <pieterse@xs4all.nl>\fP and \fIAntoine Nulle <warp@xs4all.nl>\fP, and
87 it's based on work by \fIBeat Christen <bchriste@iiic.ethz.ch>\fP
88 (asclock) and \fIMichael Callahan <callahan@maths.ox.ac.uk>\fP, \fIAl
89 Longyear longyear@netcom.com\fP and \fIPaul Mackerras
90 <Paul.Mackerras@cs.anu.edu.au>\fP (pppstats).
92 Email regarding wmppp should be sent to
93 \fIwmaker-dev@lists.windowmaker.org\fP.
95 This manpage was written by \fIMarcelo Magallon
96 <mmagallo@debian.org\fP for the \fIDebian Project\fP
97 .SH "SEE ALSO"
98 .BR pppd (8),
99 .BR pppstats (8),
100 .BR plog (1),
101 .BR pon (1),
102 .BR poff (1)