1vgetty(8)                        vgetty manual                       vgetty(8)
2
3
4

NAME

6       vgetty - voice extension to the mgetty+sendfax program
7
8

SYNOPSIS

10       vgetty [options] ttydevice
11
12       vgetty is not meant to be run from the command line.
13
14       Systems with SysV initscripts should start vgetty from the /etc/inittab
15       file so it can respawn after each  call.  Here  is  a  typical  inittab
16       entry:
17
18       S0:345:respawn:/usr/local/sbin/vgetty ttyS0
19
20       If  you  already have a line in your inittab file which invokes mgetty,
21       replace it with vgetty, since it replaces/extends its functionality.
22
23       systemd - vgetty contains vgetty@.service unit  file  template.  It  is
24       possible  to  enable  an  instance  of  a vgetty to run on a particular
25       device  (e.g.  systemctl   enable   vgetty@ttyS0.service).   See   sys‐
26       temd.unit(5) for further details.
27

DESCRIPTION

29       vgetty  is an extension to the mgetty+sendfax program which provides an
30       interface to voice-capable modems. Use it to operate your  modem  as  a
31       simple  answering machine or build your own sophisticated voice messag‐
32       ing system.  vgetty handles all  the  voice-modem  specific  protocols,
33       giving application programs a uniform, modem-independent voice library.
34       Supported   modems   include   many   common   serial    modems    from
35       3com/USRobotics,  Elsa,  Multitech,  ZyXEL,  and others.  Caller ID and
36       Distinctive Ring are supported provided you have  subscribed  to  these
37       services  from  your  phone company.  Software-based modems (winmodems)
38       are not supported.
39
40       vgetty comes with tools to convert au/wav/voc sound files  to/from  the
41       format  used  by  most supported modems. Basic editing and filtering of
42       sound files is included as well. See pvf(1) for more information.
43

OPTIONS

45       vgetty accepts the same options as mgetty.  The one's relevant to voice
46       mode  are  given here.  See mgetty(8) for other options related to data
47       and fax modes.
48
49       -a     Use autobauding (change port  speed  to  modem  CONNECT  speed).
50              There is no voice modem that needs this, the option is just doc‐
51              umented for completeness.
52
53       -m 'expect send ...'
54              Set the chat sequence that is used to initialize the modem.  For
55              an  empty  expect part, use empty double quotes ("").  Since the
56              sequence contains spaces, you will have to enclose all of it  in
57              single quotes (''). Example:
58
59              vgetty -m '"" ATH0 OK'
60
61       -n <rings>
62              Set the number of rings after which vgetty will answer the phone
63
64       -s <speed>
65              Set  the  serial port speed to use, e.g. "-s 38400". This is the
66              speed  of  communication  between  the  computer  and  modem  in
67              bits/sec (baud).
68
69       -x <log level>
70              Set  the log verbosity level. Zero (0) means no logging, six (6)
71              is really noisy. Use level six (6) when sending problem  reports
72              to the maintainer. The log file is /var/log/vgetty.ttyXX.
73

ENVIRONMENT

75       vgetty  sets  the following environment variables when calling external
76       programs:
77
78       CALLER_ID
79              The caller's telephone number.
80
81       CALLED_ID
82              The number the caller has dialed. Useful for ISDN with  multiple
83              incoming phone numbers on the same physical line.
84
85       CONNECT
86              The   connect   string   as   reported   by   the   modem  (e.g.
87              "38400/V.32bis/V.42bis ... ", etc.).
88
89       DEVICE The tty device being used (e.g. "ttyS0").  Useful  for  handling
90              multiple  devices ("messages on this line are for work, messages
91              on the other line are personal").
92

RESOURCES

94       vgetty is included in the mgetty+sendfax distribution. For  the  latest
95       release, go to:
96
97       ftp://alpha.greenie.net/mgetty/source
98
99       The vgetty maintainer's home page is at:
100
101       http://www-internal.alphanet.ch/~schaefer/vgetty.html
102
103       Send problem reports to:
104
105       vgetty-maintainer@alphanet.ch
106
107       For information on mgetty, go to:
108
109       http://alpha.greenie.net/mgetty
110
111       The  mgetty  mailing list is at mgetty@muc.de. The mailing list is mir‐
112       rored to the de.alt.comm.mgetty newsgroup.
113

FILES

115       /etc/mgetty+sendfax/voice.conf
116              Main configuration file for vgetty.  Many options here  override
117              the equivalents found in /etc/mgetty+sendfax/mgetty.config
118
119       /etc/nologin.ttyXX
120              If  this  file  exists,  vgetty  will not answer calls on device
121              ttyXX.
122
123       /var/log/vgetty.ttyXX
124              Debug log file for vgetty.
125
126       /var/spool/voice/messages/Index
127              List of greeting messages to use.
128
129       /var/spool/voice/.code
130              Access code for remote playback of messages  using  the  dtmf.sh
131              script
132
133       /var/spool/voice/.flag
134              vgetty touches this file when a new message is received
135
136       /var/spool/voice/.timestamp
137              Used  by the dtmf.sh script to record last time of message play‐
138              back
139
140

DIAGNOSTICS

142       If vgetty doesn't work they way you think  it  should,  check  the  log
143       file.   By  default,  it  is  located in /var/log/vgetty.ttyXX (for the
144       vgetty process handling device ttyXX, e.g. ttyS0).
145

BUGS

147       vgetty supports most standard voice modems, but  many  modems  are  not
148       fully  compliant  with  relevant standards or contain firmware bugs. If
149       you have problems, try upgrading your  modem  to  the  latest  firmware
150       revision.  If  you discover a bug with how vgetty reacts to your modem,
151       please email the maintainer (vgetty-maintainer@alphanet.ch)  describing
152       your  problem.   Include  relevant  excerpts from the log file (set log
153       level to six first), and details about your modem  (including  firmware
154       revision) and operating system.
155

SEE ALSO

157       mgetty(8), pvf(1)
158
160       vgetty  is Copyright (c) 1997-2001 Marc Schaefer (schaefer@alphanet.ch)
161       and many others, before and after.
162
163       This program is free software; you can redistribute it and/or modify it
164       under  the  terms of the GNU General Public License as published by the
165       Free Software Foundation; either version 2 of the License, or (at  your
166       option) any later version.
167
168       This  man page was written by Barry Stewart <bstewart@smyrnacable.net>,
169       and has CVS version: $Id: vgetty.8,v 1.1 2001/12/22 18:43:22 marcs  Exp
170       $
171
172
173
174
175
176
177version 0.60             $Date: 2001/12/22 18:43:22 $                vgetty(8)
Impressum