home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / ppp115 / pppd_man < prev    next >
Text File  |  1995-11-29  |  35KB  |  846 lines
  1.  
  2.  
  3. PPPD(8)                    Unix Programmer's Manual                    PPPD(8)
  4.  
  5.  
  6. NAME
  7.      pppd - Point to Point Protocol daemon
  8.  
  9. SYNOPSIS
  10.      pppd [ tty_name ] [ speed ] [ options ]
  11.  
  12. DESCRIPTION
  13.  
  14.      The Point-to-Point Protocol (PPP)  provides  a  method  for  transmitting
  15.      datagrams  over  serial  point-to-point  links.  PPP is composed of three
  16.      parts: a  method  for  encapsulating  datagrams  over  serial  links,  an
  17.      extensible  Link  Control Protocol (LCP), and a family of Network Control
  18.      Protocols (NCP) for establishing and configuring different  network-layer
  19.      protocols.
  20.  
  21.      The encapsulation scheme is provided by driver code in the kernel.   pppd
  22.      provides   the   basic  LCP,  authentication  support,  and  an  NCP  for
  23.      establishing and configuring the Internet Protocol (IP)  (called  the  IP
  24.      Control Protocol, IPCP).
  25.  
  26. FREQUENTLY USED OPTIONS
  27.  
  28.      <tty_name>
  29.           Communicate over the named device.  The string "/dev/" is  prepended
  30.           if  necessary.   If  no  device name is given, or if the name of the
  31.           controlling  terminal  is  given,  pppd  will  use  the  controlling
  32.           terminal, and will not fork to put itself in the background.
  33.  
  34.      <speed>
  35.           Set the baud rate to <speed> (a decimal number).  On systems such as
  36.           4.4BSD  and NetBSD, any speed can be specified.  Other systems (e.g.
  37.           SunOS) allow only a limited set of speeds.
  38.  
  39.      asyncmap <map>
  40.           Set the async character map to  <map>.   This  map  describes  which
  41.           control  characters  cannot be successfully received over the serial
  42.           line.  pppd will ask the peer to send these characters as  a  2-byte
  43.           escape  sequence.  The argument is a 32 bit hex number with each bit
  44.           representing a character to escape. Bit 0 (00000001) represents  the
  45.           character  0x00;  bit 31 (80000000) represents the character 0x1f or
  46.           ^_.  If multiple asyncmap options are given,  the  values  are  ORed
  47.           together.   If  no  asyncmap option is given, no async character map
  48.           will be negotiated for the receive direction; the peer  should  then
  49.           escape all control characters.
  50.  
  51.      auth Require the peer to  authenticate  itself  before  allowing  network
  52.           packets to be sent or received.
  53.  
  54.      connect <p>
  55.           Use the executable or shell command specified by <p> to set  up  the
  56.           serial line.  This script would typically use the chat(8) program to
  57.           dial the modem and start the remote ppp session.
  58.  
  59.      crtscts
  60.           Use hardware flow control (i.e. RTS/CTS) to control the flow of data
  61.           on  the serial port.  If neither the crtscts nor the -crtscts option
  62.  
  63.  
  64.                                                                              1
  65.  
  66.  
  67.  
  68. PPPD(8)                    Unix Programmer's Manual                    PPPD(8)
  69.  
  70.  
  71.           is given, the hardware flow control setting for the serial  port  is
  72.           left unchanged.
  73.  
  74.      defaultroute
  75.           Add a default route to the system routing tables, using the peer  as
  76.           the  gateway, when IPCP negotiation is successfully completed.  This
  77.           entry is removed when the PPP connection is broken.
  78.  
  79.      disconnect <p>
  80.           Run the executable or shell command specified by <p> after pppd  has
  81.           terminated the link.  This script could, for example, issue commands
  82.           to the modem to cause it  to  hang  up  if  hardware  modem  control
  83.           signals were not available.
  84.  
  85.      escape xx,yy,...
  86.           Specifies that certain characters should be escaped on  transmission
  87.           (regardless of whether the peer requests them to be escaped with its
  88.           async control character map).  The  characters  to  be  escaped  are
  89.           specified  as  a list of hex numbers separated by commas.  Note that
  90.           almost any character can be specified for the escape option,  unlike
  91.           the  asyncmap  option  which  only  allows  control characters to be
  92.           specified.  The characters which may not be escaped are  those  with
  93.           hex values 0x20 - 0x3f or 0x5e.
  94.  
  95.      file <f>
  96.           Read options from file <f> (the format is described below).
  97.  
  98.      lock Specifies that pppd should create a UUCP-style  lock  file  for  the
  99.           serial device to ensure exclusive access to the device.
  100.  
  101.      mru <n>
  102.           Set the MRU [Maximum Receive Unit] value  to  <n>  for  negotiation.
  103.           pppd  will  ask  the peer to send packets of no more than <n> bytes.
  104.           The minimum MRU value is 128.  The default MRU  value  is  1500.   A
  105.           value  of  296  is  recommended  for slow links (40 bytes for TCP/IP
  106.           header + 256 bytes of data).
  107.  
  108.      mtu <n>
  109.           Set the MTU [Maximum Transmit Unit] value to <n>.  Unless  the  peer
  110.           requests a smaller value via MRU negotiation, pppd will request that
  111.           the kernel networking code send data packets of no more than n bytes
  112.           through the PPP network interface.
  113.  
  114.      netmask <n>
  115.           Set the interface netmask to <n>, a 32 bit netmask in "decimal  dot"
  116.           notation  (e.g.  255.255.255.0).  If this option is given, the value
  117.           specified is ORed with the default netmask.  The default netmask  is
  118.           chosen  based  on  the  negotiated  remote  IP  address;  it  is the
  119.           appropriate network mask for the class of  the  remote  IP  address,
  120.           ORed with the netmasks for any non point-to-point network interfaces
  121.           in the system which are on the same network.
  122.  
  123.      passive
  124.           Enables the "passive" option in the LCP.   With  this  option,  pppd
  125.           will  attempt to initiate a connection; if no reply is received from
  126.           the peer, pppd will then just wait passively for a valid LCP  packet
  127.  
  128.  
  129.                                                                              2
  130.  
  131.  
  132.  
  133. PPPD(8)                    Unix Programmer's Manual                    PPPD(8)
  134.  
  135.  
  136.           from the peer (instead of exiting, as it does without this option).
  137.  
  138.      silent
  139.           With this option, pppd will not transmit LCP packets to  initiate  a
  140.           connection  until  a  valid LCP packet is received from the peer (as
  141.           for the `passive' option with ancient versions of pppd).
  142.  
  143. OPTIONS
  144.  
  145.      <local_IP_address>:<remote_IP_address>
  146.           Set the local and/or remote interface IP addresses.  Either one  may
  147.           be  omitted.   The IP addresses can be specified with a host name or
  148.           in decimal dot notation (e.g.  150.234.56.78).   The  default  local
  149.           address  is  the  (first)  IP  address  of  the  system  (unless the
  150.           noipdefault option is given).  The remote address will  be  obtained
  151.           from  the  peer  if  not  specified  in any option.  Thus, in simple
  152.           cases, this option is not required.  If a  local  and/or  remote  IP
  153.           address  is  specified  with  this  option,  pppd  will not accept a
  154.           different value from the peer in the IPCP  negotiation,  unless  the
  155.           ipcp-accept-local   and/or  ipcp-accept-remote  options  are  given,
  156.           respectively.
  157.  
  158.      -ac  Disable Address/Control compression negotiation (use  default,  i.e.
  159.           address/control field compression disabled).
  160.  
  161.      -all Don't request or allow negotiation of any options for LCP  and  IPCP
  162.           (use default values).
  163.  
  164.      -am  Disable asyncmap negotiation (use the default asyncmap, i.e.  escape
  165.           all control characters).
  166.  
  167.      -as <n>
  168.           Same as asyncmap <n>
  169.  
  170.      bsdcomp nr,nt
  171.           Request that the peer compress packets that it sends, using the BSD-
  172.           Compress  scheme,  with a maximum code size of nr bits, and agree to
  173.           compress packets sent to the peer with a maximum  code  size  of  nt
  174.           bits.   If  nt  is not specified, it defaults to the value given for
  175.           nr.  Values in the range 9 to 15 may be used for nr and  nt;  larger
  176.           values  give  better  compression but consume more kernel memory for
  177.           compression dictionaries.  Alternatively, a value of 0 for