Sync usage with man page.
[netbsd-mini2440.git] / usr.sbin / isdn / isdntel / isdntel.8
blobdc3284cfe71b4176f7aeb65d202913bd5068fc56
1 .\" $NetBSD: isdntel.8,v 1.4 2002/02/08 01:38:49 ross Exp $
2 .\"
3 .\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\"     last edit-date: [Mon Dec 13 23:05:59 1999]
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .\"     $Id: isdntel.8,v 1.5 2002/07/29 01:05:37 wiz Exp $
31 .\"
32 .Dd July 11, 1998
33 .Dt ISDNTEL 8
34 .Os
35 .Sh NAME
36 .Nm isdntel
37 .Nd isdn4bsd telephone answering management utility
38 .Sh SYNOPSIS
39 .Nm isdntel
40 .Op Fl a Ar aliasfile
41 .Op Fl d Ar spooldir
42 .Op Fl p Ar playcommand
43 .Op Fl t Ar timeout
44 .Sh DESCRIPTION
45 .Nm
46 is used to provide an
47 .Dq answering machine
48 functionality for incoming telephone voice messages.
49 .Pp
50 The following options are supported:
51 .Bl -tag -width Ds
52 .It Fl a
53 Use
54 .Ar aliasfile
55 as the pathname for an aliasfile containing aliases for phone numbers. The
56 default path is
57 .Pa /etc/isdn/isdntel.alias .
58 The format of an alias entry is the number string followed by one or more
59 spaces or tabs. The rest of the line is taken as the alias string. Comments
60 are introduced by a leading blank, tab or
61 .Dq #
62 character.
63 .It Fl d
64 Use
65 .Ar spooldir
66 as the directory where the incoming voice messages are stored by the
67 .Dq answ
68 script called by
69 .Xr isdnd 8 .
70 This defaults to the directory
71 .Pa /var/isdn .
72 The format of a voice message filename is:
73 .Pp
74 .Dl YYMMDDhhmmss-dest_number-source_number-length_in_secs
75 .It Fl p
76 Use
77 .Ar playcommand
78 as the command string to execute for playing a voice message to some audio
79 output facility. The characters
80 .Em %s
81 are replaced by the currently selected filename. The default string is
82 .Em cat %s | alaw2ulaw \*[Gt]/dev/audio
83 .It Fl t
84 The value for
85 .Ar timeout
86 specifies the time in seconds the program rereads the spool directory
87 when there is no keyboard activity.
88 .El
89 .Pp
90 The screen output should be obvious. If in doubt, consult the source.
91 .Sh SEE ALSO
92 .Xr isdntel 4 ,
93 .Xr isdnd.rc 5 ,
94 .Xr isdnd 8
95 .Sh AUTHORS
96 The
97 .Nm
98 utility and this manual page were written by
99 .An Hellmuth Michaelis Aq hm@kts.org .