.\" manual page [] for pppd 2.0
-.\" $Id: pppd.8,v 1.17 1996/01/18 04:01:15 paulus Exp $
+.\" $Id: pppd.8,v 1.20 1996/07/03 06:48:29 paulus Exp $
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.SH FREQUENTLY USED OPTIONS
.TP
.I <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 controlling terminal is given,
+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,
.I pppd
-will use the controlling terminal, and will not fork to put itself in
-the background.
+will use that terminal, and will not fork to put itself in the
+background.
.TP
.I <speed>
Set the baud rate to <speed> (a decimal number). On systems such as
request that the kernel networking code send data packets of no more
than \fIn\fR bytes through the PPP network interface.
.TP
-.B netmask \fI<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.
-.TP
.B passive
Enables the "passive" option in the LCP. With this option,
.I pppd
will attempt to initiate a connection; if no reply is received from
the peer,
.I pppd
-will then just wait passively for a valid LCP packet from the peer
-(instead of exiting, as it does without this option).
-.TP
-.B silent
-With this option,
-.I 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 \fIpppd\fR).
+will then just wait passively for a valid LCP packet from the peer,
+instead of exiting, as it would without this option.
.SH OPTIONS
.TP
.I <local_IP_address>\fB:\fI<remote_IP_address>
.B ipcp-accept-remote
options are given, respectively.
.TP
-.B -ac
-Disable Address/Control compression negotiation (use default, i.e.
-address/control field compression disabled).
-.TP
-.B -all
-Don't request or allow negotiation of any options for LCP and IPCP (use
-default values).
-.TP
-.B -am
-Disable asyncmap negotiation (use the default asyncmap, i.e. escape
-all control characters).
-.TP
-.B -as \fI<n>
-Same as
-.B asyncmap \fI<n>
-.TP
.B bsdcomp \fInr,nt
Request that the peer compress packets that it sends, using the
BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
compression in the corresponding direction.
.TP
-.B \-bsdcomp
-Disables BSD-Compress compression; \fBpppd\fR will not request or
-agree to compress packets using the BSD-Compress scheme.
-.TP
-.B +chap
-Require the peer to authenticate itself using CHAP [Cryptographic
-Handshake Authentication Protocol] authentication.
-.TP
-.B -chap
-Don't agree to authenticate using CHAP.
-.TP
.B chap-interval \fI<n>
If this option is given,
.I pppd
Set the CHAP restart interval (retransmission timeout for challenges)
to <n> seconds (default 3).
.TP
-.B -crtscts
-Disable hardware flow control (i.e. RTS/CTS) on the serial port. If
-neither the \fBcrtscts\fR nor the \fB\-crtscts\fR option is given,
-the hardware flow control setting for the serial port is left
-unchanged.
-.TP
-.B -d
-Increase debugging level (same as the \fBdebug\fR option).
-.TP
.B debug
-Increase debugging level (same as \fB\-d\fR).
+Increase debugging level.
If this option is given, \fIpppd\fR will log the contents of all
control packets sent or received in a readable form. The packets are
logged through syslog with facility \fIdaemon\fR and level
\fIdebug\fR. This information can be directed to a file by setting up
/etc/syslog.conf appropriately (see syslog.conf(5)).
.TP
-.B \-defaultroute
-Disable the \fBdefaultroute\fR option. The system administrator who
-wishes to prevent users from creating default routes with \fIpppd\fR
-can do so by placing this option in the /etc/ppp/options file.
+.B default-asyncmap
+Disable asyncmap negotiation, forcing all control characters to be
+escaped for both the transmit and the receive direction.
+.TP
+.B default-mru
+Disable MRU [Maximum Receive Unit] negotiation. With this option,
+\fIpppd\fR will use the default MRU value of 1500 bytes for both the
+transmit and receive direction.
.TP
.B deflate \fInr,nt
Request that the peer compress packets that it sends, using the
-Deflate scheme, with a maximum window size of \fI2**nr\fR bits, and
+Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
agree to compress packets sent to the peer with a maximum window size of
-\fI2**nt\fR bits. If \fInt\fR is not specified, it defaults to the value
+\fI2**nt\fR bytes. If \fInt\fR is not specified, it defaults to the value
given for \fInr\fR. Values in the range 8 to 15 may be used for
\fInr\fR and \fInt\fR; larger values give better compression but
consume more kernel memory for compression dictionaries.
requests Deflate compression in preference to BSD-Compress
if the peer can do either.)
.TP
-.B \-deflate
-Disables Deflate compression; \fBpppd\fR will not request or agree to
-compress packets using the Deflate scheme.
-.TP
.B demand
Initiate the link only on demand, i.e. when data traffic is present.
With this option, the remote IP address must be specific by the user
connect to the peer and perform negotiation, authentication, etc.
When this is completed, \fBpppd\fR will commence passing data packets
(i.e., IP packets) across the link. The persist, idle and holdoff
-options are often useful in conjuction with this option.
-.B -detach
-Don't fork to become a background process (otherwise
-.I pppd
-will do so if a serial device other than its controlling terminal is
-specified).
-.TP
-.B ms-dns \fI<addr>
-If
-.I pppd
-is acting as a server for Microsoft Windows clients, this option
-allows
-.I 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.
+options are often useful in conjuction with this option. (Note that
+this option does \fInot\fR imply the persist option.)
.TP
.B domain \fI<d>
Append the domain name <d> to the local host name for authentication
.B idle \fI<n>
Specifies that \fBpppd\fR should disconnect if it is idle for
\fI<n>\fR seconds. The link is idle when no data packets (i.e. IP
-packets) are being sent or received.
+packets) are being sent or received. If the \fBactive-filter\fR
+option is given, data packets which are rejected by the specified
+activity filter also count as the link being idle.
.TP
-.B -ip
-Disable IPCP negotiation and IP communication. This option should
-only be required if the peer is buggy and gets confused by requests
-from
-.I pppd
-for IPCP negotiation.
-.TP
-.B +ipx
+.B ipx
Enable the IPXCP and IPX protocols. Under Linux, this is the default
condition if your kernel supports IPX. This option is presently only
supported under Linux.
.TP
-.B -ipx
-Disable the IPXCP and IPX protocols. This option should only be
-required if the peer is buggy and gets confused by requests from
-.I pppd
-for IPXCP negotiation.
-.TP
.B ipcp-accept-local
With this option,
.I pppd
.TP
.B login
Use the system password database for authenticating the peer using
-PAP, and record the user in the system wtmp file.
+PAP, and record the user in the system wtmp file. Note that if the
+/etc/ppp/pap-secrets file exists, the peer must have an entry in that
+file as well as the system password database to be allowed access.
+.TP
+.B maxconnect \fIn
+Terminate the connection after \fIn\fR seconds.
.TP
.B modem
Use the modem control lines. This option is the default. With this
On Ultrix, this option implies hardware
flow control, as for the \fBcrtscts\fR option.
.TP
-.B -mn
-Disable magic number negotiation. With this option,
+.B ms-dns \fI<addr>
+If
.I pppd
-cannot detect a looped-back line.
-.TP
-.B -mru
-Disable MRU [Maximum Receive Unit] negotiation. With this option,
-\fIpppd\fR will use the default MRU value of 1500 bytes.
+is acting as a server for Microsoft Windows clients, this option
+allows
+.I 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.
.TP
.B name \fI<n>
Set the name of the local system for authentication purposes to <n>.
.TP
+.B netmask \fI<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.
+.TP
+.B noaccomp
+Disable Address/Control compression in both directions (send and
+receive).
+.TP
+.B nobsdcomp
+Disables BSD-Compress compression; \fBpppd\fR will not request or
+agree to compress packets using the BSD-Compress scheme.
+.TP
+.B noccp
+Disable CCP (Compression Control Protocol) negotiation. This option
+should only be required if the peer is buggy and gets confused by
+requests from
+.I pppd
+for CCP negotiation.
+.TP
+.B nocrtscts
+Disable hardware flow control (i.e. RTS/CTS) on the serial port. If
+neither the \fBcrtscts\fR nor the \fB\-crtscts\fR option is given,
+the hardware flow control setting for the serial port is left
+unchanged.
+.TP
+.B nodefaultroute
+Disable the \fBdefaultroute\fR option. The system administrator who
+wishes to prevent users from creating default routes with \fIpppd\fR
+can do so by placing this option in the /etc/ppp/options file.
+.TP
+.B nodeflate
+Disables Deflate compression; \fBpppd\fR will not request or agree to
+compress packets using the Deflate scheme.
+.TP
+.B nodetach
+Don't detach from the controlling terminal. Without this option, if a
+serial device other than the terminal on the standard input is
+specified,
+.I pppd
+will fork to become a background process.
+.TP
+.B noip
+Disable IPCP negotiation and IP communication. This option should
+only be required if the peer is buggy and gets confused by requests
+from
+.I pppd
+for IPCP negotiation.
+.TP
.B noipdefault
Disables the default behaviour when no local IP address is specified,
which is to determine (if possible) the local IP address from the
address during IPCP negotiation (unless it specified explicitly on the
command line or in an options file).
.TP
-.B -p
-Same as the
-.B passive
-option.
+.B noipx
+Disable the IPXCP and IPX protocols. This option should only be
+required if the peer is buggy and gets confused by requests from
+.I pppd
+for IPXCP negotiation.
+.TP
+.B nomagic
+Disable magic number negotiation. With this option,
+.I pppd
+cannot detect a looped-back line. This option should only be needed
+if the peer is buggy.
+.TP
+.B nopcomp
+Disable protocol field compression negotiation in both the receive and
+the transmit direction.
+.TP
+.B nopredictor1
+Do not accept or agree to Predictor-1 comprssion.
+.TP
+.B noproxyarp
+Disable the \fBproxyarp\fR option. The system administrator who
+wishes to prevent users from creating proxy ARP entries with
+\fIpppd\fR can do so by placing this option in the /etc/ppp/options
+file.
.TP
-.B +pap
-Require the peer to authenticate itself using PAP.
+.B novj
+Disable Van Jacobson style TCP/IP header compression in both the
+transmit and the receive direction.
.TP
-.B -pap
-Don't agree to authenticate using PAP.
+.B novjccomp
+Disable the connection-ID compression option in Van Jacobson style
+TCP/IP header compression. With this option, \fIpppd\fR will not omit
+the connection-ID byte from Van Jacobson compressed TCP/IP headers,
+nor ask the peer to do so.
.TP
.B papcrypt
Indicates that all secrets in the /etc/ppp/pap-secrets file which
will wait for the peer to authenticate itself with PAP to
<n> seconds (0 means no limit).
.TP
-.B -pc
-Disable protocol field compression negotiation (use default, i.e.
-protocol field compression disabled).
-.TP
.B persist
Do not exit after a connection is terminated; instead try to reopen
the connection.
have been compressed using Predictor-1 compression. This option will
be ignored unless Predictor-1 code has been loaded into the kernel.
.TP
-.B -predictor1
-Do not accept or agree to Predictor-1 comprssion.
-.TP
.B proxyarp
Add an entry to this system's ARP [Address Resolution Protocol] table
with the IP address of the peer and the Ethernet address of this
system.
.TP
-.B \-proxyarp
-Disable the \fBproxyarp\fR option. The system administrator who
-wishes to prevent users from creating proxy ARP entries with
-\fIpppd\fR can do so by placing this option in the /etc/ppp/options
-file.
-.TP
.B remotename \fI<n>
Set the assumed name of the remote system for authentication purposes
to <n>.
.TP
-.B +ua \fI<p>
-Agree to authenticate using PAP [Password Authentication Protocol] if
-requested by the peer, and
-use the data in file <p> for the user and password to send to the
-peer. The file contains the remote user name, followed by a newline,
-followed by the remote password, followed by a newline. This option
-is obsolescent.
+.B refuse-chap
+With this option, \fIpppd\fR will not agree to authenticate itself
+to the peer using CHAP.
+.TP
+.B refuse-pap
+With this option, \fIpppd\fR will not agree to authenticate itself
+to the peer using PAP.
+.TP
+.B require-chap
+Require the peer to authenticate itself using CHAP [Cryptographic
+Handshake Authentication Protocol] authentication.
+.TP
+.B require-pap
+Require the peer to authenticate itself using PAP [Password
+Authentication Protocol] authentication.
+.TP
+.B silent
+With this option,
+.I 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 \fIpppd\fR).
.TP
.B usehostname
Enforce the use of the hostname as the name of the local system for
authentication purposes (overrides the
.B name
-option).
+option). This option can be useful in the /etc/ppp/options file.
.TP
.B user \fI<u>
Set the user name to use for authenticating this machine with the peer
using PAP to <u>.
.TP
-.B -vj
-Disable negotiation of Van Jacobson style TCP/IP header compression (use
-default, i.e. no compression).
-.TP
-.B -vjccomp
-Disable the connection-ID compression option in Van Jacobson style
-TCP/IP header compression. With this option, \fIpppd\fR will not omit
-the connection-ID byte from Van Jacobson compressed TCP/IP headers,
-nor ask the peer to do so.
-.TP
.B vj-max-slots \fIn
Sets the number of connection slots to be used by the Van Jacobson
TCP/IP header compression and decompression code to \fIn\fR, which
must be between 2 and 16 (inclusive).
.TP
+.B welcome \fIscript
+Run the executable or shell command specified by \fIscript\fR before
+initiating PPP negotiation, after the connect script (if any) has
+completed.
+.TP
.B xonxoff
Use software flow control (i.e. XON/XOFF) to control the flow of data on
the serial port. This option is only implemented on Linux systems
.SH OPTIONS FILES
Options can be taken from files as well as the command line.
.I pppd
-reads options from the files /etc/ppp/options and ~/.ppprc before
-looking at the command line. An options file is parsed into a series
-of words, delimited by whitespace. Whitespace can be included in a
-word by enclosing the word in quotes ("). A backslash (\\) quotes the
-following character. A hash (#) starts a comment, which continues
-until the end of the line.
+reads options from the files /etc/ppp/options, ~/.ppprc and
+/etc/ppp/options.\fIttyname\fR before processing the options on the
+command line. (In fact, the command-line options are scanned to find
+the terminal name before the options.\fIttyname\fR file is read.) In
+forming the name of the options.\fIttyname\fR file, the initial /dev/
+is removed from the terminal name, and any remaining / characters are
+replaced with dots.
+.PP
+An options file is parsed into a series of words, delimited by
+whitespace. Whitespace can be included in a word by enclosing the
+word in quotes ("). A backslash (\\) quotes the following character.
+A hash (#) starts a comment, which continues until the end of the
+line.
.SH AUTHENTICATION
.I pppd
provides system administrators with sufficient access control that PPP
.LP
The default behaviour of
.I pppd
-is to agree to authenticate if requested, and to not
-require authentication from the peer. However,
+is to agree to authenticate if requested, and to not require
+authentication from the peer. However,
.I pppd
-will not agree to
-authenticate itself with a particular protocol if it has no secrets
-which could be used to do so.
+will not agree to authenticate itself with a particular protocol if it
+has no secrets which could be used to do so.
.LP
Authentication is based on secrets, which are selected from secrets
files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP).
for several combinations of server (authenticating peer) and client
(peer being authenticated). Note that
.I pppd
-can be both a server
-and client, and that different protocols can be used in the two
-directions if desired.
+can be both a server and client, and that different protocols can be
+used in the two directions if desired.
.LP
A secrets file is parsed into words as for a options file. A secret
is specified by a line containing at least 3 words, in the order
-client name, server name, secret. Any following words on the same line are
-taken to be a list of acceptable IP addresses for that client. If
-there are only 3 words on the line, it is assumed that any IP address
-is OK; to disallow all IP addresses, use "-". If the secret starts
-with an `@', what follows is assumed to be the name of a file from
-which to read the secret. A "*" as the client or server name matches
-any name. When selecting a secret, \fIpppd\fR takes the best match, i.e.
-the match with the fewest wildcards.
+client name, server name, secret. Any following words on the same
+line are taken to be a list of acceptable IP addresses for that
+client. If there are only 3 words on the line, it is assumed that any
+IP address is OK; to disallow all IP addresses, use "-". A word
+starting with "!" indicates that the specified address is \fInot\fR
+acceptable. An address may be followed by "/" and a number \fIn\fR,
+to indicate a whole subnet, i.e. all addresses which have the same
+value in the most significant \fIn\fR bits.
+.LP
+If the
+secret starts with an `@', what follows is assumed to be the name of a
+file from which to read the secret. A "*" as the client or server
+name matches any name. When selecting a secret, \fIpppd\fR takes the
+best match, i.e. the match with the fewest wildcards.
.LP
Thus a secrets file contains both secrets for use in authenticating
other hosts, plus secrets which we use for authenticating ourselves to
.LP
When authenticating ourselves using PAP, there is also a `username'
which is the local name by default, but can be set with the \fBuser\fR
-option or the \fB+ua\fR option.
+option.
.LP
The remote name is set as follows:
.TP 3
.B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
Process-ID for \fIpppd\fR process on ppp interface unit \fIn\fR.
.TP
+.B /etc/ppp/auth-up
+A program or script which is executed after the remote system
+successfully authenticates itself. It is executed with the parameters
+.IP
+\fIinterface-name peer-name user-name tty-device speed\fR
+.IP and with its standard input, output and error redirected to
+\fB/dev/null\fR. This program or script is executed with the real and
+effective user-IDs set to \fBroot\fR, and with an empty environment.
+.TP
+.B /etc/ppp/auth-down
+A program or script which is executed when the link goes down, if
+/etc/ppp/auth-up was previously executed. It is executed in the same
+manner with the same parameters as /etc/ppp/auth-up.
+.TP
.B /etc/ppp/ip-up
A program or script which is executed when the link is available for
sending and receiving IP packets (that is, IPCP has come up). It is
executed with the parameters
.IP
\fIinterface-name tty-device speed local-IP-address
-remote-IP-address\fR
+remote-IP-address ipparam\fR
.IP
and with its standard input,
output and error streams redirected to \fB/dev/null\fR.
.IP
-This program or script is executed with the same real and effective
-user-ID as \fIpppd\fR, that is, at least the effective user-ID and
-possibly the real user-ID will be \fBroot\fR. This is so that it can
+This program or script is executed with the real and effective
+user-IDs set to \fBroot\fR. This is so that it can
be used to manipulate routes, run privileged daemons (e.g.
\fBsendmail\fR), etc. Be careful that the contents of the
/etc/ppp/ip-up and /etc/ppp/ip-down scripts do not compromise your
system's security.
+.IP
+This program or script is executed with an empty environment, so you
+must either specify a PATH or use full pathnames (e.g. \fI/sbin/route\fR,
+as opposed to \fIroute\fR).
.TP
.B /etc/ppp/ip-down
A program or script which is executed when the link is no longer
available for sending and receiving IP packets. This script can be
used for undoing the effects of the /etc/ppp/ip-up script. It is
-invoked with the same parameters as the ip-up script, and the same
-security considerations apply, since it is executed with the same
-effective and real user-IDs as \fIpppd\fR.
+invoked in the same manner and with the same parameters as the ip-up
+script, and the same security considerations apply.
.TP
.B /etc/ppp/ipx-up
A program or script which is executed when the link is available for
RIP NLSP to indicate that both RIP/SAP and NLSP should be used
.br
.IP
-This program or script is executed with the same real and effective
-user-ID as \fIpppd\fR, that is, at least the effective user-ID and
-possibly the real user-ID will be \fBroot\fR. This is so that it can
-be used to manipulate routes, run privileged daemons (e.g.
-\fBripd\fR), etc. Be careful that the contents of the
-/etc/ppp/ipx-up and /etc/ppp/ipx-down scripts do not compromise your
-system's security.
+This program or script is executed with the real and effective
+user-IDs set to \fBroot\fR, and with an empty environment. This is so
+that it can be used to manipulate routes, run privileged daemons (e.g.
+\fBripd\fR), etc. Be careful that the contents of the /etc/ppp/ipx-up
+and /etc/ppp/ipx-down scripts do not compromise your system's
+security.
.TP
.B /etc/ppp/ipx-down
A program or script which is executed when the link is no longer
available for sending and receiving IPX packets. This script can be
used for undoing the effects of the /etc/ppp/ipx-up script. It is
-invoked with the same parameters as the ipx-up script, and the same
-security considerations apply, since it is executed with the same
-effective and real user-IDs as \fIpppd\fR.
+invoked in the same manner and with the same parameters as the ipx-up
+script, and the same security considerations apply.
.TP
.B /etc/ppp/pap-secrets
Usernames, passwords and IP addresses for PAP authentication.
.TP
.B /etc/ppp/options.\fIttyname
System default options for the serial port being used, read after
-command-line options. In forming the \fIttyname\fR part of this
+~/.ppprc. In forming the \fIttyname\fR part of this
filename, an initial /dev/ is stripped from the port name (if
present), and any slashes in the remaining part are converted to
dots.
This signal causes \fBpppd\fR to terminate the link, restore the
serial device settings, and close the serial device. If the
\fBpersist\fR option has been specified, \fBpppd\fR will try to reopen
-the serial device and start another connection. Otherwise \fBpppd\fR
-will exit.
+the serial device and start another connection (after the holdoff
+period). Otherwise \fBpppd\fR will exit. If this signal is received
+during the holdoff period, it causes \fBpppd\fR to end the holdoff
+period immediately.
.TP
.B SIGUSR2
This signal causes
projects / ppp.git / blobdiff