manual/rp-pppoe/original/man8/adsl-connect.8

   1 .\" $Id: adsl-connect.8,v 1.4 2002/04/09 17:28:38 dfs Exp $
   2 .\" LIC: GPL
   3 .TH ADSL-CONNECT 8 "21 February 2000"
   4 .UC 4
   5 .SH NAME
   6 adsl-connect \- Shell script to manage a PPPoE link
   7
   8 .SH SYNOPSIS
   9 .B adsl-connect \fR[\fIconfig_file\fR]
  10 .P
  11 .B adsl-connect \fR\fIinterface user\fR [\fIconfig_file\fR]
  12
  13
  14 .SH DESCRIPTION
  15 \fBadsl-connect\fR is a shell script which manages an ADSL connection
  16 using the Roaring Penguin user-space PPPoE client.  If you omit
  17 \fIconfig_file\fR, the default file \fB/etc/ppp/pppoe.conf\fR is used.
  18 If you supply \fIinterface\fR and \fIuser\fR, then they override the
  19 Ethernet interface and user-name settings in the configuration file.
  20 .P
  21 Note that normally, you should \fInot\fR invoke \fBadsl-connect\fR
  22 directly.  Instead, use \fBadsl-start\fR to bring up the ADSL connection.
  23 .P
  24 \fBadsl-connect\fR first reads a configuration file.  It then brings
  25 up a PPPoE connection.  If the connection ever drops, a message is logged
  26 to syslog, and \fBadsl-connect\fR re-establishes the connection.  In addition,
  27 each time the connection is dropped or cannot be established,
  28 \fBadsl-connect\fR executes the script \fB/etc/ppp/adsl-lost\fR if it
  29 exists and is executable.
  30
  31 .P
  32 The shell script \fBadsl-stop\fR causes \fBadsl-connect\fR to break out
  33 of its loop, bring the connection down, and exit.
  34
  35 .SH TECHNICAL DETAILS
  36 \fBadsl-connect\fR uses the following shell variables from the
  37 configuration file:
  38
  39 .TP
  40 .B ETH
  41 The Ethernet interface connected to the ADSL modem (for example, eth0).
  42
  43 .TP
  44 .B USER
  45 The ADSL user-id (for example, b1xxnxnx@sympatico.ca).
  46
  47 .TP
  48 .B PIDFILE
  49 A file in which to write the process-ID of the adsl-connect process
  50 (for example, \fB/var/run/pppoe.pid\fR).  Two additional files
  51 ($PIDFILE.pppd and $PIDFILE.pppoe) hold the process-ID's of the
  52 \fBpppd\fR and \fBpppoe\fR processes, respectively.
  53
  54 .P
  55 By using different configuration files with different PIDFILE
  56 settings, you can manage multiple PPPoE connections.  Just specify the
  57 configuration file as an argument to \fBadsl-start\fR and
  58 \fBadsl-stop\fR.
  59
  60 .SH AUTHOR
  61 \fBadsl-connect\fR was written by David F. Skoll <dfs@roaringpenguin.com>.
  62
  63 The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR.
  64
  65 .SH SEE ALSO
  66 pppoe(8), adsl-start(8), adsl-stop(8), pppd(8), pppoe.conf(5), adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-server(8), pppoe-relay(8)
  67