manual/rp-pppoe/original/man5/pppoe.conf.5

   1 .\" $Id: pppoe.conf.5,v 1.5 2002/04/09 17:28:38 dfs Exp $
   2 .\" LIC: GPL
   3 .\""
   4 .TH PPPOE.CONF 5 "21 February 2000"
   5 .UC 4
   6 .SH NAME
   7 pppoe.conf \- Configuration file used by \fBadsl-start\fR(8),
   8 \fBadsl-stop\fR(8), \fBadsl-status(8)\fR and \fBadsl-connect\fR(8).
   9
  10 .SH DESCRIPTION
  11 \fB/etc/ppp/pppoe.conf\fR is a shell script which contains configuration
  12 information for Roaring Penguin's ADSL scripts.  Note that \fBpppoe.conf\fR
  13 is used only by the various adsl-* shell scripts, not by \fBpppoe\fR
  14 itself.
  15
  16 \fBpppoe.conf\fR consists of a sequence of shell variable assignments.
  17 The variables and their meanings are:
  18
  19 .TP
  20 .B ETH
  21 The Ethernet interface connected to the ADSL modem (for example, eth0).
  22
  23 .TP
  24 .B USER
  25 The ADSL user-id (for example, b1xxnxnx@sympatico.ca).
  26
  27 .TP
  28 .B SERVICENAME
  29 If this is not blank, then it is passed with the \fB\-S\fR option to
  30 \fBpppoe\fR.  It specifies a service name to ask for.  Usually, you
  31 should leave it blank.
  32
  33 .TP
  34 .B ACNAME
  35 If this is not blank, then it is passed with the \fB\-C\fR option to
  36 \fBpppoe\fR.  It specifies the name of the access concentrator to connect
  37 to.  Usually, you should leave it blank.
  38
  39 .TP
  40 .B DEMAND
  41 If set to a number, the link is activated on demand and brought down
  42 after after \fBDEMAND\fR seconds.  If set to \fBno\fR, the link is kept
  43 up all the time rather than being activated on demand.
  44
  45 .TP
  46 .B DNSTYPE
  47 One of \fBNOCHANGE\fR, \fBSPECIFY\fR or \fBSERVER\fR.  If
  48 set to NOCHANGE, \fBadsl-connect\fR will not adjust the DNS setup in
  49 any way.  If set to SPECIFY, it will re-write /etc/resolv.conf with
  50 the values of DNS1 and DNS2.  If set to \fBSERVER\fR, it will
  51 supply the \fIusepeerdns\fR option to \fBpppd\fR, and make a symlink
  52 from /etc/resolv.conf to /etc/ppp/resolv.conf.
  53
  54 .TP
  55 .B DNS1, DNS2
  56 IP addresses of DNS servers if you use DNSTYPE=SPECIFY.
  57
  58 .TP
  59 .B NONROOT
  60 If the line \fBNONROOT=OK\fR (exactly like that; no whitespace or comments)
  61 appears in the configuration file, then \fBpppoe-wrapper\fR will allow
  62 non-root users to bring the conneciton up or down.  The wrapper is installed
  63 only if you installed the rp-pppoe-gui package.
  64
  65 .TP
  66 .B USEPEERDNS
  67 If set to "yes", then \fBadsl-connect\fR will supply the \fIusepeerdns\fR
  68 option to \fBpppd\fR, which causes it to obtain DNS server addresses
  69 from the peer and create a new \fB/etc/resolv.conf\fR file.  Otherwise,
  70 \fBadsl-connect\fR will not supply this option, and \fBpppd\fR will not
  71 modify \fB/etc/resolv.conf\fR.
  72
  73 .TP
  74 .B CONNECT_POLL
  75 How often (in seconds) \fBadsl-start\fR should check to see if a new PPP
  76 interface has come up.  If this is set to 0, the \fBadsl-start\fR simply
  77 initiates the PPP session, but does not wait to see if it comes up
  78 successfully.
  79
  80 .TP
  81 .B CONNECT_TIMEOUT
  82 How long (in seconds) \fBadsl-start\fR should wait for a new PPP interface
  83 to come up before concluding that \fBadsl-connect\fR has failed and killing
  84 the session.
  85
  86 .TP
  87 .B PING
  88 A character which is echoed every \fBCONNECT_POLL\fR seconds while
  89 \fBadsl-start\fR is waiting for the PPP interface to come up.
  90
  91 .TP
  92 .B FORCEPING
  93 A character which is echoed every \fBCONNECT_POLL\fR seconds while
  94 \fBadsl-start\fR is waiting for the PPP interface to come up.  Similar
  95 to \fBPING\fR, but the character is echoed even if \fBadsl-start\fR's
  96 standard output is not a tty.
  97
  98 .TP
  99 .B PIDFILE
 100 A file in which to write the process-ID of the adsl-connect process
 101 (for example, \fB/var/run/pppoe.pid\fR).  Two additional files
 102 ($PIDFILE.pppd and $PIDFILE.pppoe) hold the process-ID's of the
 103 \fBpppd\fR and \fBpppoe\fR processes, respectively.
 104
 105 .TP
 106 .B SYNCHRONOUS
 107 An indication of whether or not to use synchronous PPP (\fByes\fR or
 108 \fBno\fR).  Synchronous PPP is safe on Linux machines with the n_hdlc
 109 line discipline.  (If you have a file called "n_hdlc.o" in your
 110 modules directory, you have the line discipline.)  It is \fInot
 111 recommended\fR on other machines or on Linux machines without the
 112 n_hdlc line discipline due to some known and unsolveable race
 113 conditions in a user-mode client.
 114
 115 .TP
 116 .B CLAMPMSS
 117 The value at which to "clamp" the advertised MSS for TCP sessions.  The
 118 default of 1412 should be fine.
 119
 120 .TP
 121 .B LCP_INTERVAL
 122 How often (in seconds) \fBpppd\fR sends out LCP echo-request packets.
 123
 124 .TP
 125 .B LCP_FAILURE
 126 How many unanswered LCP echo-requests must occur before \fBpppd\fR
 127 concludes the link is dead.
 128
 129 .TP
 130 .B PPPOE_TIMEOUT
 131 If this many seconds elapse without any activity seen by \fBpppoe\fR,
 132 then \fBpppoe\fR exits.
 133
 134 .TP
 135 .B FIREWALL
 136 One of NONE, STANDALONE or MASQUERADE.  If NONE, then \fBadsl-connect\fR does
 137 not add any firewall rules.  If STANDALONE, then it clears existing firewall
 138 rules and sets up basic rules for a standalone machine.  If MASQUERADE, then
 139 it clears existing firewall rules and sets up basic rules for an Internet
 140 gateway.  If you run services on your machine, these simple firewall scripts
 141 are inadequate; you'll have to make your own firewall rules and set FIREWALL
 142 to NONE.
 143
 144 .TP
 145 .B PPPOE_EXTRA
 146 Any extra arguments to pass to \fBpppoe\fR
 147
 148 .TP
 149 .B PPPD_EXTRA
 150 Any extra arguments to pass to \fBpppd\fR
 151
 152 .TP
 153 .B LINUX_PLUGIN
 154 If non-blank, the full path of the Linux kernel-mode PPPoE plugin
 155 (typically \fB/etc/ppp/plugins/rp-pppoe.so\fR.)  This forces
 156 \fBadsl-connect\fR to use kernel-mode PPPoE on Linux 2.4.x systems.
 157 This code is experimental and unsupported.  Use of the plugin causes
 158 \fBadsl-connect\fR to ignore CLAMPMSS, PPPOE_EXTRA, SYNCHRONOUS and
 159 PPPOE_TIMEOUT.
 160
 161 .P
 162 By using different configuration files with different PIDFILE
 163 settings, you can manage multiple PPPoE connections.  Just specify the
 164 configuration file as an argument to \fBadsl-start\fR and \fBadsl-stop\fR.
 165
 166 .SH SEE ALSO
 167 pppoe(8), adsl-connect(8), adsl-start(8), adsl-stop(8), pppd(8), adsl-setup(8),
 168 pppoe-wrapper(8)
 169