Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / i4b / isdntel / isdntel.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 .\"     last edit-date: [Mon Dec 13 23:05:59 1999]
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/isdntel/isdntel.8,v 1.9.2.5 2003/03/11 21:13:49 trhodes Exp $
28 .\"
29 .\"     $Id: isdntel.8,v 1.9 1999/12/13 22:11:55 hm Exp $
30 .\"
31 .Dd July 11, 1998
32 .Dt ISDNTEL 8
33 .Os
34 .Sh NAME
35 .Nm isdntel
36 .Nd isdn4bsd telephone answering management utility
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl a Ar aliasfile
40 .Op Fl d Ar spooldir
41 .Op Fl p Ar playcommand
42 .Op Fl t Ar timeout
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility is used to provide an "answering machine" functionality for incoming
47 telephone voice messages.
48 .Pp
49 The following options are supported:
50 .Bl -tag -width Ds
51 .It Fl a
52 Use
53 .Ar aliasfile
54 as the pathname for an aliasfile containing aliases for phone numbers. The
55 default path is
56 .Em /etc/isdn/isdntel.alias .
57 The format of an alias entry is the number string followed by one or more
58 spaces or tabs. The rest of the line is taken as the alias string. Comments
59 are introduced by a leading blank, tab or "#" character.
60 .It Fl d
61 Use
62 .Ar spooldir
63 as the directory where the incoming voice messages are stored by the
64 "answ" script called by
65 .Xr isdnd 8 .
66 This defaults to the directory
67 .Em /var/isdn .
68 The format of a voice message filename is:
69 .Pp
70 .Dl YYMMDDhhmmss-dest_number-source_number-length_in_secs
71 .It Fl p
72 Use
73 .Ar playcommand
74 as the command string to execute for playing a voice message to some audio
75 output facility. The characters
76 .Em %s
77 are replaced by the currently selected filename. The default string is
78 .Dq Li cat %s \&| alaw2ulaw >/dev/audio .
79 .It Fl t
80 The value for
81 .Ar timeout
82 specifies the time in seconds the program rereads the spool directory
83 when there is no keyboard activity.
84 .El
85 .Pp
86 The screen output should be obvious. If in doubt, consult the source.
87 .Sh SEE ALSO
88 .Xr i4btel 4 ,
89 .Xr isdnd.rc 5 ,
90 .Xr isdnd 8
91 .Sh BUGS
92 Still two or more left.
93 .Sh AUTHORS
94 The
95 .Nm
96 utility and this manual page were written by
97 .An Hellmuth Michaelis Aq hm@kts.org .