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