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