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