share/man/man4/ng_rfc1490.4

   1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty, use and
   5 .\" redistribution of this software, in source or object code forms, with or
   6 .\" without modifications are expressly permitted by Whistle Communications;
   7 .\" provided, however, that:
   8 .\" 1. Any and all reproductions of the source or object code must include the
   9 .\"    copyright notice above and the following disclaimer of warranties; and
  10 .\" 2. No rights are granted, in any manner or form, to use Whistle
  11 .\"    Communications, Inc. trademarks, including the mark "WHISTLE
  12 .\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  13 .\"    such appears in the above copyright notice or in the software.
  14 .\"
  15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
  34 .\"
  35 .\" $FreeBSD: src/share/man/man4/ng_rfc1490.4,v 1.11.2.1 2001/12/21 09:00:51 ru Exp $
  36 .\" $Whistle: ng_rfc1490.8,v 1.4 1999/01/25 23:46:27 archie Exp $
  37 .\"
  38 .Dd January 19, 1999
  39 .Dt NG_RFC1490 4
  40 .Os
  41 .Sh NAME
  42 .Nm ng_rfc1490
  43 .Nd RFC 1490 netgraph node type
  44 .Sh SYNOPSIS
  45 .In netgraph/rfc1490/ng_rfc1490.h
  46 .Sh DESCRIPTION
  47 The
  48 .Nm rfc1490
  49 node type performs protocol encapsulation, de-encapsulation, and
  50 multiplexing according to RFC 1490 (which has since been updated by RFC 2427).
  51 This particular type of encapsulation is often used on top of frame relay
  52 DLCI channels.
  53 .Pp
  54 The
  55 .Dv downstream
  56 hook is used to transmit and receive encapsulated frames. On the other
  57 side of the node, the
  58 .Dv inet
  59 and
  60 .Dv ppp
  61 hooks are used to transmit and receive raw IP frames and PPP frames,
  62 respectively. PPP frames are transmitted and received according to
  63 RFC 1973; in particular, frames appearing on the
  64 .Dv ppp
  65 hook begin with the PPP protocol number.
  66 .Pp
  67 Typically the
  68 .Dv inet
  69 hook is connected to the
  70 .Dv inet
  71 hook of an
  72 .Xr ng_iface 4
  73 node.
  74 .Sh HOOKS
  75 This node type supports the following hooks:
  76 .Bl -tag -width foobarbazum
  77 .It Dv downstream
  78 Connects to the RFC 1490 peer entity.
  79 .It Dv inet
  80 Transmits and receives raw IP frames.
  81 .It Dv ppp
  82 Transmits and receives PPP frames.
  83 .El
  84 .Sh CONTROL MESSAGES
  85 This node type only supports the generic control messages.
  86 .Sh SHUTDOWN
  87 This node shuts down upon receipt of a
  88 .Dv NGM_SHUTDOWN
  89 control message, or when all hooks have been disconnected.
  90 .Sh SEE ALSO
  91 .Xr netgraph 4 ,
  92 .Xr ng_frame_relay 4 ,
  93 .Xr ng_iface 4 ,
  94 .Xr ngctl 8
  95 .Rs
  96 .%A C. Brown
  97 .%A A. Malis
  98 .%T "Multiprotocol Interconnect over Frame Relay"
  99 .%O RFC 2427
 100 .Re
 101 .Rs
 102 .%A W. Simpson
 103 .%T "PPP in Frame Relay"
 104 .%O RFC 1973
 105 .Re
 106 .Sh HISTORY
 107 The
 108 .Nm
 109 node type was implemented in
 110 .Fx 4.0 .
 111 .Sh AUTHORS
 112 .An Julian Elischer Aq Mt julian@FreeBSD.org
 113 .Sh BUGS
 114 Not all of RFC 1490 is implemented.