<tty_name> |
| Communicate over the named device. The string "/dev/" is prepended if necessary. If no device name is given, or if the name of the terminal connected to the standard input is given, pppd will use that terminal, and will not fork to put itself in the background. This option is privileged if the noauth option is used. |
<speed> |
| Set the baud rate to <speed> (a decimal number). On systems such as 4.4BSD and NetBSD, any speed can be specified, providing that it is supported by the serial device driver. Other systems (e.g. SunOS, Linux) allow only a limited set of speeds. |
active-filter filter-expression |
| Specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity, and therefore reset the idle timer, or cause the link to be brought up in demand-dialling mode. This option is useful in conjunction with the idle option if there are packets being sent or received regularly over the link (for example, routing information packets) which would otherwise prevent the link from ever appearing to be idle. The filter-expression syntax is as described for tcpdump(1), except that qualifiers which are inappropriate for a PPP link, such as ether and arp, are not permitted. Generally the filter expression should be enclosed in single-quotes to prevent whitespace in the expression from being interpreted by the shell. This option only available if both the kernel and pppd were compiled with PPP_FILTER defined. |
asyncmap <map> |
| Set the async character map to <map>. This map describes which control characters cannot be successfully received over the serial line. Pppd will ask the peer to send these characters as a 2-byte escape sequence. The argument is a 32 bit hex number with each bit representing a character to escape. Bit 0 (00000001) represents the character 0x00; bit 31 (80000000) represents the character 0x1f or ^_. If multiple asyncmap options are given, the values are ORed together. If no asyncmap option is given, no async character map will be negotiated for the receive direction; the peer should then escape all control characters. To escape transmitted characters, use the escape option. |
auth | Require the peer to authenticate itself before allowing network packets to be sent or received. |
call name |
| Read options from the file /etc/ppp/peers/name. This file may contain privileged options, such as noauth, even if pppd is not being run by root. The name string may not begin with / or include .. as a pathname component. The format of the options file is described below. |
connect script |
| Use the executable or shell command specified by script to set up the serial line. This script would typically use the chat(8) program to dial the modem and start the remote ppp session. This option is privileged if the noauth option is used. |
connect-max-attempts <n> |
| Attempt dial-out connection to remote system no more than specified number of times (default = 1). If the connection is not made, pppd will exit. Requires that persist has been specified. |
crtscts |
| Use hardware flow control (i.e. RTS/CTS) to control the flow of data on the serial port. If neither the crtscts nor the nocrtscts option is given, the hardware flow control setting for the serial port is left unchanged. |
defaultroute |
| Add a default route to the system routing tables, using the peer as the gateway, when IPCP negotiation is successfully completed. This entry is removed when the PPP connection is broken. This option is privileged if the nodefaultroute option has been specified. |
disconnect script |
| Run the executable or shell command specified by script after pppd has terminated the link. This script could, for example, issue commands to the modem to cause it to hang up if hardware modem control signals were not available. The disconnect script is not run if the modem has already hung up. This option is privileged if the noauth option is used. |
escape xx,yy,... |
| Specifies that certain characters should be escaped on transmission (regardless of whether the peer requests them to be escaped with its async control character map). The characters to be escaped are specified as a list of hex numbers separated by commas. Note that almost any character can be specified for the escape option, unlike the asyncmap option which only allows control characters to be specified. The characters which may not be escaped are those with hex values 0x20 - 0x3f or 0x5e. |
file name |
| Read options from file name (the format is described below). The file must be readable by the user who has invoked pppd. |
lock | Specifies that pppd should create a UUCP-style lock file for the serial device to ensure exclusive access to the device. |
mru n | Set the MRU [Maximum Receive Unit] value to n. Pppd will ask the peer to send packets of no more than n bytes. The minimum MRU value is 128. The default MRU value is 1500. A value of 296 is recommended for slow links (40 bytes for TCP/IP header + 256 bytes of data). |
mtu n | Set the MTU [Maximum Transmit Unit] value to n. Unless the peer requests a smaller value via MRU negotiation, pppd will request that the kernel networking code send data packets of no more than n bytes through the PPP network interface. |
passive |
| Enables the "passive" option in the LCP. With this option, pppd will attempt to initiate a connection; if no reply is received from the peer, pppd will then just wait passively for a valid LCP packet from the peer, instead of exiting, as it would without this option. |
|
<local_IP_address>:<remote_IP_address> |
| Set the local and/or remote interface IP addresses. Either one may be omitted. The IP addresses can be specified with a host name or in decimal dot notation (e.g. 150.234.56.78). The default local address is the (first) IP address of the system (unless the noipdefault option is given). The remote address will be obtained from the peer if not specified in any option. Thus, in simple cases, this option is not required. If a local and/or remote IP address is specified with this option, pppd will not accept a different value from the peer in the IPCP negotiation, unless the ipcp-accept-local and/or ipcp-accept-remote options are given, respectively. |
bsdcomp nr,nt |
| Request that the peer compress packets that it sends, using the BSD-Compress scheme, with a maximum code size of nr bits, and agree to compress packets sent to the peer with a maximum code size of nt bits. If nt is not specified, it defaults to the value given for nr. Values in the range 9 to 15 may be used for nr and nt; larger values give better compression but consume more kernel memory for compression dictionaries. Alternatively, a value of 0 for nr or nt disables compression in the corresponding direction. Use nobsdcomp or bsdcomp 0 to disable BSD-Compress compression entirely. |
callback phone_number |
| Request a call-back to the phone_number. This only works if the peer is speaking the Call Back Configuration Protocol. Do not put this into the main options file if you sometimes connect to servers that dont support it. |
chap-interval n |
| If this option is given, pppd will rechallenge the peer every n seconds. |
chap-max-challenge n |
| Set the maximum number of CHAP challenge transmissions to n (default 10). |
chap-restart n |
| Set the CHAP restart interval (retransmission timeout for challenges) to n seconds (default 3). |
debug | Enables connection debugging facilities. If this option is given, pppd will log the contents of all control packets sent or received in a readable form. The packets are logged through syslog with facility daemon and level debug. This information can be directed to a file by setting up /etc/syslog.conf appropriately (see syslog.conf(5)). |
default-asyncmap |
| Disable asyncmap negotiation, forcing all control characters to be escaped for both the transmit and the receive direction. |
default-mru |
| Disable MRU [Maximum Receive Unit] negotiation. With this option, pppd will use the default MRU value of 1500 bytes for both the transmit and receive direction. |
deflate nr,nt |
| Request that the peer compress packets that it sends, using the Deflate scheme, with a maximum window size of 2**nr bytes, and agree to compress packets sent to the peer with a maximum window size of 2**nt bytes. If nt is not specified, it defaults to the value given for nr. Values in the range 8 to 15 may be used for nr and nt; larger values give better compression but consume more kernel memory for compression dictionaries. Alternatively, a value of 0 for nr or nt disables compression in the corresponding direction. Use nodeflate or deflate 0 to disable Deflate compression entirely. (Note: pppd requests Deflate compression in preference to BSD-Compress if the peer can do either.) |
demand | Initiate the link only on demand, i.e. when data traffic is present. With this option, the remote IP address must be specified by the user on the command line or in an options file. Pppd will initially configure the interface and enable it for IP traffic without connecting to the peer. When traffic is available, pppd will connect to the peer and perform negotiation, authentication, etc. When this is completed, pppd will commence passing data packets (i.e., IP packets) across the link. The demand option implies the persist option. If this behaviour is not desired, use the nopersist option after the demand option. The idle and holdoff options are also useful in conjunction with the demand option. |
domain d |
| Append the domain name d to the local host name for authentication purposes. For example, if gethostname() returns the name porsche, but the fully qualified domain name is porsche.Quotron.COM, you could specify domain Quotron.COM. Pppd would then use the name porsche.Quotron.COM for looking up secrets in the secrets file, and as the default name to send to the peer when authenticating itself to the peer. This option is privileged. |
holdoff n |
| Specifies how many seconds to wait before re-initiating the link after it terminates. This option only has any effect if the persist or demand option is used. The holdoff period is not applied if the link was terminated because it was idle. |
idle n | Specifies that pppd should disconnect if the link is idle for n seconds. The link is idle when no data packets (i.e. IP packets) are being sent or received. Note: it is not advisable to use this option with the persist option without the demand option. If the active-filter option is given, data packets which are rejected by the specified activity filter also count as the link being idle. |
ipcp-accept-local |
| With this option, pppd will accept the peers idea of our local IP address, even if the local IP address was specified in an option. |
ipcp-accept-remote |
| With this option, pppd will accept the peers idea of its (remote) IP address, even if the remote IP address was specified in an option. |
ipcp-max-configure n |
| Set the maximum number of IPCP configure-request transmissions to n (default 10). |
ipcp-max-failure n |
| Set the maximum number of IPCP configure-NAKs returned before starting to send configure-Rejects instead to n (default 10). |
ipcp-max-terminate n |
| Set the maximum number of IPCP terminate-request transmissions to n (default 3). |
ipcp-restart n |
| Set the IPCP restart interval (retransmission timeout) to n seconds (default 3). |
ipparam string |
| Provides an extra parameter to the ip-up and ip-down scripts. If this option is given, the string supplied is given as the 6th parameter to those scripts. |
ipx | Enable the IPXCP and IPX protocols. This option is presently only supported under Linux, and only if your kernel has been configured to include IPX support. |
ipx-network n |
| Set the IPX network number in the IPXCP configure request frame to n, a hexadecimal number (without a leading 0x). There is no valid default. If this option is not specified, the network number is obtained from the peer. If the peer does not have the network number, the IPX protocol will not be started. |
ipx-node n:m |
| Set the IPX node numbers. The two node numbers are separated from each other with a colon character. The first number n is the local node number. The second number m is the peers node number. Each node number is a hexadecimal number, at most 10 digits long. The node numbers on the ipx-network must be unique. There is no valid default. If this option is not specified then the node numbers are obtained from the peer. |
ipx-router-name <string> |
| Set the name of the router. This is a string and is sent to the peer as information data. |
ipx-routing n |
| Set the routing protocol to be received by this option. More than one instance of ipx-routing may be specified. The none option (0) may be specified as the only instance of ipx-routing. The values may be 0 for NONE, 2 for RIP/SAP, and 4 for NLSP. |
ipxcp-accept-local |
| Accept the peers NAK for the node number specified in the ipx-node option. If a node number was specified, and non-zero, the default is to insist that the value be used. If you include this option then you will permit the peer to override the entry of the node number. |
ipxcp-accept-network |
| Accept the peers NAK for the network number specified in the ipx-network option. If a network number was specified, and non-zero, the default is to insist that the value be used. If you include this option then you will permit the peer to override the entry of the node number. |
ipxcp-accept-remote |
| Use the peers network number specified in the configure request frame. If a node number was specified for the peer and this option was not specified, the peer will be forced to use the value which you have specified. |
ipxcp-max-configure n |
| Set the maximum number of IPXCP configure request frames which the system will send to n. The default is 10. |
ipxcp-max-failure n |
| Set the maximum number of IPXCP NAK frames which the local system will send before it rejects the options. The default value is 3. |
ipxcp-max-terminate n |
| Set the maximum number of IPXCP terminate request frames before the local system considers that the peer is not listening to them. The default value is 3. |
kdebug n |
| Enable debugging code in the kernel-level PPP driver. The argument n is a number which is the sum of the following values: 1 to enable general debug messages, 2 to request that the contents of received packets be printed, and 4 to request that the contents of transmitted packets be printed. On most systems, messages printed by the kernel are logged by syslog(1) to a file as directed in the /etc/syslog.conf configuration file. |
lcp-echo-failure n |
| If this option is given, pppd will presume the peer to be dead if n LCP echo-requests are sent without receiving a valid LCP echo-reply. If this happens, pppd will terminate the connection. Use of this option requires a non-zero value for the lcp-echo-interval parameter. This option can be used to enable pppd to terminate after the physical connection has been broken (e.g., the modem has hung up) in situations where no hardware modem control lines are available. |
lcp-echo-interval n |
| If this option is given, pppd will send an LCP echo-request frame to the peer every n seconds. Normally the peer should respond to the echo-request by sending an echo-reply. This option can be used with the lcp-echo-failure option to detect that the peer is no longer connected. |
lcp-max-configure n |
| Set the maximum number of LCP configure-request transmissions to n (default 10). |
lcp-max-failure n |
| Set the maximum number of LCP configure-NAKs returned before starting to send configure-Rejects instead to n (default 10). |
lcp-max-terminate n |
| Set the maximum number of LCP terminate-request transmissions to n (default 3). |
lcp-restart n |
| Set the LCP restart interval (retransmission timeout) to n seconds (default 3). |
local | Dont use the modem control lines. With this option, pppd will ignore the state of the CD (Carrier Detect) signal from the modem and will not change the state of the DTR (Data Terminal Ready) signal. |
login | Use the system password database for authenticating the peer using PAP, and record the user in the system wtmp file. Note that the peer must have an entry in the /etc/ppp/pap-secrets file as well as the system password database to be allowed access. |
maxconnect n |
| Terminate the connection when it has been available for network traffic for n seconds (i.e. n seconds after the first network control protocol comes up). |
modem | Use the modem control lines. This option is the default. With this option, pppd will wait for the CD (Carrier Detect) signal from the modem to be asserted when opening the serial device (unless a connect script is specified), and it will drop the DTR (Data Terminal Ready) signal briefly when the connection is terminated and before executing the connect script. On Ultrix, this option implies hardware flow control, as for the crtscts option. |
ms-dns <addr> |
| If pppd is acting as a server for Microsoft Windows clients, this option allows pppd to supply one or two DNS (Domain Name Server) addresses to the clients. The first instance of this option specifies the primary DNS address; the second instance (if given) specifies the secondary DNS address. (This option was present in some older versions of pppd under the name dns-addr.) |
ms-wins <addr> |
| If pppd is acting as a server for Microsoft Windows or "Samba" clients, this option allows pppd to supply one or two WINS (Windows Internet Name Services) server addresses to the clients. The first instance of this option specifies the primary WINS address; the second instance (if given) specifies the secondary WINS address. |
name name |
| Set the name of the local system for authentication purposes to name. This is a privileged option. With this option, pppd will use lines in the secrets files which have name as the second field when looking for a secret to use in authenticating the peer. In addition, unless overridden with the user option, name will be used as the name to send to the peer when authenticating the local system to the peer. (Note that pppd does not append the domain name to name.) |
netmask n |
| Set the interface netmask to n, a 32 bit netmask in "decimal dot" notation (e.g. 255.255.255.0). If this option is given, the value specified is ORed with the default netmask. The default netmask is chosen based on the negotiated remote IP address; it is the appropriate network mask for the class of the remote IP address, ORed with the netmasks for any non point-to-point network interfaces in the system which are on the same network. |
noaccomp |
| Disable Address/Control compression in both directions (send and receive). |
noauth | Do not require the peer to authenticate itself. This option is privileged if the auth option is specified in /etc/ppp/options. |
nobsdcomp |
| Disables BSD-Compress compression; pppd will not request or agree to compress packets using the BSD-Compress scheme. |
noccp | Disable CCP (Compression Control Protocol) negotiation. This option should only be required if the peer is buggy and gets confused by requests from pppd for CCP negotiation. |
nocrtscts |
| Disable hardware flow control (i.e. RTS/CTS) on the serial port. If neither the crtscts nor the nocrtscts option is given, the hardware flow control setting for the serial port is left unchanged. |
nodefaultroute |
| Disable the defaultroute option. The system administrator who wishes to prevent users from creating default routes with pppd can do so by placing this option in the /etc/ppp/options file. |
nodeflate |
| Disables Deflate compression; pppd will not request or agree to compress packets using the Deflate scheme. |
nodetach |
| Dont detach from the controlling terminal. Without this option, if a serial device other than the terminal on the standard input is specified, pppd will fork to become a background process. |
noip | Disable IPCP negotiation and IP communication. This option should only be required if the peer is buggy and gets confused by requests from pppd for IPCP negotiation. |
noipdefault |
| Disables the default behaviour when no local IP address is specified, which is to determine (if possible) the local IP address from the hostname. With this option, the peer will have to supply the local IP address during IPCP negotiation (unless it specified explicitly on the command line or in an options file). |
noipx | Disable the IPXCP and IPX protocols. This option should only be required if the peer is buggy and gets confused by requests from pppd for IPXCP negotiation. |
nomagic |
| Disable magic number negotiation. With this option, pppd cannot detect a looped-back line. This option should only be needed if the peer is buggy. |
nopcomp |
| Disable protocol field compression negotiation in both the receive and the transmit direction. |
nopersist |
| Exit once a connection has been made and terminated. This is the default unless the persist or demand option has been specified. |
nopredictor1 |
| Do not accept or agree to Predictor-1 compression. |
noproxyarp |
| Disable the proxyarp option. The system administrator who wishes to prevent users from creating proxy ARP entries with pppd can do so by placing this option in the /etc/ppp/options file. |
novj | Disable Van Jacobson style TCP/IP header compression in both the transmit and the receive direction. |
novjccomp |
| Disable the connection-ID compression option in Van Jacobson style TCP/IP header compression. With this option, pppd will not omit the connection-ID byte from Van Jacobson compressed TCP/IP headers, nor ask the peer to do so. |
papcrypt |
| Indicates that all secrets in the /etc/ppp/pap-secrets file which are used for checking the identity of the peer are encrypted, and thus pppd should not accept a password which, before encryption, is identical to the secret from the /etc/ppp/pap-secrets file. |
pap-max-authreq n |
| Set the maximum number of PAP authenticate-request transmissions to n (default 10). |
pap-restart n |
| Set the PAP restart interval (retransmission timeout) to n seconds (default 3). |
pap-timeout n |
| Set the maximum time that pppd will wait for the peer to authenticate itself with PAP to n seconds (0 means no limit). |
pass-filter filter-expression |
| Specifies a packet filter to applied to data packets being sent or received to determine which packets should be allowed to pass. Packets which are rejected by the filter are silently discarded. This option can be used to prevent specific network daemons (such as routed) using up link bandwidth, or to provide a basic firewall capability. The filter-expression syntax is as described for tcpdump(1), except that qualifiers which are inappropriate for a PPP link, such as ether and arp, are not permitted. Generally the filter expression should be enclosed in single-quotes to prevent whitespace in the expression from being interpreted by the shell. Note that it is possible to apply different constraints to incoming and outgoing packets using the inbound and outbound qualifiers. This option is currently only available under NetBSD, and then only if both the kernel and pppd were compiled with PPP_FILTER defined. |
persist |
| Do not exit after a connection is terminated; instead try to reopen the connection. |
predictor1 |
| Request that the peer compress frames that it sends using Predictor-1 compression, and agree to compress transmitted frames with Predictor-1 if requested. This option has no effect unless the kernel driver supports Predictor-1 compression. |
proxyarp |
| Add an entry to this systems ARP [Address Resolution Protocol] table with the IP address of the peer and the Ethernet address of this system. This will have the effect of making the peer appear to other systems to be on the local ethernet. |
remotename name |
| Set the assumed name of the remote system for authentication purposes to name. |
refuse-chap |
| With this option, pppd will not agree to authenticate itself to the peer using CHAP. |
refuse-pap |
| With this option, pppd will not agree to authenticate itself to the peer using PAP. |
require-chap |
| Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol] authentication. |
require-pap |
| Require the peer to authenticate itself using PAP [Password Authentication Protocol] authentication. |
silent | With this option, pppd will not transmit LCP packets to initiate a connection until a valid LCP packet is received from the peer (as for the passive option with ancient versions of pppd). |
usehostname |
| Enforce the use of the hostname (with domain name appended, if given) as the name of the local system for authentication purposes (overrides the name option). |
user name |
| Sets the name used for authenticating the local system to the peer to name. |
vj-max-slots n |
| Sets the number of connection slots to be used by the Van Jacobson TCP/IP header compression and decompression code to n, which must be between 2 and 16 (inclusive). |
welcome script |
| Run the executable or shell command specified by script before initiating PPP negotiation, after the connect script (if any) has completed. This option is privileged if the noauth option is used. |
xonxoff |
| Use software flow control (i.e. XON/XOFF) to control the flow of data on the serial port. |
|