wmacpi: move variable and remove header.
[dockapps.git] / wmppp.app / HINTS
blob66a0946a552bc616c9eb289a7371ccbc9a3eb159
1 Hints for WMPPP
3 Generic
4 --------------------------------------------------------------
5 WMPPP supports various commandline options, 'wmppp -h' prints
6 help about them...
9 WindowMaker
10 --------------------------------------------------------------
11 WindowMaker users simply drag and drop the WMPPP dock.app on
12 the WindowMaker Dock (preferred) or the Clip.
14 Now press the rightmouse button on WMPPP's outer edges and
15 select "Settings..." from the popup menu that appears.
17 Enable the 'Start when WindowMaker is started' option, then
18 click on the 'OK' button in the Docked Applications Panel.
21 Afterstep
22 --------------------------------------------------------------
23 Afterstep users put something like this in their .steprc
24 "Wharf wmppp - MaxSwallow "wmppp" wmppp &"
27 Other WindowManagers
28 --------------------------------------------------------------
29 For other windowmanagers, WMPPP runs nicely as a 64x64
30 pixel shaped icon on your desktop.
32 BTW, FVWM can swallow it too, so we've heard ;-)
35 Dragging WMPPP
36 --------------------------------------------------------------
37 Be sure to drag WMPPP on it's outer edges, WMPPP is a bit
38 picky due to the large gfx pixmap it keeps ;-)
41 Usage
42 --------------------------------------------------------------
43 WMPPP supports the following commandline options:
45         -h              helpscreen
46         -display        X server display (default = 0:0)
47         -geometry       +XPOS+YPOS, initial window position
48         -i <device>     Interface to monitor (ppp0, ppp1, etc)
49                         EXPERIMENTAL!
50         -t              set the on-line timer to MM:SS instead
51                     of HH:MM (default is HH:MM)
52         -u <rate>       (1..10), default 5 seconds
53         -v              print wmppp's version number
56 Note: When you start up WMPPP and make a connection to your ISP,
57 it will first display the CARRIER or CONNECT for 60 seconds on a
58 succesfull connect, after those 60 seconds, the CARRIER/CONNECT
59 value will disappear and the Speed-O-Meter will take it's place.
62 Creating PPP dialup scripts
63 --------------------------------------------------------------
64 Since we've dropped the graphic configuration GUI,
65 you'll have to create some dialup scripts yourself
66 for usage with WMPPP and/or WMiFS.
68 Because a very good PPP HowTo already exists,
69 it's quite pointless for us to explain to you
70 how you should and can make them...
72 Read the PPP HowTo, and you'll see that it's very
73 easy to create your own PPP scripts ;-)
76 As an extra service, we've provided some example ppp scripts
77 which you can find in wmppp/example-scripts/ directory.
79 These are the ppp scripts both authors use, you just need to
80 fill in your ISP's phonenumber, your loginname and password
81 in wmppp/example-scripts/wmppp-chat like:
83         OK ATDT1234567
84         ogin:MyUserName
85         word:MyPassWord
87 Save it, and copy all files in wmppp/example-scripts/ to
88 /etc/ppp/ for example...
91 Setting up the WMPPP rc files
92 --------------------------------------------------------------
93 WMPPP can launch your own ISP scripts for the V (connect)
94 and X (disconnect) buttons and a hidden one that takes care
95 of redialing in case your connection breaks.
97 You can define them in your ~/.wmppprc like:
99         speed: /etc/ppp/getmodemspeed
100         start: /home/ppp/wmppp-start
101         stop: /home/ppp/wmppp-stop
102         ifdown: /home/ppp/wmppp-restart
104 Note: The option 'speed:' is to define the location where
105 'getmodemspeed' resides, getmodemspeed is a little program
106 that's responsible for the WMPPP CARRIER/CONNECT display.
108 You'll also need two entries in your 'chatfile' i.e.
110         REPORT CARRIER
111         REPORT CONNECT
113 This will make chat log all connects and carriers to
114 /etc/ppp/connect-errors, which getmodemspeed needs,
115 that is, if you want WMPPP to display your CARRIER
116 or CONNECT resp.
118 Also make sure that you use a recent ppp package (2.3.3),
119 because older chat versions (chat is part of the ppp package)
120 doesn't provide sufficient logging features, and because
121 the older ppp versions have (major) security holes...
123 p.s. All major _recent_ Linux distributions like Debian,
124 RedHat and SuSe ship with proper ppp versions as standard.
127 Linux Distribution ppp script info
128 --------------------------------------------------------------
130 RedHat users who use ControlPanel for example to set up ppp
131 scripts (we don't, we assure you ;-) ) can launch the appropriate
132 RedHat ppp scripts, same applies to Debian and any other other
133 distribution which provide a simular non-standard ppp setup
134 feature for setting up ppp scripts.
136 See the documentation that ships with your Linux distribution
137 for more info (if needed).
139 Of course you may also use your previous created ppp scripts.
142 Permissions to allow non-root ppp connections
143 --------------------------------------------------------------
144 WMPPP will connect just fine when run as root, but if you want
145 to run WMPPP as a non-root user, there are a few files and
146 programs to make permissions changes to.
148 WMPPP (actually pppd) needs access to the device file your
149 modem is on, so if you use COM1, then the modem device file
150 you use is /dev/cua0 or /dev/ttyS0 (depending on your Linux
151 and kernel version).
153 Change the permissions so that it is world read/writable:
155         chmod 666 /dev/cua0  or
156         chmod 666 /dev/ttyS0
158 The ppp daemon also makes calls to the kernel which require root
159 permissions. The pppd daemon must be owned by root, and then have
160 it's set-user-id bit turned on. This way, the pppd daemon will
161 always run as SUID root. Change the owner and SUID bit like:
163         chown root.root pppd
164         chmod +s pppd
167 --------------------------------------------------------------
168 Note: If you run a site where users may not fiddle with the
169       PPP scripts, read INSTALL > Info For Site Admins!