Fix man page cross reference.
[dragonfly.git] / usr.sbin / i4b / man / i4bisppp.4
1 .\"
2 .\" Copyright (c) 1997, 2000 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: i4bisppp.4,v 1.13 2000/08/31 08:45:07 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/man/i4bisppp.4,v 1.7.2.7 2003/03/13 03:10:59 trhodes Exp $
28 .\" $DragonFly: src/usr.sbin/i4b/man/i4bisppp.4,v 1.5 2005/08/04 20:45:57 swildner Exp $
29 .\"
30 .\"     last edit-date: [Thu Aug 31 10:40:17 2000]
31 .\"
32 .Dd August 31, 2000
33 .Dt I4BISPPP 4
34 .Os
35 .Sh NAME
36 .Nm i4bisppp
37 .Nd isdn4bsd synchronous PPP over ISDN B-channel network driver
38 .Sh DragonFly / FreeBSD SYNOPSIS
39 .Cd pseudo-device \&"i4bisppp\&" 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 a transport of IP packets over an ISDN link
47 is possible.
48 .Pp
49 The driver is just a glue layer between Serge Vakulenko's sppp
50 backend and the ISDN4BSD package.
51 .Pp
52 Beginning with i4b version 0.95 (and only for
53 .Fx
54 and
55 .Ns Dx ) ,
56 the sppp subsystem was integrated into the
57 .Nm
58 driver to support more i4b/ISDN specific options. As a consequence it is no
59 longer necessary to add a "options sppp" to your kernel
60 .Xr config 8
61 file. For configuration of the i4bsppp driver, either the
62 .Xr ispppcontrol 8
63 utility is used or it is configured via
64 .Xr isdnd 8
65 and its associated
66 .Xr isdnd.rc 5
67 file.
68 .Pp
69 In case an IP packet for a remote side arrives in the driver and no
70 connection is established yet, the driver communicates with the
71 .Xr isdnd 8
72 daemon to establish a connection.
73 .Pp
74 The driver has support for interfacing to the
75 .Xr bpf 4
76 subsystem for using
77 .Xr tcpdump 1
78 with the
79 .Nm isp
80 interfaces.
81 .Pp
82 The
83 .Xr ispppcontrol 8
84 utility is used to configure all aspects of PPP required to connect to a
85 remote site.
86 .Sh LINK0 and LINK1
87 The
88 .Em link0
89 and
90 .Em link1
91 flags given as parameters to
92 .Xr ifconfig 8
93 have the following meaning for the
94 .Nm isp
95 devices:
96 .Bl -tag -width link0 -compact
97 .Pp
98 .It Li link0
99 wait passively for connection
100 .Pp
101 .It Li link1
102 auto-dial on output
103 .El
104 .Pp
105 The
106 .Em link0
107 and
108 .Em link1
109 flags are set to
110 .Em off
111 by default.
112 .Pp
113 See
114 .Xr sppp 4
115 for a more detailed discussion of the flags,
116 .Sh SEE ALSO
117 .Xr tcpdump 1 ,
118 .Xr bpf 4 ,
119 .Xr sppp 4 ,
120 .Xr isdnd.rc 5 ,
121 .Xr isdnd 8 ,
122 .Xr ispppcontrol 8
123 .Sh AUTHORS
124 .An -nosplit
125 The
126 .Nm
127 device driver was written by
128 .An Joerg Wunsch Aq joerg@FreeBSD.org
129 and then added to ISDN4BSD by
130 .An Gary Jennejohn Aq gj@FreeBSD.org .
131 .Pp
132 This manpage was written by
133 .An Hellmuth Michaelis Aq hm@FreeBSD.org .