From 0a121a8ecd6de894c14d60daf9da2022ec47405c Mon Sep 17 00:00:00 2001 From: Guillaume Cottenceau Date: Mon, 11 Jun 2001 13:49:39 +0000 Subject: Initial revision --- mdk-stage1/rp-pppoe/man/adsl-connect.8 | 66 +++++++++ mdk-stage1/rp-pppoe/man/adsl-setup.8 | 23 ++++ mdk-stage1/rp-pppoe/man/adsl-start.8 | 27 ++++ mdk-stage1/rp-pppoe/man/adsl-status.8 | 25 ++++ mdk-stage1/rp-pppoe/man/adsl-stop.8 | 21 +++ mdk-stage1/rp-pppoe/man/pppoe-relay.8 | 124 +++++++++++++++++ mdk-stage1/rp-pppoe/man/pppoe-server.8 | 123 +++++++++++++++++ mdk-stage1/rp-pppoe/man/pppoe-sniff.8 | 77 +++++++++++ mdk-stage1/rp-pppoe/man/pppoe.8 | 236 +++++++++++++++++++++++++++++++++ mdk-stage1/rp-pppoe/man/pppoe.conf.5 | 168 +++++++++++++++++++++++ 10 files changed, 890 insertions(+) create mode 100644 mdk-stage1/rp-pppoe/man/adsl-connect.8 create mode 100644 mdk-stage1/rp-pppoe/man/adsl-setup.8 create mode 100644 mdk-stage1/rp-pppoe/man/adsl-start.8 create mode 100644 mdk-stage1/rp-pppoe/man/adsl-status.8 create mode 100644 mdk-stage1/rp-pppoe/man/adsl-stop.8 create mode 100644 mdk-stage1/rp-pppoe/man/pppoe-relay.8 create mode 100644 mdk-stage1/rp-pppoe/man/pppoe-server.8 create mode 100644 mdk-stage1/rp-pppoe/man/pppoe-sniff.8 create mode 100644 mdk-stage1/rp-pppoe/man/pppoe.8 create mode 100644 mdk-stage1/rp-pppoe/man/pppoe.conf.5 (limited to 'mdk-stage1/rp-pppoe/man') diff --git a/mdk-stage1/rp-pppoe/man/adsl-connect.8 b/mdk-stage1/rp-pppoe/man/adsl-connect.8 new file mode 100644 index 000000000..1b34a74e5 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/adsl-connect.8 @@ -0,0 +1,66 @@ +.\" $Id$ +.TH ADSL-CONNECT 8 "21 February 2000" +.UC 4 +.SH NAME +adsl-connect \- Shell script to manage a PPPoE link + +.SH SYNOPSIS +.B adsl-connect \fR[\fIconfig_file\fR] +.P +.B adsl-connect \fR\fIinterface user\fR [\fIconfig_file\fR] + + +.SH DESCRIPTION +\fBadsl-connect\fR is a shell script which manages an ADSL connection +using the Roaring Penguin user-space PPPoE client. If you omit +\fIconfig_file\fR, the default file \fB/etc/ppp/pppoe.conf\fR is used. +If you supply \fIinterface\fR and \fIuser\fR, then they override the +Ethernet interface and user-name settings in the configuration file. +.P +Note that normally, you should \fInot\fR invoke \fBadsl-connect\fR +directly. Instead, use \fBadsl-start\fR to bring up the ADSL connection. +.P +\fBadsl-connect\fR first reads a configuration file. It then brings +up a PPPoE connection. If the connection ever drops, a message is logged +to syslog, and \fBadsl-connect\fR re-establishes the connection. In addition, +each time the connection is dropped or cannot be established, +\fBadsl-connect\fR executes the script \fB/etc/ppp/adsl-lost\fR if it +exists and is executable. + +.P +The shell script \fBadsl-stop\fR causes \fBadsl-connect\fR to break out +of its loop, bring the connection down, and exit. + +.SH TECHNICAL DETAILS +\fBadsl-connect\fR uses the following shell variables from the +configuration file: + +.TP +.B ETH +The Ethernet interface connected to the ADSL modem (for example, eth0). + +.TP +.B USER +The ADSL user-id (for example, b1xxnxnx@sympatico.ca). + +.TP +.B PIDFILE +A file in which to write the process-ID of the adsl-connect process +(for example, \fB/var/run/pppoe.pid\fR). Two additional files +($PIDFILE.pppd and $PIDFILE.pppoe) hold the process-ID's of the +\fBpppd\fR and \fBpppoe\fR processes, respectively. + +.P +By using different configuration files with different PIDFILE +settings, you can manage multiple PPPoE connections. Just specify the +configuration file as an argument to \fBadsl-start\fR and +\fBadsl-stop\fR. + +.SH AUTHOR +\fBadsl-connect\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +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) + diff --git a/mdk-stage1/rp-pppoe/man/adsl-setup.8 b/mdk-stage1/rp-pppoe/man/adsl-setup.8 new file mode 100644 index 000000000..9e78fa547 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/adsl-setup.8 @@ -0,0 +1,23 @@ +.\" $Id$ +.TH ADSL-SETUP 8 "21 February 2000" +.UC 4 +.SH NAME +adsl-setup \- Shell script to configure Roaring Penguin PPPoE client +.SH SYNOPSIS +.B adsl-setup + +.SH DESCRIPTION +\fBadsl-setup\fR is a shell script which prompts you for various pieces +of information and sets up an /etc/ppp/pppoe.conf configuration script +for the \fBadsl-start\fR, \fBadsl-stop\fR and \fBadsl-connect\fR scripts. + +.SH AUTHOR +\fBadsl-setup\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +pppoe(8), adsl-start(8), adsl-stop(8), adsl-connect(8), pppd(8), +pppoe.conf(5), adsl-status(8), pppoe-sniff(8), pppoe-relay(8), +pppoe-server(8) + diff --git a/mdk-stage1/rp-pppoe/man/adsl-start.8 b/mdk-stage1/rp-pppoe/man/adsl-start.8 new file mode 100644 index 000000000..87250b381 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/adsl-start.8 @@ -0,0 +1,27 @@ +.\" $Id$ +.TH ADSL-START 8 "21 February 2000" +.UC 4 +.SH NAME +adsl-start \- Shell script to bring up a PPPoE link +.SH SYNOPSIS +.B adsl-start \fR[\fIconfig_file\fR] +.P +.B adsl-start \fR\fIinterface user\fR [\fIconfig_file\fR] + +.SH DESCRIPTION +\fBadsl-start\fR is a shell script which starts the Roaring Penguin +user-space PPPoE client. If you omit \fIconfig_file\fR, the default +file \fB/etc/ppp/pppoe.conf\fR is used. If you supply +\fIinterface\fR and \fIuser\fR, then they override the Ethernet interface +and user-name settings in the configuration file. + +.SH AUTHOR +\fBadsl-start\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +pppoe(8), adsl-stop(8), adsl-connect(8), pppd(8), pppoe.conf(5), +adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-relay(8), +pppoe-server(8) + diff --git a/mdk-stage1/rp-pppoe/man/adsl-status.8 b/mdk-stage1/rp-pppoe/man/adsl-status.8 new file mode 100644 index 000000000..2114d461e --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/adsl-status.8 @@ -0,0 +1,25 @@ +.\" $Id$ +.TH ADSL-STATUS 8 "16 March 2000" +.UC 4 +.SH NAME +adsl-status \- Shell script to report on status of PPPoE link +.SH SYNOPSIS +.B adsl-status \fR[\fIconfig_file\fR] + +.SH DESCRIPTION +\fBadsl-status\fR is a shell script which checks the status of the +PPPoE link established by the Roaring Penguin user-space PPPoE client. +If you omit \fIconfig_file\fR, the default file +\fB/etc/ppp/pppoe.conf\fR is used. + +.SH AUTHOR +\fBadsl-status\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +pppoe(8), adsl-start(8), adsl-connect(8), pppd(8), pppoe.conf(5), +adsl-setup(8), adsl-stop(8), pppoe-sniff(8), pppoe-relay(8), +pppoe-server(8) + + diff --git a/mdk-stage1/rp-pppoe/man/adsl-stop.8 b/mdk-stage1/rp-pppoe/man/adsl-stop.8 new file mode 100644 index 000000000..2ac7fef8e --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/adsl-stop.8 @@ -0,0 +1,21 @@ +.\" $Id$ +.TH ADSL-STOP 8 "21 February 2000" +.UC 4 +.SH NAME +adsl-stop \- Shell script to shut down a PPPoE link +.SH SYNOPSIS +.B adsl-stop \fR[\fIconfig_file\fR] + +.SH DESCRIPTION +\fBadsl-stop\fR is a shell script which stops the Roaring Penguin +user-space PPPoE client. If you omit \fIconfig_file\fR, the default +file \fB/etc/ppp/pppoe.conf\fR is used. + +.SH AUTHOR +\fBadsl-stop\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +pppoe(8), adsl-start(8), adsl-connect(8), pppd(8), pppoe.conf(5), adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-relay(8), pppoe-server(8) + diff --git a/mdk-stage1/rp-pppoe/man/pppoe-relay.8 b/mdk-stage1/rp-pppoe/man/pppoe-relay.8 new file mode 100644 index 000000000..5f79b09a1 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/pppoe-relay.8 @@ -0,0 +1,124 @@ +.\" $Id$ +.TH PPPOE-RELAY 8 "26 January 2001" +.\"" +.UC 4 +.SH NAME +pppoe-relay \- user-space PPPoE relay agent. +.SH SYNOPSIS +.B pppoe-relay \fR[\fIoptions\fR] + +.SH DESCRIPTION +\fBpppoe-relay\fR is a user-space relay agent for PPPoE +(Point-to-Point Protocol over Ethernet) for Linux. \fBpppoe-relay\fR +works in concert with the \fBpppoe\fR client and \fBpppoe-server\fR +server. See the OPERATION section later in this manual for +details on how \fBpppoe-relay\fR works. + +.SH OPTIONS +.TP +.B \-S \fIinterface\fR +Adds the Ethernet interface \fIinterface\fR to the list of interfaces +managed by \fBpppoe-relay\fR. Only PPPoE servers may be connected to +this interface. + +.TP +.B \-C \fIinterface\fR +Adds the Ethernet interface \fIinterface\fR to the list of interfaces +managed by \fBpppoe-relay\fR. Only PPPoE clients may be connected to +this interface. + +.TP +.B \-B \fIinterface\fR +Adds the Ethernet interface \fIinterface\fR to the list of interfaces +managed by \fBpppoe-relay\fR. Both PPPoE clients and servers may be +connected to this interface. + +.TP +.B \-n \fInum\fR +Allows at most \fInum\fR concurrent PPPoE sessions. If not specified, +the default is 5000. \fInum\fR can range from 1 to 65534. + +.TP +.B \-i \fItimeout\fR +Specifies the session idle timeout. If both peers in a session are idle +for more than \fItimeout\fR seconds, the session is terminated. +If \fItimeout\fR is specified as zero, sessions will never be terminated +because of idleness. + +Note that the idle-session expiry routine is never run more frequently than +every 30 seconds, so the timeout is approximate. The default value for +\fItimeout\fR is 600 seconds (10 minutes.) + +.TP +.B \-F +The \fB\-F\fR option causes \fBpppoe-relay\fR \fInot\fR to fork into the +background; instead, it remains in the foreground. + +.TP +.B \-h +The \fB\-h\fR option prints a brief usage message and exits. + +.SH OPERATION + +\fBpppoe-relay\fR listens for incoming PPPoE PADI frames on all interfaces +specified with \fB-B\fR or \fB-C\fR options. When a PADI frame appears, +\fBpppoe-relay\fR adds a Relay-Session-ID tag and broadcasts the PADI +on all interfaces specified with \fB-B\fR or \fB-S\fR options (except the +interface on which the frame arrived.) + +Any PADO frames received are relayed back to the client which sent the +PADI (assuming they contain valid Relay-Session-ID tags.) Likewise, +PADR frames from clients are relayed back to the matching access +concentrator. + +When a PADS frame is received, \fBpppoe-relay\fR enters the two peers' +MAC addresses and session-ID's into a hash table. (The session-ID seen +by the access concentrator may be different from that seen by the client; +\fBpppoe-relay\fR must renumber sessions to avoid the possibility of duplicate +session-ID's.) Whenever either peer sends a session frame, \fBpppoe-relay\fR +looks up the session entry in the hash table and relays the frame to +the correct peer. + +When a PADT frame is received, \fBpppoe-relay\fR relays it to the peer +and deletes the session entry from its hash table. + +If a client and server crash (or frames are lost), PADT frames may never +be sent, and \fBpppoe-relay\fR's hash table can fill up with stale sessions. +Therefore, a session-cleaning routine runs periodically, and removes old +sessions from the hash table. A session is considered "old" if no traffic +has been seen within \fItimeout\fR seconds. When a session is deleted because +of a timeout, a PADT frame is sent to each peer to make certain that they +are aware the session has been killed. + +.SH EXAMPLE INVOCATIONS + +.nf +pppoe-relay -C eth0 -S eth1 +.fi + +The example above relays frames between PPPoE clients on the eth0 network +and PPPoE servers on the eth1 network. + +.nf +pppoe-relay -B eth0 -B eth1 +.fi + +This example is a transparent relay -- frames are relayed between any mix +of clients and servers on the eth0 and eth1 networks. + +.nf +pppoe-relay -S eth0 -C eth1 -C eth2 -C eth3 +.fi + +This example relays frames between servers on the eth0 network and +clients on the eth1, eth2 and eth3 networks. + +.SH AUTHORS +\fBpppoe-relay\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +adsl-start(8), adsl-stop(8), adsl-connect(8), pppd(8), pppoe.conf(5), +pppoe(8), adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-server(8) + diff --git a/mdk-stage1/rp-pppoe/man/pppoe-server.8 b/mdk-stage1/rp-pppoe/man/pppoe-server.8 new file mode 100644 index 000000000..aacf11f1f --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/pppoe-server.8 @@ -0,0 +1,123 @@ +.\" $Id$ +.TH PPPOE-SERVER 8 "3 July 2000" +.\"" +.UC 4 +.SH NAME +pppoe-server \- user-space PPPoE server +.SH SYNOPSIS +.B pppoe-server \fR[\fIoptions\fR] + +.SH DESCRIPTION +\fBpppoe-server\fR is a user-space server for PPPoE (Point-to-Point Protocol +over Ethernet) for Linux and other UNIX systems. \fBpppoe-server\fR works in +concert with the \fBpppoe\fR client to respond to PPPoE discovery packets +and set up PPPoE sessions. + +.SH OPTIONS +.TP +.B \-F +The \fB\-F\fR option causes \fBpppoe-server\fR not to fork and become a +daemon. The default is to fork and become a daemon. + +.TP +.B \-I \fIinterface\fR +The \fB\-I\fR option specifies the Ethernet interface to use. Under Linux, +it is typically \fIeth0\fR or \fIeth1\fR. The interface should be "up" +before you start \fBpppoe-server\fR, but should \fInot\fR be configured to have +an IP address. + +.TP +.B \-T \fItimeout\fR +This option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) for +details. + +.TP +.B \-C \fIac_name\fR +Specifies which name to report as the access concentrator name. If not +supplied, the host name is used. + +.TP +.B \-m \fIMSS\fR +This option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) for +details. + +.TP +.B \-s +This option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) for +details. In addition, it causes \fBpppd\fR to be invoked with the +\fIsync\fR option. + +.TP +.B \-L \fIip\fR +Sets the local IP address. This is passed to spawned \fBpppd\fR processes. +If not specified, the default is 10.0.0.1. + +.TP +.B \-R \fIip\fR +Sets the starting remote IP address. As sessions are established, +IP addresses are assigned starting from \fIip\fR. \fBpppoe-server\fR +automatically keeps track of the pool of addresses and passes a +valid remote IP address to \fBpppd\fR. If not specified, a starting address +of 10.67.15.1 is used. + +.TP +.B \-N \fInum\fR +Allows at most \fInum\fR concurrent PPPoE sessions. If not specified, +the default is 64. + +.TP +.B \-p \fIfname\fR +Reads the specified file \fIfname\fR which is a text file consisting of +one IP address per line. These IP addresses will be assigned to clients. +The number of sessions allowed will equal the number of addresses found +in the file. The \fB\-p\fR option overrides both \fB\-R\fR and \fB\-N\fR. + +.TP +.B \-o \fIoffset\fR +Instead of numbering PPPoE sessions starting at 1, they will be numbered +starting at \fIoffset\fR+1. This allows you to run multiple servers on +a given machine; just make sure that their session numbers do not +overlap. + +.TP +.B \-f disc:sess +The \fB\-f\fR option sets the Ethernet frame types for PPPoE discovery +and session frames. The types are specified as hexadecimal numbers +separated by a colon. Standard PPPoE uses frame types 8863:8864. +\fIYou should not use this option\fR unless you are absolutely sure +the peer you are dealing with uses non-standard frame types. + +.TP +.B \-h +The \fB\-h\fR option prints a brief usage message and exits. + +.SH OPERATION + +\fBpppoe-server\fR listens for incoming PPPoE discovery packets. When +a session is established, it spawns a \fBpppd\fR process. The following +options are passed to \fBpppd\fR: + +.nf +nodetach noaccomp nobsdcom nodeflate nopcomp novj novjccomp +default-asyncmap +.fi + +In addition, the local and remote IP address are set based on the +\fB\-L\fR and \fB\-R\fR options. The \fBpty\fR option is supplied along +with a \fBpppoe\fR command to initiate the PPPoE session. Finally, +additional \fBpppd\fR options can be placed in the file +\fB/etc/ppp/pppoe-server-options\fR (which must exist, even if it is just +empty!) + +Note that \fBpppoe-server\fR is meant mainly for testing PPPoE clients. +It is \fInot\fR a high-performance server meant for production use. + +.SH AUTHORS +\fBpppoe-server\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +adsl-start(8), adsl-stop(8), adsl-connect(8), pppd(8), pppoe.conf(5), +pppoe(8), adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-relay(8) + diff --git a/mdk-stage1/rp-pppoe/man/pppoe-sniff.8 b/mdk-stage1/rp-pppoe/man/pppoe-sniff.8 new file mode 100644 index 000000000..431830a22 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/pppoe-sniff.8 @@ -0,0 +1,77 @@ +.\" $Id$ +.TH PPPOE-SNIFF 8 "3 July 2000" +.\"" +.UC 4 +.SH NAME +pppoe-sniff \- examine network for non-standard PPPoE frames +.SH SYNOPSIS +.B pppoe-sniff \fR[\fIoptions\fR] + +.SH DESCRIPTION +\fBpppoe-sniff\fR listens for likely-looking PPPoE PADR and session frames +and deduces extra options required for \fBpppoe(8)\fR to work. + +Some DSL providers seem to use non-standard frame types for PPPoE frames, +and/or require a certain value in the Service-Name field. It is often +easier to sniff those values from a machine which can successfully connect +rather than try to pry them out of the DSL provider. + +To use \fBpppoe-sniff\fR, you need two computers, a DSL modem and +an Ethernet hub (\fInot\fR an Ethernet switch.) + +If the DSL modem normally connects directly to your computer's +Ethernet card, connect it to the "uplink" port on the Ethernet hub. +Plug two computers into normal ports on the hub. On one computer, run +whatever software the DSL provider gave you on whatever operating +system the DSL provider supports. On the other computer, run Linux and +log in as root. + +On the Linux machine, put the Ethernet interface into promiscuous mode +and start \fBpppoe-sniff\fR. If the ethernet interface is \fIeth0\fR, +for example, type these commands: + +.nf + ifconfig eth0 promisc + pppoe-sniff -I eth0 +.fi + +On the other machine, start your DSL connection as usual. After a short +time, \fBpppoe-sniff\fR should print recommendations for the value +of \fBPPPOE_EXTRA\fR. Set this value in \fB/etc/ppp/pppoe.conf\fR. +If \fBpppoe-sniff\fR indicates that something special is required in +\fBPPPOE_EXTRA\fR, please e-mail this to \fBpppoe@roaringpenguin.com\fR +along with the name of your ISP and the manufacturer and model number of +your DSL modem. This information will be collated and provided on the +PPPoE web page for users who do not have two computers. + +After \fBpppoe-sniff\fR finishes (or you stop it if it seems hung), +remember to turn off promiscuous mode: + +.nf + ifconfig eth0 -promisc +.fi + +.SH OPTIONS +.TP +.B \-I \fIinterface\fR +The \fB\-I\fR option specifies the Ethernet interface to use. Under Linux, +it is typically \fIeth0\fR or \fIeth1\fR. The interface should be "up" +and in promiscuous mode before you start \fBpppoe-sniff\fR. + +.TP +.B \-V +The \fB\-V\fR option causes \fBpppoe-sniff\fR to print its version number and +exit. + +.SH BUGS +\fBpppoe-sniff\fR only works on Linux. + +.SH AUTHORS +\fBpppoe-sniff\fR was written by David F. Skoll . + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +adsl-start(8), adsl-stop(8), adsl-connect(8), pppd(8), pppoe.conf(5), +pppoe(8), adsl-setup(8), adsl-status(8), pppoe-server(8), pppoe-relay(8) + diff --git a/mdk-stage1/rp-pppoe/man/pppoe.8 b/mdk-stage1/rp-pppoe/man/pppoe.8 new file mode 100644 index 000000000..999c3d2ed --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/pppoe.8 @@ -0,0 +1,236 @@ +.\" $Id$ +.TH PPPOE 8 "3 July 2000" +.UC 4 +.SH NAME +pppoe \- user-space PPPoE client. +.SH SYNOPSIS +.B pppd pty 'pppoe \fR[\fIpppoe_options\fR]\fB' \fR[\fIpppd_options\fR] +.P +.B pppoe -A \fR[\fIpppoe_options\fR] +.SH DESCRIPTION +\fBpppoe\fR is a user-space client for PPPoE (Point-to-Point Protocol +over Ethernet) for Linux and other UNIX systems. \fBpppoe\fR works in +concert with the \fBpppd\fR PPP daemon to provide a PPP connection +over Ethernet, as is used by many ADSL service providers. + +.SH OPTIONS +.TP +.B \-I \fIinterface\fR +The \fB\-I\fR option specifies the Ethernet interface to use. Under Linux, +it is typically \fIeth0\fR or \fIeth1\fR. The interface should be "up" +before you start \fBpppoe\fR, but should \fInot\fR be configured to have +an IP address. + +.TP +.B \-T \fItimeout\fR +The \fB\-T\fR option causes \fBpppoe\fR to exit if no session traffic +is detected for \fItimeout\fR seconds. I recommend that you use this +option as an extra safety measure, but if you do, you should make sure +that PPP generates enough traffic so the timeout will normally not be +triggered. The best way to do this is to use the +\fIlcp-echo-interval\fR option to \fBpppd\fR. You should set the +PPPoE timeout to be about four times the LCP echo interval. + +.TP +.B \-D \fIfile_name\fR +The \fB\-D\fR option causes every packet to be dumped to the specified +\fIfile_name\fR. This is intended for debugging only; it produces huge +amounts of output and greatly reduces performance. + +.TP +.B \-V +The \fB\-V\fR option causes \fBpppoe\fR to print its version number and +exit. + +.TP +.B \-A +The \fB\-A\fR option causes \fBpppoe\fR to send a PADI packet and then print +the names of access concentrators in each PADO packet it receives. Do not +use this option in conjunction with \fBpppd\fR; the \fB\-A\fR option is +meant to be used interactively to give interesting information about the +access concentrator. + +.TP +.B \-S \fIservice_name\fR +Specifies the desired service name. \fBpppoe\fR will only initiate sessions +with access concentrators which can provide the specified service. In +most cases, you should \fInot\fR specify this option. Use it only if you +know that there are multiple access concentrators or know that you need a +specific service name. + +.TP +.B \-C \fIac_name\fR +Specifies the desired access concentrator name. \fBpppoe\fR will only +initiate sessions with the specified access concentrator. In +most cases, you should \fInot\fR specify this option. Use it only if you +know that there are multiple access concentrators. If both the +\fB\-S\fR and \fB\-C\fR options are specified, they must \fIboth\fR match +for \fBpppoe\fR to initiate a session. + +.TP +.B \-U +Causes \fBpppoe\fR to use the Host-Uniq tag in its discovery packets. This +lets you run multiple \fBpppoe\fR daemons without having their discovery +packets interfere with one another. You must supply this option to +\fIall\fR \fBpppoe\fR daemons if you intend to run multiple daemons +simultaneously. + +.TP +.B \-s +Causes \fBpppoe\fR to use \fIsynchronous\fR PPP encapsulation. If you +use this option, then you \fImust\fR use the \fBsync\fR option with +\fBpppd\fR. You are encouraged to use this option if it works, because +it greatly reduces the CPU overhead of \fBpppoe\fR. However, it +MAY be unreliable on slow machines -- there is a race condition between +pppd writing data and pppoe reading it. For this reason, the default +setting is asynchronous. If you encounter bugs or crashes with Synchronous +PPP, turn it off -- don't e-mail me for support! + +.TP +.B \-m \fIMSS\fR +Causes \fBpppoe\fR to \fIclamp\fR the TCP maximum segment size at the specified +value. Because of PPPoE overhead, the maximum segment size for PPPoE is +smaller than for normal Ethernet encapsulation. This could cause problems +for machines on a LAN behind a gateway using PPPoE. If you have a LAN +behind a gateway, and the gateway connects to the Internet using PPPoE, +you are strongly recommended to use a \fB\-m 1412\fR option. This avoids +having to set the MTU on all the hosts on the LAN. + +.TP +.B \-p \fIfile\fR +Causes \fBpppoe\fR to write its process-ID to the specified file. This +can be used to locate and kill \fBpppoe\fR processes. + +.TP +.B \-e \fIsess:mac\fR +Causes \fBpppoe\fR to skip the discovery phase and move directly to the +session phase. The session is given by \fIsess\fR and the MAC address of +the peer by \fImac\fR. This mode is \fInot\fR meant for normal use; it +is designed only for \fBpppoe-server\fR(8). + +.TP +.B \-n +Causes \fBpppoe\fR not to open a discovery socket. This mode is +\fInot\fR meant for normal use; it is designed only for +\fBpppoe-server\fR(8). + +.TP +.B \-k +Causes \fBpppoe\fR to terminate an existing session by sending a PADT frame, +and then exit. You must use the \fB\-e\fR option in conjunction with this +option to specify the session to kill. This may be useful for killing +sessions when a buggy peer does not realize the session has ended. + +.TP +.B \-d +Causes \fBpppoe\fR to perform discovery and then exit, after printing +session information to standard output. The session information is printed +in exactly the format expected by the \fB\-e\fR option. This option lets +you initiate a PPPoE discovery, perform some other work, and then start +the actual PPP session. \fIBe careful\fR; if you use this option in a loop, +you can create many sessions, which may annoy your peer. + +.TP +.B \-f disc:sess +The \fB\-f\fR option sets the Ethernet frame types for PPPoE discovery +and session frames. The types are specified as hexadecimal numbers +separated by a colon. Standard PPPoE uses frame types 8863:8864. +\fIYou should not use this option\fR unless you are absolutely sure +the peer you are dealing with uses non-standard frame types. If your +ISP uses non-standard frame types, complain! + +.TP +.B \-h +The \fB\-h\fR option causes \fBpppoe\fR to print usage information and +exit. + +.SH PPPOE BACKGROUND + +PPPoE (Point-to-Point Protocol over Ethernet) is described in RFC 2516 +and is a protocol which allows the session abstraction to be maintained +over bridged Ethernet networks. + +PPPoE works by encapsulating PPP frames in Ethernet frames. The protocol +has two distinct stages: The \fIdiscovery\fR and the \fIsession\fR stage. + +In the discovery stage, the host broadcasts a special PADI (PPPoE +Active Discovery Initiation) frame to discover any \fIaccess +concentrators\fR. The access concentrators (typically, only one +access concentrator) reply with PADO (PPPoE Active Discovery Offer) +packets, announcing their presence and the services they offer. The +host picks one of the access concentrators and transmits a PADR (PPPoE +Active Discovery Request) packet, asking for a session. The access +concentrator replies with a PADS (PPPoE Active Discovery +Session-Confirmation) packet. The protocol then moves to the session stage. + +In the session stage, the host and access concentrator exchange PPP frames +embedded in Ethernet frames. The normal Ethernet MTU is 1500 bytes, but +the PPPoE overhead plus two bytes of overhead for the encapsulated PPP +frame mean that the MTU of the PPP interface is at most 1492 bytes. +This causes \fIall kinds of problems\fR if you are using a Linux machine +as a firewall and interfaces behind the firewall have an MTU greater than +1492. In fact, to be safe, I recommend setting the MTU of machines +behind the firewall to 1412, to allow for worst-case TCP and IP options +in their respective headers. + +Normally, PPP uses the Link Control Protocol (LCP) to shut down a PPP +link. However, the PPPoE specification allows the link to be shut down +with a special PADT (PPPoE Active Discovery Terminate) packet. This client +recognizes this packet and will correctly terminate if a terminate request +is received for the PPP session. + +.SH DESIGN GOALS + +My design goals for this PPPoE client were as follows, in descending order +of importance: + +.TP +.B o +It must work. + +.TP +.B o +It must be a user-space program and not a kernel patch. + +.TP +.B o +The code must be easy to read and maintain. + +.TP +.B o +It must be fully compliant with RFC 2516, the proposed PPPoE standard. + +.TP +.B o +It must never hang up forever -- if the connection is broken, it must +detect this and exit, allowing a wrapper script to restart the connection. + +.TP +.B o +It must be fairly efficient. + +.P +I believe I have achieved all of these goals, but (of course) am open +to suggestions, patches and ideas. See my home page, +http://www.roaringpenguin.com, for contact information. + +.SH NOTES + +For best results, you must give \fBpppd\fR an mtu option of +1492. I have observed problems with excessively-large frames +unless I set this option. Also, if \fBpppoe\fR is running on a firewall +machine, all machines behind the firewall should have MTU's of 1412. + +If you have problems, check your system logs. \fBpppoe\fR logs interesting +things to syslog. You may have to turn on logging of \fIdebug\fR-level +messages for complete diagnosis. + +.SH AUTHORS +\fBpppoe\fR was written by David F. Skoll , +with much inspiration from an earlier version by Luke Stras. + +The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR. + +.SH SEE ALSO +adsl-start(8), adsl-stop(8), adsl-connect(8), pppd(8), pppoe.conf(5), adsl-setup(8), adsl-status(8), pppoe-sniff(8), pppoe-server(8), pppoe-relay(8) + diff --git a/mdk-stage1/rp-pppoe/man/pppoe.conf.5 b/mdk-stage1/rp-pppoe/man/pppoe.conf.5 new file mode 100644 index 000000000..731fd98d4 --- /dev/null +++ b/mdk-stage1/rp-pppoe/man/pppoe.conf.5 @@ -0,0 +1,168 @@ +.\" $Id$ +.\"" +.TH PPPOE.CONF 5 "21 February 2000" +.UC 4 +.SH NAME +pppoe.conf \- Configuration file used by \fBadsl-start\fR(8), +\fBadsl-stop\fR(8), \fBadsl-status(8)\fR and \fBadsl-connect\fR(8). + +.SH DESCRIPTION +\fB/etc/ppp/pppoe.conf\fR is a shell script which contains configuration +information for Roaring Penguin's ADSL scripts. Note that \fBpppoe.conf\fR +is used only by the various adsl-* shell scripts, not by \fBpppoe\fR +itself. + +\fBpppoe.conf\fR consists of a sequence of shell variable assignments. +The variables and their meanings are: + +.TP +.B ETH +The Ethernet interface connected to the ADSL modem (for example, eth0). + +.TP +.B USER +The ADSL user-id (for example, b1xxnxnx@sympatico.ca). + +.TP +.B SERVICENAME +If this is not blank, then it is passed with the \fB\-S\fR option to +\fBpppoe\fR. It specifies a service name to ask for. Usually, you +should leave it blank. + +.TP +.B ACNAME +If this is not blank, then it is passed with the \fB\-C\fR option to +\fBpppoe\fR. It specifies the name of the access concentrator to connect +to. Usually, you should leave it blank. + +.TP +.B DEMAND +If set to a number, the link is activated on demand and brought down +after after \fBDEMAND\fR seconds. If set to \fBno\fR, the link is kept +up all the time rather than being activated on demand. + +.TP +.B DNSTYPE +One of \fBNOCHANGE\fR, \fBSPECIFY\fR or \fBSERVER\fR. If +set to NOCHANGE, \fBadsl-connect\fR will not adjust the DNS setup in +any way. If set to SPECIFY, it will re-write /etc/resolv.conf with +the values of DNS1 and DNS2. If set to \fBSERVER\fR, it will +supply the \fIusepeerdns\fR option to \fBpppd\fR, and make a symlink +from /etc/resolv.conf to /etc/ppp/resolv.conf. + +.TP +.B DNS1, DNS2 +IP addresses of DNS servers if you use DNSTYPE=SPECIFY. + +.TP +.B NONROOT +If the line \fBNONROOT=OK\fR (exactly like that; no whitespace or comments) +appears in the configuration file, then \fBpppoe-wrapper\fR will allow +non-root users to bring the conneciton up or down. The wrapper is installed +only if you installed the rp-pppoe-gui package. + +.TP +.B USEPEERDNS +If set to "yes", then \fBadsl-connect\fR will supply the \fIusepeerdns\fR +option to \fBpppd\fR, which causes it to obtain DNS server addresses +from the peer and create a new \fB/etc/resolv.conf\fR file. Otherwise, +\fBadsl-connect\fR will not supply this option, and \fBpppd\fR will not +modify \fB/etc/resolv.conf\fR. + +.TP +.B CONNECT_POLL +How often (in seconds) \fBadsl-start\fR should check to see if a new PPP +interface has come up. If this is set to 0, the \fBadsl-start\fR simply +initiates the PPP session, but does not wait to see if it comes up +successfully. + +.TP +.B CONNECT_TIMEOUT +How long (in seconds) \fBadsl-start\fR should wait for a new PPP interface +to come up before concluding that \fBadsl-connect\fR has failed and killing +the session. + +.TP +.B PING +A character which is echoed every \fBCONNECT_POLL\fR seconds while +\fBadsl-start\fR is waiting for the PPP interface to come up. + +.TP +.B FORCEPING +A character which is echoed every \fBCONNECT_POLL\fR seconds while +\fBadsl-start\fR is waiting for the PPP interface to come up. Similar +to \fBPING\fR, but the character is echoed even if \fBadsl-start\fR's +standard output is not a tty. + +.TP +.B PIDFILE +A file in which to write the process-ID of the adsl-connect process +(for example, \fB/var/run/pppoe.pid\fR). Two additional files +($PIDFILE.pppd and $PIDFILE.pppoe) hold the process-ID's of the +\fBpppd\fR and \fBpppoe\fR processes, respectively. + +.TP +.B SYNCHRONOUS +An indication of whether or not to use synchronous PPP (\fByes\fR or +\fBno\fR). Synchronous PPP is safe on Linux machines with the n_hdlc +line discipline. (If you have a file called "n_hdlc.o" in your +modules directory, you have the line discipline.) It is \fInot +recommended\fR on other machines or on Linux machines without the +n_hdlc line discipline due to some known and unsolveable race +conditions in a user-mode client. + +.TP +.B CLAMPMSS +The value at which to "clamp" the advertised MSS for TCP sessions. The +default of 1412 should be fine. + +.TP +.B LCP_INTERVAL +How often (in seconds) \fBpppd\fR sends out LCP echo-request packets. + +.TP +.B LCP_FAILURE +How many unanswered LCP echo-requests must occur before \fBpppd\fR +concludes the link is dead. + +.TP +.B PPPOE_TIMEOUT +If this many seconds elapse without any activity seen by \fBpppoe\fR, +then \fBpppoe\fR exits. + +.TP +.B FIREWALL +One of NONE, STANDALONE or MASQUERADE. If NONE, then \fBadsl-connect\fR does +not add any firewall rules. If STANDALONE, then it clears existing firewall +rules and sets up basic rules for a standalone machine. If MASQUERADE, then +it clears existing firewall rules and sets up basic rules for an Internet +gateway. If you run services on your machine, these simple firewall scripts +are inadequate; you'll have to make your own firewall rules and set FIREWALL +to NONE. + +.TP +.B PPPOE_EXTRA +Any extra arguments to pass to \fBpppoe\fR + +.TP +.B PPPD_EXTRA +Any extra arguments to pass to \fBpppd\fR + +.TP +.B LINUX_PLUGIN +If non-blank, the full path of the Linux kernel-mode PPPoE plugin +(typically \fB/etc/ppp/plugins/rp-pppoe.so\fR.) This forces +\fBadsl-connect\fR to use kernel-mode PPPoE on Linux 2.4.x systems. +This code is experimental and unsupported. Use of the plugin causes +\fBadsl-connect\fR to ignore CLAMPMSS, PPPOE_EXTRA, SYNCHRONOUS and +PPPOE_TIMEOUT. + +.P +By using different configuration files with different PIDFILE +settings, you can manage multiple PPPoE connections. Just specify the +configuration file as an argument to \fBadsl-start\fR and \fBadsl-stop\fR. + +.SH SEE ALSO +pppoe(8), adsl-connect(8), adsl-start(8), adsl-stop(8), pppd(8), adsl-setup(8), +pppoe-wrapper(8) + -- cgit v1.2.1