yawmppp/src/yawmppp.1x

   1 .TH YAWMPPP 1x "22 Feb 2001" "Free Software"  "User Manuals"
   2 .SH NAME
   3 yawmppp \- Window Maker dock front end for pppd and chat
   4 .SH SYNOPSIS
   5 yawmppp [\fB\-h\fR] [\fB\-i\fR \fIdevice\fR] [\fB-t\fR]
   6         [\fB\-u\fR \fIupdate rate\fR] [\fB\-v\fR]
   7         [\fB\-caution\fR | \fB-paranoid\fR]
   8
   9 yawmppp.thin [\fB\-h\fR] [\fB\-i\fR \fIdevice\fR] [\fB-t\fR]
  10              [\fB\-u\fR \fIupdate rate\fR] [\fB\-v\fR]
  11              [\fB\-caution\fR | \fB-paranoid\fR]
  12
  13 .SH DESCRIPTION
  14 This man page documents version 2.0.2 of \fByawmppp\fR.
  15
  16 .B "yawmppp"
  17 is \fBY\fRet \fBA\fRnother \fBW\fRindow \fBM\fRaker
  18 \fBPPP\fR dock applet.
  19
  20 .B "yawmppp"
  21 runs docked in Window Maker's dock (or clip), swallowed in
  22 AfterStep's wharf or as a iconic shaped window on other
  23 window managers. If you are not using a dock-capable
  24 window manager (Window Maker and AfterStep) then you may
  25 prefer to run \fByawmppp.thin\fR instead, which is
  26 the same applet shaped as an horizontal bar, designed
  27 for use without a dock.
  28
  29 It provides a front end for the programs chat and pppd, in
  30 a way that you probably shouldn't ever need to edit
  31 directly these programs' scripts.
  32
  33 The \fBv\fR button starts a connection to the currently
  34 selected ISP entry (whose handle is shown in the bottom
  35 left corner of the display). The \fBx\fR button closes
  36 the current connection. The arrow buttons let you
  37 select a dialing entry.
  38
  39 To create and edit dialing entries you should use the
  40 \fByawmppp.pref\fR program, which can be run by clicking the
  41 left mouse button in yawmppp's display area.
  42
  43 You can see a log of your connections with the \fByawmppp.log\fR
  44 program, which can be run by clicking yawmppp's display area
  45 with any mouse button but the left.
  46
  47 .SH DISPLAY
  48 Yawmppp's display has a connection timer at the top left corner,
  49 three LEDs at the top right meaning RX,TX and POWER. The RX/TX
  50 leds blinking upon the receive/send of PPP packets. The
  51 POWER led is dark when you're offline, yellow when dialing,
  52 green when connected, red when an error has ocurred with the
  53 connection.
  54
  55 In the middle of the display is an auto-scaling load graph. The
  56 bottom left corner shows the current ISP's handle and the
  57 bottom right corner displays the CONNECT speed in the first
  58 10 seconds of connection, then starts showing the
  59 characters-per-second rate.
  60
  61 .SH "COMMAND-LINE OPTIONS"
  62 .IP "\-caution"
  63 .IP "\-paranoid"
  64 these options will change the way yawmppp touches the PPP interface.
  65 Caution will keep associated structures open while
  66 the connection is up only. Paranoid will open and close the
  67 structures LOTS of times to keep them closed as much as possible.
  68 These options are meant for PCMCIA & APM (notebooks, maybe PDAs) users
  69 who run into trouble with cardctl commands. Don't use these options unless
  70 you really need them. And if you need, check if caution is enough,
  71 be paranoid only when absolutely necessary. When none is
  72 specified, \fB-caution\fR is default.
  73 .IP "\-i device"
  74 use a ppp device other then ppp0.
  75 .IP "\-h"
  76 shows a brief help message
  77 .IP "\-t"
  78 set timer to MM:SS instead of HH:MM
  79 .IP "\-u update\-rate"
  80 sets the interval for statistics update (load graph and cps rate).
  81 If not set, defaults to 5 seconds.
  82 .IP "\-v"
  83 shows version and exits.
  84
  85 .SH "PPPD OPTIONS"
  86 yawmppp.pref provides a good set of options from pppd, but if need
  87 any other that isn't (yet) directly supported, put it in
  88 /etc/ppp/options. Per-ISP options are placed in /etc/ppp/peers,
  89 as newer pppd versions require (since 2.3.7 at least). Whenever
  90 YAWMPPP needs to write some file there, it will ask for the
  91 superuser password on an xterm. Configuration files must go
  92 under /etc/ppp/peers or the noauth option, usually required to
  93 connect to ISPs, won't be allowed.
  94
  95 .SH "DNS Handling"
  96 In the past, YAWMPPP changed the named(8) configuration files to
  97 set DNS up, but nowadays pppd has taken over this task with the
  98 usepeerdns option. From pppd 2.3.11 up, DNS should work out of the
  99 box. pppd 2.3.10 and some earlier versions may require working
 100 /etc/ppp/ip-up and /etc/ppp/ip-down files. Some distributions
 101 provide these files worked out (Red Hat), others
 102 don't (Slackware). Here is a sample minimalist set of these files:
 103
 104 \fB/etc/ppp/ip-up\fR
 105 .br
 106 #!/bin/sh
 107 .br
 108 echo "search mydomain.org" > /etc/resolv.conf
 109 .br
 110 echo "nameserver $DNS1" >> /etc/resolv.conf
 111 .br
 112
 113 \fB/etc/ppp/ip-down\fR
 114 .br
 115 #!/bin/sh
 116 .br
 117 echo "search mydomain.org" > /etc/resolv.conf
 118 .br
 119 echo "nameserver" >> /etc/resolv.conf
 120 .br
 121
 122 .SH "FILES"
 123
 124 .IR ~/.yawmppp2
 125 .br
 126 .IR ~/.yawmppp2/yawmppprc
 127 .br
 128 .IR ~/.yawmppp2/logfile
 129 .br
 130
 131 .SH "BUGS"
 132 .BR "yawmppp "
 133 You must set your PAP/CHAP secrets directly in the /etc/ppp/chap-secrets
 134 and /etc/ppp/pap-secrets files. For security reasons, yawmppp cannot do
 135 it for you.
 136
 137 If you run more than one copy of yawmppp or yawmppp.thin you'll get
 138 repeated log entries.
 139
 140 .SH "PORTABILITY"
 141 .BR "yawmppp "
 142 has been reported to run on Linux, NetBSD and FreeBSD. Your
 143 mileage may vary on Linux, as pppd configuration can vary wildly from
 144 distribution to distribution.
 145
 146 On Slackware Linux 7.0 you must set up /etc/ppp/ip-up and /etc/ppp/ip-down
 147 on your own to get DNS resolution working.
 148 The minimalist sample given in this man page works.
 149
 150 .SH "CREDITS"
 151 .BR "yawmppp "
 152 was written by Felipe Bergo <bergo@seul.org>. The dock applet
 153 is based on wmppp 1.3.0, which was written by Martijn Pieterse and
 154 Antoine Nulle.
 155
 156 .SH "UNRESTRICTIONS"
 157 .BR "yawmppp "
 158 is free; anyone may redistribute copies of \fByawmppp\fR to anyone under the
 159 terms stated in the GNU General Public License. A copy of the license accompanies
 160 each copy of \fByawmppp\fR.
 161
 162 .SH "WEB SITE"
 163 http://yawmppp.seul.org
 164
 165 .SH "SEE ALSO"
 166 \fBpppd\fR(8), \fBchat\fR(8), \fBresolver\fR(5), \fBsetserial\fR(8),
 167 \fBttys\fR(4)