wmifs/INSTALL

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