updated on Wed Jan 11 00:07:16 UTC 2012
[aur-mirror.git] / ppp-mppe / options
blob63691842c91c12a59bef122faaecd015a6676e0c
1 # /etc/ppp/options
2
3 # Originally created by Jim Knoble <jmknoble@mercury.interpath.net>
4 # Modified for Debian by alvar Bray <alvar@meiko.co.uk>
5 # Modified for PPP Server setup by Christoph Lameter <clameter@debian.org>
6 # Modified for ArchLinux by Manolis Tzanidakis <manolis@archlinux.org>
8 # To quickly see what options are active in this file, use this command:
9 #   egrep -v '#|^ *$' /etc/ppp/options
11 # Specify which DNS Servers the incoming Win95 or WinNT Connection should use
12 # Two Servers can be remotely configured
13 # ms-dns 192.168.1.1
14 # ms-dns 192.168.1.2
16 # Specify which WINS Servers the incoming connection Win95 or WinNT should use
17 # ms-wins 192.168.1.50
18 # ms-wins 192.168.1.51
20 # Run the executable or shell command specified after pppd has
21 # terminated the link.  This script could, for example, issue commands
22 # to the modem to cause it to hang up if hardware modem control signals
23 # were not available.
24 #disconnect "chat -- \d+++\d\c OK ath0 OK"
26 # async character map -- 32-bit hex; each bit is a character
27 # that needs to be escaped for pppd to receive it.  0x00000001
28 # represents '\x01', and 0x80000000 represents '\x1f'.
29 asyncmap 0
31 # Require the peer to authenticate itself before allowing network
32 # packets to be sent or received.
33 # Please do not disable this setting. It is expected to be standard in
34 # future releases of pppd. Use the call option (see manpage) to disable
35 # authentication for specific peers.
36 auth
38 # Use hardware flow control (i.e. RTS/CTS) to control the flow of data
39 # on the serial port.
40 crtscts
42 # Use software flow control (i.e. XON/XOFF) to control the flow of data
43 # on the serial port.
44 #xonxoff
46 # Specifies that certain characters should be escaped on transmission
47 # (regardless of whether the peer requests them to be escaped with its
48 # async control character map).  The characters to be escaped are
49 # specified as a list of hex numbers separated by commas.  Note that
50 # almost any character can be specified for the escape option, unlike
51 # the asyncmap option which only allows control characters to be
52 # specified.  The characters which may not be escaped are those with hex
53 # values 0x20 - 0x3f or 0x5e.
54 #escape 11,13,ff
56 # Don't use the modem control lines.
57 #local
59 # Specifies that pppd should use a UUCP-style lock on the serial device
60 # to ensure exclusive access to the device.
61 lock
63 # Don't show the passwords when logging the contents of PAP packets.
64 # This is the default.
65 hide-password
67 # When logging the contents of PAP packets, this option causes pppd to
68 # show the password string in the log message.
69 #show-password
71 # Use the modem control lines.  On Ultrix, this option implies hardware
72 # flow control, as for the crtscts option.  (This option is not fully
73 # implemented.)
74 modem
76 # Set the MRU [Maximum Receive Unit] value to <n> for negotiation.  pppd
77 # will ask the peer to send packets of no more than <n> bytes. The
78 # minimum MRU value is 128.  The default MRU value is 1500.  A value of
79 # 296 is recommended for slow links (40 bytes for TCP/IP header + 256
80 # bytes of data).
81 #mru 542
83 # Set the interface netmask to <n>, a 32 bit netmask in "decimal dot"
84 # notation (e.g. 255.255.255.0).
85 #netmask 255.255.255.0
87 # Disables the default behaviour when no local IP address is specified,
88 # which is to determine (if possible) the local IP address from the
89 # hostname. With this option, the peer will have to supply the local IP
90 # address during IPCP negotiation (unless it specified explicitly on the
91 # command line or in an options file).
92 #noipdefault
94 # Enables the "passive" option in the LCP.  With this option, pppd will
95 # attempt to initiate a connection; if no reply is received from the
96 # peer, pppd will then just wait passively for a valid LCP packet from
97 # the peer (instead of exiting, as it does without this option).
98 #passive
100 # With this option, pppd will not transmit LCP packets to initiate a
101 # connection until a valid LCP packet is received from the peer (as for
102 # the "passive" option with old versions of pppd).
103 #silent
105 # Don't request or allow negotiation of any options for LCP and IPCP
106 # (use default values).
107 #-all
109 # Disable Address/Control compression negotiation (use default, i.e.
110 # address/control field disabled).
111 #-ac
113 # Disable asyncmap negotiation (use the default asyncmap, i.e. escape
114 # all control characters).
115 #-am
117 # Don't fork to become a background process (otherwise pppd will do so
118 # if a serial device is specified).
119 #-detach
121 # Disable IP address negotiation (with this option, the remote IP
122 # address must be specified with an option on the command line or in
123 # an options file).
124 #-ip
126 # Disable IPCP negotiation and IP communication. This option should
127 # only be required if the peer is buggy and gets confused by requests
128 # from pppd for IPCP negotiation.
129 #noip
131 # Disable magic number negotiation.  With this option, pppd cannot
132 # detect a looped-back line.
133 #-mn
135 # Disable MRU [Maximum Receive Unit] negotiation (use default, i.e.
136 # 1500).
137 #-mru
139 # Disable protocol field compression negotiation (use default, i.e.
140 # protocol field compression disabled).
141 #-pc
143 # Require the peer to authenticate itself using PAP.
144 #+pap
146 # Don't agree to authenticate using PAP.
147 #-pap
149 # Require the peer to authenticate itself using CHAP [Cryptographic
150 # Handshake Authentication Protocol] authentication.
151 #+chap
153 # Don't agree to authenticate using CHAP.
154 #-chap
156 # Disable negotiation of Van Jacobson style IP header compression (use
157 # default, i.e. no compression).
158 #-vj
160 # Increase debugging level (same as -d).  If this option is given, pppd
161 # will log the contents of all control packets sent or received in a
162 # readable form.  The packets are logged through syslog with facility
163 # daemon and level debug. This information can be directed to a file by
164 # setting up /etc/syslog.conf appropriately (see syslog.conf(5)).  (If
165 # pppd is compiled with extra debugging enabled, it will log messages
166 # using facility local2 instead of daemon).
167 #debug
169 # Append the domain name <d> to the local host name for authentication
170 # purposes.  For example, if gethostname() returns the name porsche,
171 # but the fully qualified domain name is porsche.Quotron.COM, you would
172 # use the domain option to set the domain name to Quotron.COM.
173 #domain <d>
175 # Enable debugging code in the kernel-level PPP driver.  The argument n
176 # is a number which is the sum of the following values: 1 to enable
177 # general debug messages, 2 to request that the contents of received
178 # packets be printed, and 4 to request that the contents of transmitted
179 # packets be printed.
180 #kdebug n
182 # Set the MTU [Maximum Transmit Unit] value to <n>. Unless the peer
183 # requests a smaller value via MRU negotiation, pppd will request that
184 # the kernel networking code send data packets of no more than n bytes
185 # through the PPP network interface.
186 #mtu <n>
188 # Set the name of the local system for authentication purposes to <n>.
189 # This is a privileged option. With this option, pppd will use lines in the
190 # secrets files which have <n> as the second field when looking for a
191 # secret to use in authenticating the peer. In addition, unless overridden
192 # with the user option, <n> will be used as the name to send to the peer
193 # when authenticating the local system to the peer. (Note that pppd does
194 # not append the domain name to <n>.)
195 #name <n>
197 # Enforce the use of the hostname as the name of the local system for
198 # authentication purposes (overrides the name option).
199 #usehostname
201 # Set the assumed name of the remote system for authentication purposes
202 # to <n>.
203 #remotename <n>
205 # Add an entry to this system's ARP [Address Resolution Protocol]
206 # table with the IP address of the peer and the Ethernet address of this
207 # system.
208 proxyarp
210 # Use the system password database for authenticating the peer using
211 # PAP. Note: mgetty already provides this option. If this is specified
212 # then dialin from users using a script under Linux to fire up ppp wont work.
213 # login
215 # If this option is given, pppd will send an LCP echo-request frame to the
216 # peer every n seconds. Normally the peer should respond to the echo-request
217 # by sending an echo-reply. This option can be used with the
218 # lcp-echo-failure option to detect that the peer is no longer connected.
219 lcp-echo-interval 30
221 # If this option is given, pppd will presume the peer to be dead if n
222 # LCP echo-requests are sent without receiving a valid LCP echo-reply.
223 # If this happens, pppd will terminate the connection.  Use of this
224 # option requires a non-zero value for the lcp-echo-interval parameter.
225 # This option can be used to enable pppd to terminate after the physical
226 # connection has been broken (e.g., the modem has hung up) in
227 # situations where no hardware modem control lines are available.
228 lcp-echo-failure 4
230 # Set the LCP restart interval (retransmission timeout) to <n> seconds
231 # (default 3).
232 #lcp-restart <n>
234 # Set the maximum number of LCP terminate-request transmissions to <n>
235 # (default 3).
236 #lcp-max-terminate <n>
238 # Set the maximum number of LCP configure-request transmissions to <n>
239 # (default 10).
240 #lcp-max-configure <n>
242 # Set the maximum number of LCP configure-NAKs returned before starting
243 # to send configure-Rejects instead to <n> (default 10).
244 #lcp-max-failure <n>
246 # Set the IPCP restart interval (retransmission timeout) to <n>
247 # seconds (default 3).
248 #ipcp-restart <n>
250 # Set the maximum number of IPCP terminate-request transmissions to <n>
251 # (default 3).
252 #ipcp-max-terminate <n>
254 # Set the maximum number of IPCP configure-request transmissions to <n>
255 # (default 10).
256 #ipcp-max-configure <n>
258 # Set the maximum number of IPCP configure-NAKs returned before starting
259 # to send configure-Rejects instead to <n> (default 10).
260 #ipcp-max-failure <n>
262 # Set the PAP restart interval (retransmission timeout) to <n> seconds
263 # (default 3).
264 #pap-restart <n>
266 # Set the maximum number of PAP authenticate-request transmissions to
267 # <n> (default 10).
268 #pap-max-authreq <n>
270 # Set the maximum time that pppd will wait for the peer to authenticate
271 # itself with PAP to <n> seconds (0 means no limit).
272 #pap-timeout <n>
274 # Set the CHAP restart interval (retransmission timeout for
275 # challenges) to <n> seconds (default 3).
276 #chap-restart <n>
278 # Set the maximum number of CHAP challenge transmissions to <n>
279 # (default 10).
280 #chap-max-challenge
282 # If this option is given, pppd will rechallenge the peer every <n>
283 # seconds.
284 #chap-interval <n>
286 # With this option, pppd will accept the peer's idea of our local IP
287 # address, even if the local IP address was specified in an option.
288 #ipcp-accept-local
290 # With this option, pppd will accept the peer's idea of its (remote) IP
291 # address, even if the remote IP address was specified in an option.
292 #ipcp-accept-remote
294 # Disable the IPXCP and IPX protocols.
295 # To let pppd pass IPX packets comment this out --- you'll probably also
296 # want to install ipxripd, and have the Internal IPX Network option enabled
297 # in your kernel.  /usr/doc/HOWTO/IPX-HOWTO.gz contains more info.
298 noipx
300 # Exit once a connection has been made and terminated. This is the default,
301 # unless the `persist' or `demand' option has been specified.
302 #nopersist
304 # Do not exit after a connection is terminated; instead try to reopen
305 # the connection.
306 #persist
308 # Terminate after n consecutive failed connection attempts.
309 # A value of 0 means no limit. The default value is 10.
310 #maxfail <n>
312 # Initiate the link only on demand, i.e. when data traffic is present. 
313 # With this option, the remote IP address must be specified by the user on
314 # the command line or in an options file.  Pppd will initially configure
315 # the interface and enable it for IP traffic without connecting to the peer. 
316 # When traffic is available, pppd will connect to the peer and perform
317 # negotiation, authentication, etc.  When this is completed, pppd will
318 # commence passing data packets (i.e., IP packets) across the link.
319 #demand
321 # Specifies that pppd should disconnect if the link is idle for <n> seconds.
322 # The link is idle when no data packets (i.e. IP packets) are being sent or
323 # received.  Note: it is not advisable to use this option with the persist
324 # option without the demand option.  If the active-filter option is given,
325 # data packets which are rejected by the specified activity filter also
326 # count as the link being idle.
327 #idle <n>
329 # Specifies how many seconds to wait before re-initiating the link after
330 # it terminates.  This option only has any effect if the persist or demand
331 # option is used.  The holdoff period is not applied if the link was
332 # terminated because it was idle.
333 #holdoff <n>
335 # Wait for up n milliseconds after the connect script finishes for a valid
336 # PPP packet from the peer.  At the end of this time, or when a valid PPP
337 # packet is received from the peer, pppd will commence negotiation by
338 # sending its first LCP packet.  The default value is 1000 (1 second).
339 # This wait period only applies if the connect or pty option is used.
340 #connect-delay <n>
342 # Packet filtering: for more information, see pppd(8)
343 # Any packets matching the filter expression will be interpreted as link
344 # activity, and will cause a "demand" connection to be activated, and reset
345 # the idle connection timer. (idle option)
346 # The filter expression is akin to that of tcpdump(1)
347 #active-filter <filter-expression>
349 # uncomment the line below this if you use PPPoE
350 #plugin /usr/lib/pppd/plugins/pppoe.so
352 # ---<End of File>---