diff options
Diffstat (limited to 'man/ivam-spool.5.xml.in')
| -rw-r--r-- | man/ivam-spool.5.xml.in | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/man/ivam-spool.5.xml.in b/man/ivam-spool.5.xml.in new file mode 100644 index 0000000..2b87dc1 --- /dev/null +++ b/man/ivam-spool.5.xml.in @@ -0,0 +1,172 @@ +<?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-spool" section="5" desc="ivam2 voice box spool directory"> + + <synopsis> + <cmd>@SPOOLDIR@/SPOOLNAME</cmd> + </synopsis> + + <description> + + <p>This man page describes the layout of a voice box spool + directory as used by <manref name="ivam-autobox" section="1"/> + and <manref name="ivam-voicebox" section="1"/>.</p> + + <p>You may create ivam2 voice box spool directories with the + tool <manref name="createvb" section="1"/></p> + + </description> + + <section name="configuration files"> + + <p>The following files in the voice box spool directory may be used to + adjust configuration options:</p> + + <option> + <p><opt>RECORD_TIME</opt></p> + + <optdesc> + <p>Specify the time in seconds when message recording is stopped. (Default: "60")</p> + </optdesc> + </option> + + <option> + <p><opt>PIN</opt></p> + + <optdesc> + <p>Specify the PIN for the voice box when queried over the + phone line. This should be a string capable of being entered + via DTMF tones, thus consisting of 0-9, *, # only. The + length is up to you. + </p> + + <p>Two special PINs may be set: an empty string disables all + authentication, "-" will deny all authentication attempts.</p> + + <p>(Default: "-")</p> + </optdesc> + </option> + + + <option> + <p><opt>newmessage</opt></p> + + <optdesc> + + <p>This should be a script which is called whenever a new + message is recorded. It is run with a single argument: the + filename of the recorded message. Special environment + variables are passed:</p> + + <p><opt>RINGMSN</opt> The local number of the voice box</p> + + <p><opt>CALLERMSN</opt> The remote number the message + originates from</p> + + <p><opt>LENGTH</opt> The length in bytes of the uncompressed + voice message. Since the sampling rate of the ISDN is fixed + to 8000Hz divide this value by 8000 to get the length in + seconds.</p> + + <p><opt>SEC_LENGTH</opt> The length in seconds of the voice + message written as fixed point number. This is the same as + LENGTH/8000.</p> + + <p><opt>SPOOLDIR</opt> The spool directory where the + configuration of the voice box resides.</p> + </optdesc> + + </option> + + <option> + <p><opt>EMAIL</opt></p> + + <optdesc> + <p>Specify the email address of the owner of this voice + box. This address ist notified whenever a new message is + recorded. It is interpreted by the default newmessage + script. If you change that script this file may become + useless. (Defaults: "root")</p> + </optdesc> + </option> + + <option> + + <p><opt>*.ulaw.gz</opt></p> + + <optdesc> + + <p>These are audio files which are used by the voice box + automaton. You may replace them with your own + recordings.</p> + + <p>welcome.ulaw.gz - The welcome message</p> + <p>authok.ulaw.gz - "Authentication successful"</p> + <p>beep.ulaw.gz - A beep</p> + <p>nomoremessages.ulaw.gz - "No more messages available"</p> + <p>auth.ulaw.gz - "Please authenticate"</p> + <p>empty.ulaw.gz - "The voice box is empty"</p> + <p>removed.ulaw.gz - "Message deleted successfully"</p> + + </optdesc> + + </option> + + <option> + <p><opt>messages/</opt></p> + + <optdesc> + <p>This is not a configuration item but where the recorded + messages are stored. You are free to delete any message from + the voice box by issuing standard Unix commands like 'rm' + inside this directory. The file names inside the directory + include the Unix time, the local number and the originating + number seperated by colons.</p> + </optdesc> + + </option> + + </section> + + <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="ivamd" section="8"/>, <manref name="ivam-voicebox" section="8"/>, <manref name="createcb" 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> |