1PPPOE.CONF(5) File Formats Manual PPPOE.CONF(5)
2
6 ifcfg-ppp0 - Configuration file used by pppoe-start(8), pppoe-stop(8),
7 pppoe-status(8) and pppoe-connect(8).
8
11 /etc/sysconfig/network-scripts/ifcfg-ppp0 is a shell script which con‐
12 tains configuration information for Roaring Penguin's PPPoE scripts.
13 Note that pppoe.conf is used only by the various pppoe-* shell scripts,
14 not by pppoe itself.
15 ifcfg-ppp0 consists of a sequence of shell variable assignments. The
17 variables and their meanings are:
18 ETH The Ethernet interface connected to the DSL modem (for example,
21 eth0).
22 USER The PPPoE user-id (for example, b1xxnxnx@sympatico.ca).
25 SERVICENAME
28 If this is not blank, then it is passed with the -S option to
29 pppoe. It specifies a service name to ask for. Usually, you
30 should leave it blank.
31 ACNAME If this is not blank, then it is passed with the -C option to
34 pppoe. It specifies the name of the access concentrator to con‐
35 nect to. Usually, you should leave it blank.
36 DEMAND If set to a number, the link is activated on demand and brought
39 down after after DEMAND seconds. If set to no, the link is kept
40 up all the time rather than being activated on demand.
41 DNSTYPE
44 One of NOCHANGE, SPECIFY or SERVER. If set to NOCHANGE, pppoe-
45 connect will not adjust the DNS setup in any way. If set to
46 SPECIFY, it will re-write /etc/resolv.conf with the values of
47 DNS1 and DNS2. If set to SERVER, it will supply the usepeerdns
48 option to pppd, and make a symlink from /etc/resolv.conf to
49 /etc/ppp/resolv.conf.
50 DNS1, DNS2
53 IP addresses of DNS servers if you use DNSTYPE=SPECIFY.
54 USERCTL
57 If the line USERCTL=yes (exactly like that; no whitespace or
58 comments) appears in the configuration file, then /sbin/ifup
59 will allow non-root users to bring the conneciton up or down.
60 USEPEERDNS
63 If set to "yes", then pppoe-connect will supply the usepeerdns
64 option to pppd, which causes it to obtain DNS server addresses
65 from the peer and create a new /etc/resolv.conf file. Other‐
66 wise, pppoe-connect will not supply this option, and pppd will
67 not modify /etc/resolv.conf.
68 CONNECT_POLL
71 How often (in seconds) pppoe-start should check to see if a new
72 PPP interface has come up. If this is set to 0, the pppoe-start
73 simply initiates the PPP session, but does not wait to see if it
74 comes up successfully.
75 CONNECT_TIMEOUT
78 How long (in seconds) pppoe-start should wait for a new PPP
79 interface to come up before concluding that pppoe-connect has
80 failed and killing the session.
81 PING A character which is echoed every CONNECT_POLL seconds while
84 pppoe-start is waiting for the PPP interface to come up.
85 FORCEPING
88 A character which is echoed every CONNECT_POLL seconds while
89 pppoe-start is waiting for the PPP interface to come up. Simi‐
90 lar to PING, but the character is echoed even if pppoe-start's
91 standard output is not a tty.
92 PIDFILE
95 A file in which to write the process-ID of the pppoe-connect
96 process (for example, /var/run/pppoe.pid). Two additional files
97 ($PIDFILE.pppd and $PIDFILE.pppoe) hold the process-ID's of the
98 pppd and pppoe processes, respectively.
99 SYNCHRONOUS
102 An indication of whether or not to use synchronous PPP (yes or
103 no). Synchronous PPP is safe on Linux machines with the n_hdlc
104 line discipline. (If you have a file called "n_hdlc.o" in your
105 modules directory, you have the line discipline.) It is not
106 recommended on other machines or on Linux machines without the
107 n_hdlc line discipline due to some known and unsolveable race
108 conditions in a user-mode client.
109 CLAMPMSS
112 The value at which to "clamp" the advertised MSS for TCP ses‐
113 sions. The default of 1412 should be fine.
114 LCP_INTERVAL
117 How often (in seconds) pppd sends out LCP echo-request packets.
118 LCP_FAILURE
121 How many unanswered LCP echo-requests must occur before pppd
122 concludes the link is dead.
123 PPPOE_TIMEOUT
126 If this many seconds elapse without any activity seen by pppoe,
127 then pppoe exits.
128 FIREWALL
131 One of NONE, STANDALONE or MASQUERADE. If NONE, then pppoe-con‐
132 nect does not add any firewall rules. If STANDALONE, then it
133 clears existing firewall rules and sets up basic rules for a
134 standalone machine. If MASQUERADE, then it clears existing
135 firewall rules and sets up basic rules for an Internet gateway.
136 If you run services on your machine, these simple firewall
137 scripts are inadequate; you'll have to make your own firewall
138 rules and set FIREWALL to NONE.
139 PPPOE_EXTRA
142 Any extra arguments to pass to pppoe
143 PPPD_EXTRA
146 Any extra arguments to pass to pppd
147 LINUX_PLUGIN
150 If non-blank, the full path of the Linux kernel-mode PPPoE plug‐
151 in (typically /etc/ppp/plugins/rp-pppoe.so.) This forces pppoe-
152 connect to use kernel-mode PPPoE on Linux 2.4.x systems. This
153 code is experimental and unsupported. Use of the plugin causes
154 pppoe-connect to ignore CLAMPMSS, PPPOE_EXTRA, SYNCHRONOUS and
155 PPPOE_TIMEOUT.
156 By using different configuration files with different PIDFILE settings,
159 you can manage multiple PPPoE connections. Just specify the configura‐
160 tion file as an argument to pppoe-start and pppoe-stop.
161
164 pppoe(8), pppoe-connect(8), pppoe-start(8), pppoe-stop(8), pppd(8),
165 pppoe-setup(8), pppoe-wrapper(8)
1664th Berkeley Distribution 21 February 2000 PPPOE.CONF(5)