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