wmweather+: Remove from repository.
[dockapps.git] / wmifs / INSTALL
blob7727d6c0ec550740bbe7cc30e23e534f81942fca
1 Installation instructions for WMiFS.
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 file
18         there, don't worry, nothing will be overwritten ;-)
21 Installation
22 --------------------------------------------------------------
23 1)  % tar -zxvf wmifs-1.4.tar.gz
24 2)  % cd dockapps/wmifs
25 3)  % make
26 4)  % su root
27 5)  # make install
28 6)* # vi ~/.wmifsrc and/or /etc/wmifsrc
29         set up the paths to your pppd
30         start, stop & restart scripts
31 7)  % wmifs & (or wmifs -h for brief help).
33 6)* This is optional, WMiFS also works fine without them,
34     it's entirely up to you ;-)
38 Extra Install Info For Site Administrators!
39 --------------------------------------------------------------
40 For site administrators who don't want their users messing
41 up pppd's configuration files, WMiFS now supports an
42 /etc/wmifsrc.fixed file.
44 The installation will install the normal user and global
45 wmifsrc files in $HOME and /etc, NOT the fixed one!
47 WMiFS scan for 3 files at startup, in the following order:
49         1. /etc/wmifsrc
50         2. $HOME/.wmifsrc
51         3. /etc/wmifsrc.fixed
53 If no .wmifsrc file is found in the users home directory,
54 WMiFS will use the global one (/etc/wmifsrc, if present
55 and valid).
57 When WMiFS finds a /etc/wmifs.fixed file, all settings
58 that WMiFS detected in /etc/wmifsrc and/or $HOME/.wmifsrc
59 will be discarted i.e. OVERRIDDEN!
61 If you want your users to be able to dialout, but you
62 don't want them to mess around, simply move or copy
63 the default /etc/wmifsrc to /etc/wmifsrc.fixed :)
65 Note: When NO wmifsrc files are found at all, WMiFS will
66 work, but quite obvious, WMiFS won't launch any scripts.
67 Make sure there are valid and FULL pathnames in the wmifsrc
68 file(s) if you want WMiFS to launch your pppd scripts ;-)
71 Usage
72 -------------------------------------------------------------
73 WMiFS support the following commandline options:
75         -h              helpscreen
76         -display        X server display where wmppp should
77                         appear (default = 0:0)
78         -i              interface name, note: 'lo' can ONLY
79                         be specified with '-i lo' ;-)
80                         (default = default interface as it
81                          appears in /proc/net/route)
82         -w              draw the statistics graph in waveform
83                         like mode, try it! (default = normal)
84         -v              print wmifs version number
87 General Notes
88 --------------------------------------------------------------
89 Note 1: If "make install" fails on your system, please edit
90         the Makefile to set the paths according to your setup.
91         "make install" defaults to /usr/local/bin, $HOME & /etc.
93 Note 2: Please DO read the HINTS, this file contains some
94         very usefull tips about WMiFS.