.\" LIC: GPL.TH PPPOE-SERVER 8 "21 June 2008".\"".UC 4.SH NAMEpppoe-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 Protocolover Ethernet) for Linux and other UNIX systems.  \fBpppoe-server\fR works inconcert with the \fBpppoe\fR client to respond to PPPoE discovery packetsand set up PPPoE sessions..SH OPTIONS.TP.B \-FThe \fB\-F\fR option causes \fBpppoe-server\fR not to fork and become adaemon.  The default is to fork and become a daemon..TP.B \-I \fIinterface\fRThe \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 havean IP address.  You can supply multiple \fB\-I\fR options if you want theserver to respond on more than one interface..TP.B \-T \fItimeout\fRThis option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) fordetails.  If you are using kernel-mode PPPoE, this option has \fIno effect\fR..TP.B \-C \fIac_name\fRSpecifies which name to report as the access concentrator name.  If notsupplied, the host name is used..TP.B \-S \fIname\fROffer a service named \fIname\fR.  Multiple \fB\-S\fR options maybe specified; each one causes the named service to be advertisedin a Service-Name tag in the PADO frame.  The first \fB\-S\fR optionspecifies the default service, and is used if the PPPoE clientrequests a Service-Name of length zero..TP.B \-m \fIMSS\fRThis option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) fordetails.  If you are using kernel-mode PPPoE, this option has \fIno effect\fR..TP.B \-x \fIn\fRLimit the number of sessions per peer MAC address to \fIn\fR.  If a givenMAC address attempts to create more than \fIn\fR sessions, then itsPADI and PADR packets are ignored.  If you set \fIn\fR to 0 (the default),then no limit is imposed on the number of sessions per peer MAC address..TP.B \-sThis option is passed directly to \fBpppoe\fR; see \fBpppoe\fR(8) fordetails.  In addition, it causes \fBpppd\fR to be invoked with the\fIsync\fR option..TP.B \-L \fIip\fRSets 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\fRSets the starting remote IP address.  As sessions are established,IP addresses are assigned starting from \fIip\fR.   \fBpppoe-server\fRautomatically keeps track of the pool of addresses and passes avalid remote IP address to \fBpppd\fR.  If not specified, a starting addressof 10.67.15.1 is used..TP.B \-N \fInum\fRAllows at most \fInum\fR concurrent PPPoE sessions.  If not specified,the default is 64..TP.B \-O \fIfname\fRThis option causes \fBpppoe-server\fR to tell \fBpppd\fR to use the optionfile \fIfname\fR instead of the default \fI/etc/ppp/pppoe-server-options\fR..TP.B \-p \fIfname\fRReads the specified file \fIfname\fR which is a text file consisting ofone IP address per line.  These IP addresses will be assigned to clients.The number of sessions allowed will equal the number of addresses foundin the file.  The \fB\-p\fR option overrides both \fB\-R\fR and \fB\-N\fR.In addition to containing IP addresses, the pool file can contain linesof the form:.nf	a.b.c.d-e.fiwhich includes all IP addresses from a.b.c.d to a.b.c.e.  For example,the line:.nf	1.2.3.4-7.fiis equivalent to:.nf	1.2.3.4	1.2.3.5	1.2.3.6	1.2.3.7.fi.TP.B \-rTells the PPPoE server to randomly permute session numbers.  Instead ofhanding out sessions in order, the session numbers are assigned in anunpredictable order..TP.B \-uTells the server to invoke \fBpppd\fR with the \fIunit\fR option.  Notethat this option only works for \fBpppd\fR version 2.4.0 or newer..TP.B \-o \fIoffset\fRInstead of numbering PPPoE sessions starting at 1, they will be numberedstarting at \fIoffset\fR+1.  This allows you to run multiple servers ona given machine; just make sure that their session numbers do notoverlap..TP.B \-f disc:sessThe \fB\-f\fR option sets the Ethernet frame types for PPPoE discoveryand session frames.  The types are specified as hexadecimal numbersseparated by a colon.  Standard PPPoE uses frame types 8863:8864.\fIYou should not use this option\fR unless you are absolutely surethe peer you are dealing with uses non-standard frame types..TP.B \-kThe \fB\-k\fR option tells the server to use kernel-mode PPPoE on Linux.This option is available only on Linux kernels 2.4.0 and later, andonly if the server was built with kernel-mode support..TP.B \-hThe \fB\-h\fR option prints a brief usage message and exits..SH OPERATION\fBpppoe-server\fR listens for incoming PPPoE discovery packets.  Whena session is established, it spawns a \fBpppd\fR process.  The followingoptions are passed to \fBpppd\fR:.nfnodetach noaccomp nobsdcom nodeflate nopcomp novj novjccompdefault-asyncmap.fiIn 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 alongwith 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 justempty!)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 <dfs@roaringpenguin.com>.The \fBpppoe\fR home page is \fIhttp://www.roaringpenguin.com/pppoe/\fR..SH SEE ALSOpppoe-start(8), pppoe-stop(8), pppoe-connect(8), pppd(8), pppoe.conf(5),pppoe(8), pppoe-setup(8), pppoe-status(8), pppoe-sniff(8), pppoe-relay(8)