Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / i4b / isdntelctl / isdntelctl.8
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: isdntelctl.8,v 1.9 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/isdntelctl/isdntelctl.8,v 1.8.2.5 2003/03/11 21:13:49 trhodes Exp $
28 .\"
29 .\"     last edit-date: [Mon Dec 13 23:06:45 1999]
30 .\"
31 .Dd April 21, 1999
32 .Dt ISDNTELCTL 8
33 .Os
34 .Sh NAME
35 .Nm isdntelctl
36 .Nd control isdn4bsd telephone sound format conversion
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl c
40 .Op Fl g
41 .Op Fl u Ar unit
42 .Op Fl A
43 .Op Fl U
44 .Op Fl N
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility
49 is part of the isdn4bsd package and is used to configure the sound format
50 conversion facilities of the /dev/i4btel interfaces.
51 .Pp
52 The following options are available:
53 .Bl -tag -width Ds
54 .It Fl c
55 Clear the telephone input queue.
56 .It Fl g
57 Get the sound format currently in use.
58 .It Fl u
59 Set the /dev/i4btel unit number. The default value is zero to access
60 device /dev/i4btel0.
61 .It Fl A
62 Do A-law (ISDN line) -> u-law (userland) conversion.
63 .It Fl U
64 Do u-law (ISDN line) -> A-law (userland) conversion.
65 .It Fl N
66 Set sound conversion to do no format conversion.
67 .El
68 .Pp
69 The telephony data stream comes out of the line in a bit-reversed format,
70 so the
71 .Xr i4btel 4
72 driver does the bit-reversion process in any case.
73 .Pp
74 Additionally, the user can specify to do A-law to u-law, u-law to A-law
75 or no conversion at all in the i4btel driver by using the
76 .Nm
77 utility.
78 .Sh FILES
79 /dev/i4btel<n>
80 .Sh STANDARDS
81 A-Law and u-Law are specified in ITU Recommendation G.711.
82 .Sh EXAMPLES
83 The command:
84 .Bd -literal -offset indent
85 isdntelctl -g
86 .Ed
87 .Pp
88 displays the currently used sound format for device /dev/i4btel0.
89 .Sh SEE ALSO
90 .Xr g711conv 1 ,
91 .Xr i4btel 4 ,
92 .Xr isdnd.rc 5 ,
93 .Xr isdnd 8
94 .Sh AUTHORS
95 The
96 .Nm
97 utility and this manpage were written by
98 .An Hellmuth Michaelis Aq hm@kts.org .