yawmppp/README

   1
   2                                YAWMPPP
   3                             version 2.0.2
   4                Yet Another PPP Window Maker dock applet
   5                        (C) 2000 Felipe Bergo
   6
   7 Table of Contents
   8
   9 Overview
  10 Requirements
  11 Installing
  12 Features
  13 Files
  14 Reporting Bugs
  15 Usage Hints
  16   Programs
  17   Interface Guide
  18   Window Manager Placement
  19   Configuration
  20     DNS Servers
  21     Modem Ports
  22     Login/Password expects
  23   Trouble?
  24 More Documentation
  25
  26 Overview
  27 --------
  28
  29 YAWMPPP sits in Window Maker's dock (or AfterStep's Wharf, or keeps
  30 standing as a 64x64 window with other Window Managers) and manages
  31 PPP connections. For window managers not capable of docking
  32 yawmppp also provides a bar shaped version (yawmppp.thin).
  33
  34 It includes a GUI to easily setup your ISP entries, so that you
  35 don't need to edit CHAT scripts.
  36
  37 YAWMPPP is distributed under the terms of the GNU General Public
  38 License, version 2 or later (at your choice). A copy of the
  39 license is provided in the file COPYING in this same directory.
  40
  41 Requirements
  42 ------------
  43
  44 YAWMPPP is known to run on Linux (tested with 2.2 kernels) and FreeBSD
  45 (tested with 3.4-RELEASE) and has been reported to work with NetBSD 1.5.
  46
  47 You'll need:
  48
  49 - root access to install YAWMPPP
  50
  51 - A kernel with PPP support compiled in.
  52
  53 - pppd, the ppp daemon, installed in /usr/sbin/pppd
  54   (currently this path mandatory for the builtin scripts to
  55   work). If you wish to use YAWMPPP as non-root pppd must
  56   have the setuid bit set. The RedHat installation already
  57   brings this set.
  58   Version 2.3.11 or newer is recommended.
  59
  60 - the "chat" program (usually included in the pppd package, comes
  61   with the FreeBSD distribution too).
  62
  63 - GTK+ 1.2.1 or greater. 1.2.6 recommended.
  64   If you don't have it you can grab it from
  65
  66   http://www.gtk.org
  67
  68   Remember to get the GLib too (needed by GTK+).
  69
  70   On RedHat-based systems (RedHat itself, Mandrake, Conectiva,
  71   Independence, etc.) you'll need these packages installed to
  72   compile YAWMPPP:
  73
  74   glib-1.2.x
  75   glib-devel-1.2.x
  76   gtk+-1.2.x
  77   gtk+-devel-1.2.x
  78
  79 Author: Felipe Bergo <bergo@seul.org>, who built YAWMPPP
  80         using code from the WMPPP application developed by
  81         Martijn Pieterse and Antoine Nulle.
  82
  83         YAWMPPP's web page is located at
  84         http://yawmppp.seul.org
  85
  86         For more information on WMPPP see
  87         http://windowmaker.mezaway.org
  88
  89 Installing
  90 ----------
  91
  92 Read the file INSTALL for instructions. Be sure to read this file
  93 entirely before using YAWMPPP
  94
  95 Features
  96 --------
  97 YAWMPPP features all things the standard pppd offers and gives
  98 you some additional amusements:
  99
 100         * Integrated online timer;
 101         * Integrated modem RX/TX LED's;
 102         * Integrated YAWMPPP status LED;
 103         * Integrated autoscaling PPP transfer statistics;
 104         * Integrated bytes/second Speed-O-Meter;
 105         * Automatic detection of active ppp interfaces;
 106         * Several commandline options (try '-h' for help);
 107         * Easy ISP configuration GUI
 108         * Multiple ISP entries support
 109         * Logging facility with GUI viewer
 110
 111 Files
 112 -----
 113 README          This file.
 114 INSTALL         Installation instructions.
 115 CHANGELOG       Description of changes.
 116 COPYING         GNU General Public License Version 2.
 117 FAQ             Frequently Asked Questions
 118
 119
 120 Reporting Bugs
 121 --------------
 122 If you discover any bugs in this software, please send a
 123 bug report to bergo@seul.org and describe the
 124 problem as detailed as you can.
 125
 126
 127 Usage Hints
 128 -----------
 129
 130 First of all: you can type "man yawmppp" for help at the command line.
 131
 132 Programs:
 133 ---------
 134
 135 yawmppp         - The PPP dock applet
 136 yawmppp.thin    - A PPP applet for non dock-capable window managers
 137                   (e.g. Enlightenment, Sapphire...)
 138 yawmppp.pref    - The Dialing setup tool (can be run from
 139                   yawmppp by clicking the left mouse
 140                   button in the display area)
 141 yawmppp.log     - The log view tool (can be run from yawmppp
 142                   by clicking the middle or right mouse buttons
 143                   in the display area)
 144
 145 Interface guide (yawmppp)
 146 -------------------------
 147 Please, don't laugh at the drawing.
 148
 149 +-----------------------------+ A : Connection timer
 150 |+---------------------------+|
 151 ||AAAAAAAAAAA     BB  CC  DD || B : RX LED (blinks when PPP packets
 152 ||AAAAAAAAAAA     BB  CC  DD ||             are received)
 153 ||                           ||
 154 ||EEEEEEEEEEEEEEEEEEEEEEEEEEE|| C : TX LED (blinks when PPP packets
 155 ||EEEEEEEEEEEEEEEEEEEEEEEEEEE||             are sent)
 156 ||EEEEEEEEEEEEEEEEEEEEEEEEEEE||
 157 ||EEEEEEEEEEEEEEEEEEEEEEEEEEE|| D : ON/OFF LED: dark when there is no
 158 ||                           ||            active connection, GREEN if
 159 ||FFFFFFFFFF    GGGGGGGGGGGGG||            the connection is up, YELLOW
 160 ||FFFFFFFFFF    GGGGGGGGGGGGG||            while dialing, RED on error.
 161 |+---------------------------+|
 162 |+-----++-----+ +-----++-----+| E : Speed history
 163 ||     ||     | |     ||     ||
 164 ||  <  ||  >  | |  V  ||  X  || F : ISP entry name (short)
 165 ||     ||     | |     ||     ||
 166 |+-----++-----+ +-----++-----|| G : Connection speed, speed-o-meter,
 167 +-----------------------------+     error messages
 168
 169                                 < : selects prior ISP. You can't change
 170                                     the ISP entry while online
 171
 172                                 > : selects next ISP.
 173
 174                                 V : connects to currently selected ISP
 175
 176                                 X : closes current connection.
 177
 178 You can click the display area with the left mouse button to open the
 179 ISP configuration tool (yawmppp.pref) or with any other mouse button
 180 to open the connection log viewer (yawmppp.log).
 181
 182 Window Manager Placement
 183 ------------------------
 184 Window Maker: Window Maker users simply drag and drop YAWMPPP on
 185               the WindowMaker Dock or the Clip.
 186               Press the right mouse button on YAWMPPP's outer edges and
 187               select "Settings..." from the popup menu that appears.
 188               Enable the 'Start when WindowMaker is started' option,
 189               then click on the 'OK' button in the Docked Applications
 190               Panel.
 191
 192 AfterStep:    Afterstep users put something like this in their Wharf rc
 193               file "Wharf yawmppp - MaxSwallow "yawmppp" yawmppp &"
 194               (this should be somewhere under ~/GNUstep/Library/AfterStep)
 195
 196 Elsewhere:    For other windowmanagers, YAWMPPP runs nicely as a 64x64
 197               pixel shaped icon on your desktop. You may prefer to run
 198               yawmppp.thin when not using Window Maker or AfterStep.
 199
 200 Configuration
 201 -------------
 202
 203 YAWMPPP's configuration files stay beneath ~/.yawmppp2, which will
 204 be created as soon as you run yawmppp for the first time. The main
 205 configuration file is yawmppprc. You should use the yawmppp.pref
 206 application to create your entries. If you're willing to edit entries
 207 by hand, create some bogus entries with yawmppp.pref and take a look
 208 at the generated files for hints. It should be easy to figure out.
 209
 210 The format has changed since YAWMPPP 1.x.x, thus the
 211 directory has changed (from ~/.yawmppp to ~/.yawmppp2).
 212
 213 Don't try copying files between 1.x.x and 2.x.x versions.
 214
 215 Modem ports
 216 -----------
 217 On Linux the serial ports are (or at least should be :-) ):
 218
 219 /dev/cua0  _or_  /dev/ttyS0  : DOS' COM1
 220 /dev/cua1  _or_  /dev/ttyS1  :  "   COM2
 221 /dev/cua2  _or_  /dev/ttyS2  :  "   COM3
 222 /dev/cua3  _or_  /dev/ttyS3  :  "   COM4
 223
 224 If you don't know where your modem is, type
 225
 226   dmesg | grep tty
 227
 228 It should print something like
 229
 230   ttyS00 at 0x03f8 (irq = 4) is a 16550A
 231   ttyS01 at 0x02f8 (irq = 3) is a 16550A
 232   ttyS02 at 0x03e8 (irq = 4) is a 16550A
 233
 234 If it shows the wrong irq to you, add a setserial command
 235 to one of your boot time scripts (maybe /etc/rc.d/rc.local)
 236 like:
 237
 238   /bin/setserial /dev/ttyS2 irq 10
 239
 240 See "man setserial" for more information.
 241
 242 On FreeBSD the dialout serial ports are
 243
 244   /dev/cuaa0 (kernel interface sio0)
 245   /dev/cuaa1 (kernel interface sio1)
 246   /dev/cuaa2 (kernel interface sio2)
 247   /dev/cuaa3 (kernel interface sio3)
 248
 249 If it fails to recognize your modem's port, or gives it the wrong
 250 IRQ, you have to compile a new kernel with the correct settings.
 251 Read the FreeBSD handbook if don't know how to do this
 252 (/usr/share/doc/books/handbook)
 253
 254 Login/Password Expects
 255 ----------------------
 256 The supplied expects for login and password are rather common,
 257 but if it fails, connect to your ISP using a standard communication
 258 program (like minicom) and watch what the ISP sends to ask for
 259 login and password.
 260
 261 Trouble?
 262 --------
 263 Read the FAQ in this same directory.
 264
 265 More Documentation
 266 ------------------
 267 Linux users can read the ISP-Hookup and PPP howtos. These howtos
 268 are available from
 269
 270   http://sunsite.unc.edu/LDP/HOWTO/
 271
 272 If you are on a major Linux distribution the HOWTOs should be
 273 installed. Try looking beneath /usr/doc.
 274
 275 You may also get the ppp source and read the FAQ included, it is
 276 at
 277
 278   ftp://cs.anu.edu.au/pub/software/ppp