share/man/man4/ppp.4

   1 .\"     $NetBSD: ppp.4,v 1.12 2005/01/10 18:03:37 hubertf Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     From:   @(#)lo.4        8.1 (Berkeley) 6/5/93
  31 .\"
  32 .Dd January 10, 2005
  33 .Dt PPP 4
  34 .Os
  35 .Sh NAME
  36 .Nm ppp
  37 .Nd point to point protocol network interface
  38 .Sh SYNOPSIS
  39 .Cd options PPP_BSDCOMP
  40 .Cd options PPP_DEFLATE
  41 .Cd options PPP_FILTER
  42 .Pp
  43 .Cd pseudo-device ppp
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 interface allows serial lines to be used as network interfaces using the
  48 .Em Point-to-Point Protocol
  49 (PPP).
  50 The
  51 .Nm
  52 interface can use various types of compression and has many features
  53 over the SLIP protocol used by the
  54 .Xr sl 4
  55 interface.
  56 .Pp
  57 Supported options are:
  58 .Bl -tag -width 20n -compact
  59 .It Cd options PPP_BSDCOMP
  60 Enable support for BSD-compress (`bsdcomp') compression in ppp.
  61 .It Cd options PPP_DEFLATE
  62 Enable support for deflate compression in ppp.
  63 .It Cd options PPP_FILTER
  64 This option turns on
  65 .Xr pcap 3
  66 based filtering for ppp connections.
  67 This option is used by
  68 .Xr pppd 8
  69 which needs to be compiled with
  70 .Em PPP_FILTER
  71 defined (the current default).
  72 .El
  73 .Sh DIAGNOSTICS
  74 .Bl -diag
  75 .It ppp%d: af%d not supported .
  76 The interface was handed
  77 a message with addresses formatted in an unsuitable address
  78 family; the packet was dropped.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr inet 4 ,
  82 .Xr intro 4 ,
  83 .Xr sl 4 ,
  84 .Xr pppd 8 ,
  85 .Xr pppstats 8
  86 .Rs
  87 .%R RFC 1661
  88 .%D July 1994
  89 .%T "The Point-to-Point Protocol (PPP)"
  90 .Re
  91 .Sh HISTORY
  92 The
  93 .Nm
  94 device appeared in
  95 .Nx 1.0 .
  96 .Sh BUGS
  97 Currently, only the
  98 .Xr ip 4
  99 and
 100 .Xr ip6 4
 101 protocols are supported.