share/man/man4/irip.4

   1 .\" $NetBSD: irip.4,v 1.2 2002/07/29 00:42:56 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\"     $Id: irip.4,v 1.3 2006/07/08 20:51:35 tsutsui Exp $
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .\"     last edit-date: [Mon Dec 13 23:10:25 1999]
  31 .\"
  32 .Dd July 6, 1998
  33 .Dt IRIP 4
  34 .Os
  35 .Sh NAME
  36 .Nm irip
  37 .Nd Raw IP over ISDN network driver
  38 .Sh SYNOPSIS
  39 .Cd "pseudo-device irip" Ar count
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver interfaces the IP subsystem of the operating system with the
  44 ISDN layer so that transport of IP packets over an ISDN link
  45 is possible.
  46 .Pp
  47 The driver just packs IP packets without anything appended or prepended
  48 into raw HDLC packets on the B channel and transfers them to a remote site.
  49 IP packets received from the remote site are queued into the local IP
  50 protocol stack.
  51 .Pp
  52 The format of the resulting packet on the B channel is:
  53 .Pp
  54 .Dl (HDLC opening flag) (IP-packet) (CRC) (HDLC closing flag)
  55 .Pp
  56 In the case where an IP packet for a remote site arrives in the driver and no
  57 connection has been established yet, the driver communicates with the
  58 .Xr isdnd 8
  59 daemon to establish a connection.
  60 .Pp
  61 The driver has support for interfacing to the
  62 .Xr bpf 4
  63 subsystem for using
  64 .Xr tcpdump 8
  65 with the
  66 .Nm
  67 interfaces.
  68 .Pp
  69 The driver optionally (when compiled with the IRIP_VJ option) provides Van
  70 Jacobson header compression, under control of the link0 and link1 options to
  71 .Xr ifconfig 8 :
  72 .Pp
  73 .Bl -tag -width 15n -offset indent -compact
  74 .It link0
  75 Apply VJ compression to outgoing packets on this interface, and assume that
  76 incoming packets require decompression.
  77 .It link1
  78 Check incoming packets for Van Jacobson compression; if they appear to be
  79 compressed, automatically set link0.
  80 .El
  81 .Pp
  82 The default values are
  83 .Em on
  84 for
  85 .Em link1
  86 and
  87 .Em off
  88 for
  89 .Em link0 .
  90 .Sh SEE ALSO
  91 .Xr bpf 4 ,
  92 .Xr isdnd.rc 5 ,
  93 .Xr isdnd 8 ,
  94 .Xr tcpdump 8
  95 .Sh AUTHORS
  96 The
  97 .Nm
  98 device driver and this man page were written by
  99 .An Hellmuth Michaelis Aq hm@kts.org .