diff options
Diffstat (limited to 'man/ivam-voicebox.1.xml.in')
| -rw-r--r-- | man/ivam-voicebox.1.xml.in | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/man/ivam-voicebox.1.xml.in b/man/ivam-voicebox.1.xml.in new file mode 100644 index 0000000..ce8d802 --- /dev/null +++ b/man/ivam-voicebox.1.xml.in @@ -0,0 +1,126 @@ +<?xml version="1.0" standalone='no'?> <!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- + This file is part of ivam2. + + ivam2 is free software; you can redistribute it and/or modify it under + the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your + option) any later version. + + ivam2 is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with ivam2; if not, write to the Free Software Foundation, + Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +--> + + <manpage name="ivam-voicebox" section="1" desc="Voice box application for ivam2"> + + <synopsis> + <cmd>ivam-voicebox <opt>[options]</opt> <arg>spool_directory</arg></cmd> + </synopsis> + + <description> + <p>ivam-voicebox is a simple voice box application for ivam2. It + operates inside a spool directory which is passed on the command + line. If that directory contains a slash it is taken as absolute + path, if not the spool directory @SPOOLDIR@ is prepended to make + it an absolute path. See <manref name="ivam-spool" section="5"/> + for an explanation of the spool directory layout.</p> + </description> + + <section name="navigating in the voice box"> + <p>If a caller gets into the voice box he will listen to the + welcome message. After that is finished he may record a message + which is saved in the spool directory. During the welcome + message, the caller may press (the DTMF button) 0 to get into + the authentication prompt. There he may enter his PIN to get + into the authenticated area of the voice box. He may browse and + delete previously recorded messages. After login all messages + are played in chronologically reversed order. Pressing 4 or 8 + will play the next newer message, pressing 6 or 2 will play the + next older message, pressing 5 will replay the current message, + pressing 7 will play the newest message, pressing 1 will play + the oldest message and pressing 0 will delete the current + message.</p> + </section> + + <options> + + <option> + <p><opt>--record-time=</opt><arg>RECORDTIME</arg></p> + <optdesc><p> Specify the maximum time in seconds a caller may + record. If you use this option it has precendence over the + option stored in the spool directory. </p></optdesc> + </option> + + <option> + <p><opt>--pin=</opt><arg>PIN</arg></p> + <optdesc><p>Specify the PIN for the voice box. If you use this + option it has precedence over the option stored in the spool + directory. Don't use this option for security reasons: + everyone who has access to the local system may use "ps" to + read the PIN from the command line. User <opt>--pin-file</opt> instead.</p></optdesc> + </option> + + <option> + <p><opt>--pin-file=</opt><arg>PINFILE</arg></p> + <optdesc><p>Specify a file from which the PIN for the voice + box is read. If you use this option it has precedence over the + option stored in the spool directory.</p></optdesc> + </option> + + <option> + <p><opt>--message-program=</opt><arg>PROGRAM</arg></p> + <optdesc><p>Run this program after message recording instead of ./newmessage in the spool directory.</p></optdesc> + </option> + + <option> + <p><opt>--debug</opt></p> + <optdesc><p>Enable debug mode. If enabled, a more detailed + explanation of what is currently done is written to + syslog.</p></optdesc> + </option> + + <option> + <p><opt>--record-only</opt></p> + <optdesc><p>Disable the authenticated area of the voice box.</p></optdesc> + </option> + + <option> + <p><opt>--no-record</opt></p> + <optdesc><p>Disable message recording of the voice + box. Instead change directly to the authentication + prompt.</p></optdesc> + </option> + + </options> + + <section name="Author"> + <p>ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at <url + href="@PACKAGE_URL@"/> + </p> + </section> + + <section name="See also"> + <p> + <manref name="msntab" section="5"/>, <manref name="ivamd" section="8"/>, <manref name="ivam-createvb" section="1"/>, <manref name="ivam-spool" section="5"/>, <manref name="ivam-autobox" section="1"/> + </p> + </section> + + <section name="Comments"> + <p>This man page was written using <manref name="xmltoman" section="1" + href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p> + </section> + + </manpage> |