Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / i4b / man / i4btel.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: i4btel.4,v 1.9 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/man/i4btel.4,v 1.8.2.6 2003/03/13 03:10:59 trhodes Exp $
28 .\" $DragonFly: src/usr.sbin/i4b/man/i4btel.4,v 1.4 2006/02/17 19:40:15 swildner Exp $
29 .\"
30 .\"     last edit-date: [Mon Dec 13 23:13:39 1999]
31 .\"
32 .Dd April 21, 1999
33 .Dt I4BTEL 4
34 .Os
35 .Sh NAME
36 .Nm i4btel
37 .Nd isdn4bsd ISDN B-channel telephony interface driver
38 .Sh FreeBSD SYNOPSIS
39 .Cd pseudo-device \&"i4btel\&" Op count
40 .Sh NetBSD SYNOPSIS
41 none
42 .Sh DESCRIPTION
43 The
44 .Nm
45 driver provides an interface to the B-channel for telephony applications
46 and is currently used by the
47 .Xr isdnd 8
48 for answering machine support. The driver is part of the isdn4bsd package.
49 .Pp
50 The lower six bits of the drivers's minor number is used to specify a
51 unit number, whereas the upper two bits specify a functionality.
52 .Pp
53 Functionality zero is the usual telephony data stream i/o driver.
54 .Pp
55 Functionality one is used to enable commands to dial out and hang up and
56 receive responses about the state of the dial out progress and status.
57 This commands may change in the future, for details see the file
58 .Em i4b_tel_ioctl.h
59 and the
60 .Xr isdnphone 8
61 utility.
62 .Pp
63 The telephony data stream comes out of the line in a bit-reversed format,
64 so the
65 .Nm
66 driver does the bit-reversion process in any case.
67 .Pp
68 Additionally, the user can specify to do A-law to u-law, u-law to A-law
69 or no conversion at all in the i4btel driver by using the
70 .Xr isdntelctl 8
71 utility.
72 .Pp
73 The driver is able to process several ioctl's:
74 .Pp
75 .Bl -tag -width Ds -compact -offset indent
76 .It Ar I4B_TEL_GETAUDIOFMT
77 get currently used audio format conversion.
78 .It Ar I4B_TEL_SETAUDIOFMT
79 set currently used audio format conversion.
80 .It Ar I4B_TEL_EMPTYINPUTQUEUE
81 clear the input queue.
82 .El
83 .Pp
84 For the I4B_TEL_GETAUDIOFMT and I4B_TEL_SETAUDIOFMT, the following
85 parameters are available:
86 .Pp
87 .Bl -tag -width Ds -compact -offset indent
88 .It Ar CVT_NONE
89 do no A-law/u-law audio format conversion.
90 The conversion path looks like this:
91 .Pp
92 USER <--> bitreversing <--> ISDN-line
93 .Pp
94 .It Ar CVT_ALAW2ULAW
95 set set audio format conversion to do an audio conversion from A-law
96 (on the ISDN line) to u-law (in the userland).
97 The
98 .Xr read 2
99 conversion path looks like this:
100 .Pp
101 USER <-- u-law/A-law <-- bitreversing <-- ISDN-line
102 .Pp
103 and the
104 .Xr write 2
105 conversion path looks like this:
106 .Pp
107 USER --> u-law/A-law --> bitreversing --> ISDN-line
108 .Pp
109 .It Ar CVT_ULAW2ALAW
110 set set audio format conversion to do an audio conversion from u-law
111 (on the ISDN line) to A-law (in the userland).
112 The
113 .Xr read 2
114 conversion path looks like this:
115 .Pp
116 USER <-- A-law/u-law <-- bitreversing <-- ISDN-line
117 .Pp
118 and the
119 .Xr write 2
120 conversion path looks like this:
121 .Pp
122 USER --> A-law/u-law --> bitreversing --> ISDN-line
123 .Pp
124 .El
125 .Sh SEE ALSO
126 .Xr g711conv 1 ,
127 .Xr isdnd.rc 5 ,
128 .Xr isdnd 8 ,
129 .Xr isdnphone 8 ,
130 .Xr isdntelctl 8
131 .Sh STANDARDS
132 A-Law and u-Law are specified in ITU Recommendation G.711.
133 .Sh AUTHORS
134 The
135 .Nm
136 device driver and this manpage were written by
137 .An Hellmuth Michaelis Aq hm@FreeBSD.org .