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