Print this page 
14249 pseudo-terminal nomenclature should reflect POSIX
Change-Id: Ib4a3cef899ff4c71b09cb0dc6878863c5e8357bc
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/pppd.1m
          +++ new/usr/src/man/man1m/pppd.1m
   1    1  '\" te
   2    2  .\" Copyright (c) 1989 Carnegie Mellon University. All rights reserved.
   3    3  .\" Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by Carnegie Mellon University.  The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
   4    4  .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
   5    5  .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Right Reserved.
   6      -.TH PPPD 1M "November 22, 2021"
        6 +.TH PPPD 1M "February 5, 2022"
   7    7  .SH NAME
   8    8  pppd \- point to point protocol daemon
   9    9  .SH SYNOPSIS
  10   10  .nf
  11   11  \fBpppd\fR [\fItty_name\fR] [\fIspeed\fR] [\fIoptions\fR]
  12   12  .fi
  13   13  
  14   14  .SH DESCRIPTION
  15   15  The point-to-point protocol (PPP) provides a method for transmitting datagrams
  16   16  over serial point-to-point links. PPP is composed of three components: a
↓ open down ↓ 1277 lines elided ↑ open up ↑ 
1294 1294  .RE
1295 1295  
1296 1296  .sp
1297 1297  .ne 2
1298 1298  .na
1299 1299  \fB\fBnotty\fR \fR
1300 1300  .ad
1301 1301  .sp .6
1302 1302  .RS 4n
1303 1303  Normally, \fBpppd\fR requires a terminal device. With this option, \fBpppd\fR
1304      -allocates itself a pseudo-tty master/slave pair and uses the slave as its
     1304 +allocates itself a pseudo-terminal pair and uses the subsidiary as its
1305 1305  terminal device. \fBpppd\fR creates a child process to act as a character shunt
1306      -to transfer characters between the pseudo-tty master and its standard input and
1307      -output. Thus, \fBpppd\fR transmits characters on its standard output and
1308      -receives characters on its standard input even if they are not terminal
     1306 +to transfer characters between the pseudo-terminal manager and its standard
     1307 +input and output. Thus, \fBpppd\fR transmits characters on its standard output
     1308 +and receives characters on its standard input even if they are not terminal
1309 1309  devices. This option increases the latency and CPU overhead of transferring
1310 1310  data over the ppp interface as all of the characters sent and received must
1311 1311  flow through the character shunt process. An explicit device name may not be
1312 1312  given if this option is used.
1313 1313  .RE
1314 1314  
1315 1315  .sp
1316 1316  .ne 2
1317 1317  .na
1318 1318  \fB\fBnovj\fR \fR
↓ open down ↓ 180 lines elided ↑ open up ↑ 
1499 1499  .RE
1500 1500  
1501 1501  .sp
1502 1502  .ne 2
1503 1503  .na
1504 1504  \fB\fBpty\fR \fB \fIscript\fR\fR \fR
1505 1505  .ad
1506 1506  .sp .6
1507 1507  .RS 4n
1508 1508  Specifies that the command \fIscript\fR, and not a specific terminal device is
1509      -used for serial communication. \fBpppd\fR allocates itself a pseudo-tty
1510      -master/slave pair and uses the slave as its terminal device. \fIscript\fR runs
1511      -in a child process with the pseudo-tty master as its standard input and output.
1512      -An explicit device name may not be given if this option is used. (Note: if the
1513      -\fBrecord\fR option is used in conjunction with the \fBpty\fR option, the child
1514      -process will have pipes on its standard input and output.)
     1509 +used for serial communication. \fBpppd\fR allocates itself a pseudo-terminal
     1510 +pair and uses the subsidiary as its terminal device. \fIscript\fR runs
     1511 +in a child process with the pseudo-terminal manager as its standard input and
     1512 +output.  An explicit device name may not be given if this option is used.
     1513 +(Note: if the \fBrecord\fR option is used in conjunction with the \fBpty\fR
     1514 +option, the child process will have pipes on its standard input and output.)
1515 1515  .RE
1516 1516  
1517 1517  .sp
1518 1518  .ne 2
1519 1519  .na
1520 1520  \fB\fBreceive-all\fR \fR
1521 1521  .ad
1522 1522  .sp .6
1523 1523  .RS 4n
1524 1524  With this option, \fBpppd\fR accepts all control characters from the peer,
↓ open down ↓ 5 lines elided ↑ open up ↑ 
1530 1530  
1531 1531  .sp
1532 1532  .ne 2
1533 1533  .na
1534 1534  \fB\fBrecord\fR \fB\fIfilename\fR\fR \fR
1535 1535  .ad
1536 1536  .sp .6
1537 1537  .RS 4n
1538 1538  Directs \fBpppd\fR to record all characters sent and received to a file named
1539 1539  \fIfilename\fR. \fIfilename\fR is opened in append mode, using the user's
1540      -user-ID and permissions. Because this option uses a pseudo-tty and a process to
1541      -transfer characters between the pseudo-tty and the real serial device, it
1542      -increases the latency and CPU overhead of transferring data over the PPP
1543      -interface. Characters are stored in a tagged format with timestamps that can be
1544      -displayed in readable form using the \fBpppdump\fR(1M) program. This option is
1545      -generally used when debugging the kernel portion of \fBpppd\fR (especially CCP
1546      -compression algorithms) and not for debugging link configuration problems. See
1547      -the \fBdebug\fR option.
     1540 +user-ID and permissions. Because this option uses a pseudo-terminal and a
     1541 +process to transfer characters between the pseudo-terminal and the real serial
     1542 +device, it increases the latency and CPU overhead of transferring data over the
     1543 +PPP interface. Characters are stored in a tagged format with timestamps that
     1544 +can be displayed in readable form using the \fBpppdump\fR(1M) program. This
     1545 +option is generally used when debugging the kernel portion of \fBpppd\fR
     1546 +(especially CCP compression algorithms) and not for debugging link
     1547 +configuration problems. See the \fBdebug\fR option.
1548 1548  .RE
1549 1549  
1550 1550  .sp
1551 1551  .ne 2
1552 1552  .na
1553 1553  \fB\fBremotename\fR \fB\fIname\fR\fR \fR
1554 1554  .ad
1555 1555  .sp .6
1556 1556  .RS 4n
1557 1557  Set the assumed name of the remote system for authentication purposes to
↓ open down ↓ 1165 lines elided ↑ open up ↑ 
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX