Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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 .\" $DragonFly: src/usr.sbin/i4b/man/i4bipr.4,v 1.2 2003/06/17 04:29:55 dillon Exp $
29 .\"
30 .\"     last edit-date: [Mon Dec 13 23:10:25 1999]
31 .\"
32 .Dd July 6, 1998
33 .Dt I4BIPR 4
34 .Os
35 .Sh NAME
36 .Nm i4bipr
37 .Nd isdn4bsd IP over ISDN B-channel network driver
38 .Sh FreeBSD SYNOPSIS
39 .Cd pseudo-device \&"i4bipr\&" Op count
40 .Sh NetBSD SYNOPSIS
41 none
42 .Sh DESCRIPTION
43 The
44 .Nm
45 driver interfaces the IP subsystem of the operating system with the
46 isdn4bsd package so that transport of IP packets over an ISDN link
47 is possible.
48 .Pp
49 The driver just packs IP packets without anything appended or prepended
50 into raw HDLC packets on the B channel and transfers them to a remote site.
51 IP packets received from the remote site are queued into the local IP
52 protocol stack.
53 .Pp
54 The format of the resulting packet on the B channel is:
55 .Pp
56 .Dl (HDLC opening flag) (IP-packet) (CRC) (HDLC closing flag)
57 .Pp
58 In the case where an IP packet for a remote site arrives in the driver and no
59 connection has been established yet, the driver communicates with the
60 .Xr isdnd 8
61 daemon to establish a connection.
62 .Pp
63 The driver has support for interfacing to the
64 .Xr bpf 4
65 subsystem for using
66 .Xr tcpdump 1
67 with the
68 .Nm ipr
69 interfaces.
70 .Pp
71 The driver optionally (when compiled with the IPR_VJ option) provides Van
72 Jacobsen header compression, under control of the link0 and link1 options to
73 .Xr ifconfig 8 :
74 .Pp
75 .Bl -tag -width 15n -offset indent -compact
76 .It link0
77 Apply VJ compression to outgoing packets on this interface, and assume that
78 incoming packets require decompression.
79 .It link1
80 Check incoming packets for Van Jacobsen compression; if they appear to be
81 compressed, automatically set link0.
82 .El
83 .Pp
84 The default values are
85 .Em on
86 for
87 .Em link1
88 and
89 .Em off
90 for
91 .Em link0 .
92 .Sh SEE ALSO
93 .Xr tcpdump 1 ,
94 .Xr bpf 4 ,
95 .Xr isdnd.rc 5 ,
96 .Xr isdnd 8
97 .Sh AUTHORS
98 The
99 .Nm
100 device driver and this manpage were written by
101 .An Hellmuth Michaelis Aq hm@FreeBSD.org .