wmail: fixed warnings about unused parameters.
[dockapps.git] / wmppp.app / INSTALL
blobdb39b9f3b6d99af9c0c61ee6ab419f95e3cc5055
1 Installation instructions for WMPPP.
4 NOTE!
5 --------------------------------------------------------------
6 Installing this program requires root privileges, ask your
7 local system/network administrator kindly if she/he wants
8 to install this software for you ;-)
11 Requirements
12 ----------------------------------------------------------
13 - root access
15         To be able to complete the installation you'll need
16         to make changes in the system's /etc/ directory,
17         the installation copies the GLOBAL config files
18         there, don't worry, nothing will be overwritten ;-)
20 Make sure libdockapp (at least version 0.7.0) is installed. It
21 may be obtained at
22 https://www.dockapps.net/libdockapp
24 Installation
25 --------------------------------------------------------------
26 1) % tar -zxvf wmppp-1.x.x-tar.gz
27 2) % make all
28 3) % su root
29 4) # make install
30 5) # vi ~/.wmppprc
31          set up the paths to your ppp start,
32          stop & restart scripts
34 6) % wmppp & (try 'wmppp -h &' for help)
37 Extra Install Info For Site Administrators!
38 --------------------------------------------------------------
39 For site administrators who don't want their users messing
40 up pppd's configuration files, but do want them to be able
41 to make a dialup connection, a sample system.rc file is
42 included (system.wmppprc), please take a look at it!
44 The installation will install a standard rc file in /etc
45 WITHOUT the 'force' option!  You can also create one in
46 $HOME (~/.wmpprc).
48 How it works:
50 WMPPP first scans /etc/ if there is a wmppprc present.
52 If true, it will scan if the keyword 'force' is trailing
53 a command, for example 'forceleft' instead of 'left'.
55 If the keywords 'force' are indeed trailing the 'normal'
56 commands, all user .wmppprc files will be ignored i.e.
57 OVERRIDDEN ;-)
59 If the 'force' keyword is not found in /etc/wmppprc,
60 WMPPP will scan the users home directory to see if
61 there is a valid .wmppprc available.
63 When a valid ~/.wmppprc is found, and no 'force' keyword
64 is present in /etc/wmppprc, WMPPP will use the users
65 .wmppprc file instead.
67 If no wmppprc file is found in the users home directory,
68 WMPPP will use the global one (/etc/wmppprc).
70 If NO wmppprc files are found at all, WMPPP will work,
71 but quite obvious, WMPPP won't launch your scripts.
73 Make sure there are valid and FULL pathnames in wmppprc
74 if you want WMPPP to launch your pppd scripts ;-)
77 General Notes
78 --------------------------------------------------------------
79 Note 1: If "make install" fails on your system, please edit
80         the Makefile to set the paths according to your setup.
81         Make install defaults to /usr/local/bin & /etc/ppp/.
82         You may also change these directories using the various
83         variables, e.g., make PREFIX=/usr.
85 Note 2: Please DO read the HINTS, this file contains some
86         very useful tips and hints about WMPPP.