Print this page
14249 pseudo-terminal nomenclature should reflect POSIX
Change-Id: Ib4a3cef899ff4c71b09cb0dc6878863c5e8357bc


 858            support is needed.
 859 
 860 
 861        nopredictor1
 862 
 863            Do not accept or agree to Predictor-1 compression. (This option is
 864            accepted for compatibility. The implementation does not support
 865            Predictor-1 compression.)
 866 
 867 
 868        noproxyarp
 869 
 870            Disable the proxyarp option. If you want to prevent users from
 871            creating proxy ARP entries with pppd, place this option in the
 872            /etc/ppp/options file.
 873 
 874 
 875        notty
 876 
 877            Normally, pppd requires a terminal device. With this option, pppd
 878            allocates itself a pseudo-tty master/slave pair and uses the slave
 879            as its terminal device. pppd creates a child process to act as a
 880            character shunt to transfer characters between the pseudo-tty
 881            master and its standard input and output. Thus, pppd transmits
 882            characters on its standard output and receives characters on its
 883            standard input even if they are not terminal devices. This option
 884            increases the latency and CPU overhead of transferring data over
 885            the ppp interface as all of the characters sent and received must
 886            flow through the character shunt process. An explicit device name
 887            may not be given if this option is used.
 888 
 889 
 890        novj
 891 
 892            Disable Van Jacobson style TCP/IP header compression in both the
 893            transmit and the receive direction.
 894 
 895 
 896        novjccomp
 897 
 898            Disable the connection-ID compression option in Van Jacobson style
 899            TCP/IP header compression. With this option, pppd does not omit the
 900            connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
 901            does it ask the peer to do so. This option is unnecessary if novj


 988            is a privileged option. Because there is no guarantee that members
 989            of group-name cannot use pppd to become root themselves, you should
 990            be careful using this option. Consider it equivalent to putting the
 991            members of group-name in the root or sys group.
 992 
 993 
 994        proxyarp
 995 
 996            Add an entry to the system's Address Resolution Protocol (ARP)
 997            table with the IP address of the peer and the Ethernet address of
 998            this system. When you use this option, the peer appears to other
 999            systems to be on the local Ethernet. The remote address on the PPP
1000            link must be in the same subnet as assigned to an Ethernet
1001            interface.
1002 
1003 
1004        pty  script
1005 
1006            Specifies that the command script, and not a specific terminal
1007            device is used for serial communication. pppd allocates itself a
1008            pseudo-tty master/slave pair and uses the slave as its terminal
1009            device. script runs in a child process with the pseudo-tty master
1010            as its standard input and output.  An explicit device name may not
1011            be given if this option is used. (Note: if the record option is
1012            used in conjunction with the pty option, the child process will
1013            have pipes on its standard input and output.)
1014 
1015 
1016        receive-all
1017 
1018            With this option, pppd accepts all control characters from the
1019            peer, including those marked in the receive asyncmap. Without this
1020            option, pppd discards those characters as specified in RFC 1662.
1021            This option should be used only if the peer has bugs, as is often
1022            found with dial-back implementations.
1023 
1024 
1025        record filename
1026 
1027            Directs pppd to record all characters sent and received to a file
1028            named filename. filename is opened in append mode, using the user's
1029            user-ID and permissions. Because this option uses a pseudo-tty and
1030            a process to transfer characters between the pseudo-tty and the
1031            real serial device, it increases the latency and CPU overhead of
1032            transferring data over the PPP interface. Characters are stored in
1033            a tagged format with timestamps that can be displayed in readable
1034            form using the pppdump(1M) program. This option is generally used
1035            when debugging the kernel portion of pppd (especially CCP
1036            compression algorithms) and not for debugging link configuration
1037            problems. See the debug option.
1038 
1039 
1040        remotename name
1041 
1042            Set the assumed name of the remote system for authentication
1043            purposes to name. Microsoft WindowsNT does not provide a system
1044            name in its CHAP Challenge messages, and this option is often used
1045            to work around this problem.
1046 
1047 
1048        refuse-chap
1049 
1050            With this option, pppd will not agree to authenticate itself to the
1051            peer using standard Challenge Handshake Authentication Protocol
1052            (CHAP). (MS-CHAP is not affected.)
1053 
1054 
1055        refuse-mschap
1056 
1057            Do not agree to authenticate to peer with MS-CHAPv1. If this option


1865                            disabled as a result of a fatal decompression
1866                            error. (Fatal decompression errors generally
1867                            indicate a bug in an implementation.)
1868 
1869 
1870 DIAGNOSTICS
1871        Messages are sent to the syslog daemon using facility LOG_DAEMON. To
1872        see error and debug messages, edit the /etc/syslog.conf file to direct
1873        the messages to the desired output device or file, or use the updetach
1874        or logfile options.
1875 
1876 
1877        The debug option causes the contents of all LCP, PAP, CHAP or IPCP
1878        control packets sent or received to be logged. This is useful if PPP
1879        negotiation does not succeed or if authentication fails.
1880 
1881 
1882        Debugging can also be enabled or disabled by sending a SIGUSR1 signal,
1883        which acts as a toggle to the pppd process.
1884 
1885                                November 22, 2021                      PPPD(1M)


 858            support is needed.
 859 
 860 
 861        nopredictor1
 862 
 863            Do not accept or agree to Predictor-1 compression. (This option is
 864            accepted for compatibility. The implementation does not support
 865            Predictor-1 compression.)
 866 
 867 
 868        noproxyarp
 869 
 870            Disable the proxyarp option. If you want to prevent users from
 871            creating proxy ARP entries with pppd, place this option in the
 872            /etc/ppp/options file.
 873 
 874 
 875        notty
 876 
 877            Normally, pppd requires a terminal device. With this option, pppd
 878            allocates itself a pseudo-terminal pair and uses the subsidiary as
 879            its terminal device. pppd creates a child process to act as a
 880            character shunt to transfer characters between the pseudo-terminal
 881            manager and its standard input and output. Thus, pppd transmits
 882            characters on its standard output and receives characters on its
 883            standard input even if they are not terminal devices. This option
 884            increases the latency and CPU overhead of transferring data over
 885            the ppp interface as all of the characters sent and received must
 886            flow through the character shunt process. An explicit device name
 887            may not be given if this option is used.
 888 
 889 
 890        novj
 891 
 892            Disable Van Jacobson style TCP/IP header compression in both the
 893            transmit and the receive direction.
 894 
 895 
 896        novjccomp
 897 
 898            Disable the connection-ID compression option in Van Jacobson style
 899            TCP/IP header compression. With this option, pppd does not omit the
 900            connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
 901            does it ask the peer to do so. This option is unnecessary if novj


 988            is a privileged option. Because there is no guarantee that members
 989            of group-name cannot use pppd to become root themselves, you should
 990            be careful using this option. Consider it equivalent to putting the
 991            members of group-name in the root or sys group.
 992 
 993 
 994        proxyarp
 995 
 996            Add an entry to the system's Address Resolution Protocol (ARP)
 997            table with the IP address of the peer and the Ethernet address of
 998            this system. When you use this option, the peer appears to other
 999            systems to be on the local Ethernet. The remote address on the PPP
1000            link must be in the same subnet as assigned to an Ethernet
1001            interface.
1002 
1003 
1004        pty  script
1005 
1006            Specifies that the command script, and not a specific terminal
1007            device is used for serial communication. pppd allocates itself a
1008            pseudo-terminal pair and uses the subsidiary as its terminal
1009            device. script runs in a child process with the pseudo-terminal
1010            manager as its standard input and output.  An explicit device name
1011            may not be given if this option is used.  (Note: if the record
1012            option is used in conjunction with the pty option, the child
1013            process will have pipes on its standard input and output.)
1014 
1015 
1016        receive-all
1017 
1018            With this option, pppd accepts all control characters from the
1019            peer, including those marked in the receive asyncmap. Without this
1020            option, pppd discards those characters as specified in RFC 1662.
1021            This option should be used only if the peer has bugs, as is often
1022            found with dial-back implementations.
1023 
1024 
1025        record filename
1026 
1027            Directs pppd to record all characters sent and received to a file
1028            named filename. filename is opened in append mode, using the user's
1029            user-ID and permissions. Because this option uses a pseudo-terminal
1030            and a process to transfer characters between the pseudo-terminal
1031            and the real serial device, it increases the latency and CPU
1032            overhead of transferring data over the PPP interface. Characters
1033            are stored in a tagged format with timestamps that can be displayed
1034            in readable form using the pppdump(1M) program. This option is
1035            generally used when debugging the kernel portion of pppd
1036            (especially CCP compression algorithms) and not for debugging link
1037            configuration problems. See the debug option.
1038 
1039 
1040        remotename name
1041 
1042            Set the assumed name of the remote system for authentication
1043            purposes to name. Microsoft WindowsNT does not provide a system
1044            name in its CHAP Challenge messages, and this option is often used
1045            to work around this problem.
1046 
1047 
1048        refuse-chap
1049 
1050            With this option, pppd will not agree to authenticate itself to the
1051            peer using standard Challenge Handshake Authentication Protocol
1052            (CHAP). (MS-CHAP is not affected.)
1053 
1054 
1055        refuse-mschap
1056 
1057            Do not agree to authenticate to peer with MS-CHAPv1. If this option


1865                            disabled as a result of a fatal decompression
1866                            error. (Fatal decompression errors generally
1867                            indicate a bug in an implementation.)
1868 
1869 
1870 DIAGNOSTICS
1871        Messages are sent to the syslog daemon using facility LOG_DAEMON. To
1872        see error and debug messages, edit the /etc/syslog.conf file to direct
1873        the messages to the desired output device or file, or use the updetach
1874        or logfile options.
1875 
1876 
1877        The debug option causes the contents of all LCP, PAP, CHAP or IPCP
1878        control packets sent or received to be logged. This is useful if PPP
1879        negotiation does not succeed or if authentication fails.
1880 
1881 
1882        Debugging can also be enabled or disabled by sending a SIGUSR1 signal,
1883        which acts as a toggle to the pppd process.
1884 
1885                                February 5, 2022                       PPPD(1M)