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