summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2004-01-19 17:49:05 +0000
committerLennart Poettering <lennart@poettering.net>2004-01-19 17:49:05 +0000
commitde699318ba74dfb7a10857c5634e4210c726616b (patch)
tree5c55fa1c98fb9c9c759ad61e0bcdecb4b4ad6104
parente4c3dc5c0d1dc9cdd47fdb4ffb1ac49b9b768e5b (diff)
Documentation finished
git-svn-id: file:///home/lennart/svn/public/ivam2/trunk@43 dbf6933d-3bce-0310-9bcc-ed052ba35b35
-rw-r--r--conf/msntab3
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/README.VoiceBox83
-rw-r--r--doc/README.html.in14
-rw-r--r--man/Makefile.am14
-rw-r--r--man/ivam-autobox.1.xml.in111
-rw-r--r--man/ivam-createvb.1.xml.in69
-rw-r--r--man/ivam-echo.1.xml.in57
-rw-r--r--man/ivam-play.1.xml.in55
-rw-r--r--man/ivam-spool.5.xml.in172
-rw-r--r--man/ivam-voicebox.1.xml.in126
-rw-r--r--man/ivam2.conf.5.xml.in67
-rw-r--r--man/ivamd.8.xml.in6
-rw-r--r--man/msntab.5.xml.in173
14 files changed, 722 insertions, 230 deletions
diff --git a/conf/msntab b/conf/msntab
index 0cfda89..0c5ea5d 100644
--- a/conf/msntab
+++ b/conf/msntab
@@ -26,7 +26,6 @@
# The options defined are:
# rings=n -> specify after how many rings a call should be accepted
# pipehack -> enable the so-called "pipehack" for better latency
-# shbuf -> enable shbuf support
# defaults -> all defaults
# The action field should specify a program to launch for each line, two
@@ -37,6 +36,8 @@
# If no line matches, the call is ignored.
+# See msntab(5) for more information
+
# local MSN remote MSN options action
* * rings=8,pipehack ivam-autobox
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8a8f63f..a773570 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -19,6 +19,8 @@
noinst_DATA = README.html README
EXTRA_DIST = $(noinst_DATA) style.css README.html.in README.VoiceBox REQUIREMENTS TODO
+pkgdata_DATA = README.VoiceBox
+
MAINTAINERCLEANFILES = README README.html
CLEANFILES =
diff --git a/doc/README.VoiceBox b/doc/README.VoiceBox
index 5f76a83..ef01e4e 100644
--- a/doc/README.VoiceBox
+++ b/doc/README.VoiceBox
@@ -1,85 +1,4 @@
-In the voice box spool directory the following files may be used to
-adjust configuration options:
-./RECORD_TIME
-
- Specify the time in seconds when message recording is stopped.
-
- Defaults to "60".
-
-./PIN
-
- 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.
-
- Two special PINs may be set: an empty string disables all
- authentication, "-" will deny all authentication attempts.
-
- Defaults to "-".
-
-./newmessage
-
- 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:
-
- RINGMSN
-
- The local number of the voice box
-
- CALLERMSN
-
- The remote number the message originates from
-
- LENGTH
-
- 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.
-
- SEC_LENGTH
-
- The length in seconds of the voice message
- written as fixed point number. This is the
- same as LENGTH/8000.
-
- SPOOLDIR
-
- The spool directory where the configuration of
- the voice box resides.
-
-./EMAIL
-
- 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 to "root".
-
-./*.ulaw.gz
-
- These are audio files which are used by the voice box
- automaton. You may replace them with your own recordings.
-
- ./welcome.ulaw.gz -- The welcome message
- ./authok.ulaw.gz -- "Authentication successful"
- ./beep.ulaw.gz -- A beep
- ./nomoremessages.ulaw.gz -- "No more messages available"
- ./auth.ulaw.gz -- "Please authenticate"
- ./empty.ulaw.gz -- "The voice box is empty"
- ./removed.ulaw.gz -- "Message deleted successfully"
-
-./messages/
-
- 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.
+See ivam-spool(5) for more information.
$Id$
diff --git a/doc/README.html.in b/doc/README.html.in
index 1128784..bc8197b 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -74,7 +74,19 @@ C.</p>
<h2><a name="documentation">Documentation</a></h2>
-<p>Have a look on the man pages <a href="@PACKAGE_URL@ivamd.8.xml"><tt>ivamd(8)</tt></a>, <a href="@PACKAGE_URL@ivam2.conf.xml"><tt>ivam2.conf(5)</tt></a>, <a href="@PACKAGE_URL@msntab"><tt>msntab(5)</tt></a>, <a href="@PACKAGE_URL@ivam-autobox.1.xml"><tt>ivam-autobox(1)</tt></a>, <a href="@PACKAGE_URL@ivam-voicebox.1.xml"><tt>ivam-voicebox(1)</tt></a>, <a href="@PACKAGE_URL@ivam-echo.1.xml"><tt>ivam-echo(1)</tt></a>, <a href="@PACKAGE_URL@ivam-play.1.xml"><tt>ivam-play(1)</tt></a>, <a href="@PACKAGE_URL@ivam-createvb.1.xml"><tt>ivam-createvb(1)</tt></a>, <a href="@PACKAGE_URL@ivam-spool.1.xml"><tt>ivam-spool(5)</tt></a>. (An XSLT capable browser is required)</p>
+<p>Have a look on the man pages <a
+href="@PACKAGE_URL@ivamd.8.xml"><tt>ivamd(8)</tt></a>, <a
+href="@PACKAGE_URL@ivam2.conf.xml"><tt>ivam2.conf(5)</tt></a>, <a
+href="@PACKAGE_URL@msntab"><tt>msntab(5)</tt></a>, <a
+href="@PACKAGE_URL@ivam-autobox.1.xml"><tt>ivam-autobox(1)</tt></a>,
+<a
+href="@PACKAGE_URL@ivam-voicebox.1.xml"><tt>ivam-voicebox(1)</tt></a>,
+<a href="@PACKAGE_URL@ivam-echo.1.xml"><tt>ivam-echo(1)</tt></a>, <a
+href="@PACKAGE_URL@ivam-play.1.xml"><tt>ivam-play(1)</tt></a>, <a
+href="@PACKAGE_URL@ivam-createvb.1.xml"><tt>ivam-createvb(1)</tt></a>,
+<a
+href="@PACKAGE_URL@ivam-spool.5.xml"><tt>ivam-spool(5)</tt></a>. (An
+XSLT capable browser is required)</p>
<p>The core daemon <tt>ivamd</tt> is configured through both the
command line arguments and the file <tt>msntab</tt>. The latter
diff --git a/man/Makefile.am b/man/Makefile.am
index 3e30491..b1d5708 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -16,23 +16,24 @@
# along with ivam2; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
-SUFFIXES=.xml .xml.in .8 .5 .8.xml .5.xml
+SUFFIXES=.xml .xml.in .8 .5 .8.xml .5.xml .1 .1.xml
pkgsysconfdir=$(sysconfdir)/@PACKAGE@
-man_MANS = ivamd.8 msntab.5
+man_MANS = ivamd.8 msntab.5 ivam2.conf.5 ivam-spool.5 ivam-echo.1 ivam-play.1 ivam-createvb.1 ivam-voicebox.1 ivam-autobox.1
-noinst_DATA = ivamd.8.xml msntab.5.xml
+noinst_DATA = ivamd.8.xml msntab.5.xml ivam2.conf.5.xml ivam-spool.5.xml ivam-echo.1.xml ivam-play.1.xml ivam-createvb.1.xml ivam-voicebox.1.xml ivam-autobox.1.xml
-EXTRA_DIST = $(man_MANS) ivamd.8.xml.in msntab.5.xml.in xmltoman.css xmltoman.xsl xmltoman.dtd
+EXTRA_DIST = $(man_MANS) ivamd.8.xml.in msntab.5.xml.in ivam2.conf.5.xml.in ivam-spool.5.xml.in ivam-echo.1.xml.in ivam-play.1.xml.in ivam-createvb.1.xml.in ivam-voicebox.1.xml.in ivam-autobox.1.xml.in xmltoman.css xmltoman.xsl xmltoman.dtd
-CLEANFILES = ivamd.8.xml msntab.5.xml
+CLEANFILES = ivamd.8.xml msntab.5.xml ivam2.conf.5.xml ivam-spool.5.xml ivam-echo.1.xml ivam-play.1.xml ivam-createvb.1.xml ivam-voicebox.1.xml ivam-autobox.1.xml
.xml.in.xml: Makefile
sed -e 's,@sysconfdir\@,$(sysconfdir),g' \
-e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \
-e 's,@sbindir\@,$(sbindir),g' \
-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+ -e 's,@SPOOLDIR\@,$(SPOOLDIR),g' \
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
if USE_XMLTOMAN
@@ -45,4 +46,7 @@ CLEANFILES += $(man_MANS)
.5.xml.5: Makefile
xmltoman $< > $@
+.1.xml.1: Makefile
+ xmltoman $< > $@
+
endif
diff --git a/man/ivam-autobox.1.xml.in b/man/ivam-autobox.1.xml.in
new file mode 100644
index 0000000..04c8298
--- /dev/null
+++ b/man/ivam-autobox.1.xml.in
@@ -0,0 +1,111 @@
+<?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-autobox <opt>[options]</opt> [<arg>spool_directory</arg>]</cmd>
+ </synopsis>
+
+ <description>
+ <p>ivam-autobox is an extended version of the simple voice box
+ application <manref name="ivam-voicebox" section="1"/>. The main
+ difference is: while you have to create every spool directory
+ prior to run ivam-voicebox on it, your are not required to do
+ this for ivam-autobox. Instead the name of the spool directory
+ is generated from the local phone number of the first call
+ (msn-4711 as an example). If such a spool
+ directory does not exist it is created automatically and the
+ system administrator is notified. Thus: to create voice boxes
+ for a large range of phone numbers at once, just map them all to
+ ivam-autobox and let it do the rest for you.</p>
+
+ <p>The spool directories of ivam-voicebox and ivam-autobox are
+ compatible, in fact both applications share much of the same
+ code. This allows you to use these two applications
+ interchangeably for ivam2 voice box spools.</p>
+
+ <p>You may pass an absolute path as argument to ivam-autobox to
+ be prepended to the local spool names, instead of @SPOOLDIR@.</p>
+
+ <p>Navigation in the voice boxes is identical to
+ ivam-voicebox.</p>
+ </description>
+
+ <options>
+
+ <p>ivam-autobox accepts all the options <manref name="ivam-voicebox" section="1"/> accepts. In addition the following options are accepted:</p>
+
+ <option>
+ <p><opt>--default-record-time=</opt><arg>RECORDTIME</arg></p>
+ <optdesc><p>If a new spool is created use this maximum recording time as default. (Default: 60)</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--default-pin=</opt><arg>PIN</arg></p>
+ <optdesc><p>If a new spool is created use this PIN as
+ default. (Default: "-") 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>--default-pin-file=</opt><arg>PINFILE</arg></p>
+ <optdesc><p>If a new spool is created use the PIN stored in
+ the given file as defaiult.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--notify-script=</opt><arg>PROGRAM</arg></p>
+ <optdesc><p>Run this program after a new voice box has been created. (Default: ivam-newvoicebox)</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--email=</opt><arg>ADDRESS</arg></p>
+ <optdesc><p>Pass this email address to the notification script. (Default: root)</p></optdesc>
+ </option>
+
+ </options>
+
+ <section name="Author">
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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-voicebox" 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>
diff --git a/man/ivam-createvb.1.xml.in b/man/ivam-createvb.1.xml.in
new file mode 100644
index 0000000..d74ca63
--- /dev/null
+++ b/man/ivam-createvb.1.xml.in
@@ -0,0 +1,69 @@
+<?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-createvb" section="1" desc="Create voice box spools for usage with ivam-voicebox or ivam-autobox">
+
+ <synopsis>
+ <cmd>ivam-createvb <arg>SPOOLNAME</arg></cmd>
+ </synopsis>
+
+ <description>
+ <p>ivam-createvb is a simple tool which creates spool
+ directories for usage with <manref name="ivam-voicebox"
+ section="1"/> or <manref name="ivam-autobox" section="1"/>. If
+ the command line argument contains a slash, it is taken as
+ absolute path. If not, @SPOOLDIR@ is prepended to make it an
+ absolute path. ivam-createvb will create the directory and add
+ some configuration files in it, making it a spool directory. If
+ you use <manref name="ivam-voicebox" section="1"/> you have to
+ create each voice box you want to serve with this script. If you
+ use <manref name="ivam-autobox" section="1"/> you may omit this
+ step, since voice boxes are created automatically on an incoming
+ call from the local phone number.</p>
+
+ <p>If you run ivamd as user ivam:ivam you have to change the
+ owners of the created spool directory and all files contained
+ therein to ivam:ivam.</p>
+ </description>
+
+ <section name="Author">
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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-voicebox" section="1"/>, <manref name="ivam-autobox" section="1"/>, <manref name="ivam-spool" section="5"/>
+ </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>
diff --git a/man/ivam-echo.1.xml.in b/man/ivam-echo.1.xml.in
new file mode 100644
index 0000000..2d1d37f
--- /dev/null
+++ b/man/ivam-echo.1.xml.in
@@ -0,0 +1,57 @@
+<?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-echo" section="1" desc="Simple echoing application for ivam2">
+
+ <synopsis>
+ <cmd>ivam-echo</cmd>
+ </synopsis>
+
+ <description>
+ <p>ivam-echo is a simple telephony application for ivam2 which
+ echoes all data from the caller back to the caller. This may be
+ used for testing or latency measuring purposes. Internally this
+ is not much more than a simple call to <manref name="cat" section="1"/>.</p>
+ </description>
+
+ <section name="Author">
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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="cat" section="1"/>, <manref name="ivam-echo" 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>
diff --git a/man/ivam-play.1.xml.in b/man/ivam-play.1.xml.in
new file mode 100644
index 0000000..30b7eb3
--- /dev/null
+++ b/man/ivam-play.1.xml.in
@@ -0,0 +1,55 @@
+<?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-play" section="1" desc="Simple file playback application for ivam2">
+
+ <synopsis>
+ <cmd>ivam-play <arg>FILENAME.ulaw(.gz)</arg></cmd>
+ </synopsis>
+
+ <description>
+ <p>ivam-play is a simple telephony application for ivam2 which
+ plays a .ulaw or .ulaw.gz file to the caller.</p>
+ </description>
+
+ <section name="Author">
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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-echo" 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>
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
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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>
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
+ &lt;@PACKAGE_BUGREPORT@&gt;. 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>
diff --git a/man/ivam2.conf.5.xml.in b/man/ivam2.conf.5.xml.in
new file mode 100644
index 0000000..aabc880
--- /dev/null
+++ b/man/ivam2.conf.5.xml.in
@@ -0,0 +1,67 @@
+<?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="ivam2.conf" section="5" desc="ivam2 configuration file">
+
+ <synopsis>
+ <cmd>@pkgsysconfdir@/ivam2.conf</cmd>
+ </synopsis>
+
+ <description>
+
+ <p>ivam2.conf is the command line configuration file for ivam2. It
+ is a shell script that is sourced by the init script starting
+ the daemon. Use it to set environment variables which are
+ interpreted by the init script.</p>
+ </description>
+
+ <section name="environment variables">
+ <option>
+ <p><opt>ARGS</opt></p>
+
+ <optdesc><p>Specify the command line arguments for
+ ivamd.</p></optdesc>
+ </option>
+ </section>
+
+ <section name="Author">
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. ivam2 is available
+ at <url
+ href="@PACKAGE_URL@"/>
+ </p>
+ </section>
+
+ <section name="See also">
+ <p>
+ <manref name="ivamd" section="8"/>
+ </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>
diff --git a/man/ivamd.8.xml.in b/man/ivamd.8.xml.in
index 0b753c5..7d448d7 100644
--- a/man/ivamd.8.xml.in
+++ b/man/ivamd.8.xml.in
@@ -1,4 +1,4 @@
-<?xml version="1.0" standalone='no'?>
+<?xml version="1.0" standalone='no'?> <!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
@@ -163,8 +163,8 @@
</section>
<section name="Author">
- <p>ivamd was written by Lennart Poettering
- &lt;@PACKAGE_BUGREPORT@&gt;. ivamd is available
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. ivam2 is available
at <url
href="@PACKAGE_URL@"/>
</p>
diff --git a/man/msntab.5.xml.in b/man/msntab.5.xml.in
index c108a68..0db536a 100644
--- a/man/msntab.5.xml.in
+++ b/man/msntab.5.xml.in
@@ -22,7 +22,7 @@
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
-->
- <manpage name="msntab" section="5" desc="ivam2 MSN Routing Table">
+ <manpage name="msntab" section="5" desc="ivam2 MSN routing table">
<synopsis>
<cmd>@pkgsysconfdir@/msntab</cmd>
@@ -30,12 +30,14 @@
<description>
- <p>msntab is the phone call routing table for ivam2. For each incoming
- call the first matching line in the file is used, all others are
- ignored. Each line consists of four fields: an expression for
- matching the local phone number, an expression for matching the
- remote phone number, an option list and an executable file with
- its arguments which is run for a matching call.</p>
+ <p>msntab is the phone call routing table for ivam2. For each
+ incoming call the first matching line in the file is used, all
+ others are ignored. Each line consists of four fields: an
+ expression for matching the local phone number, an expression
+ for matching the remote phone number, an option list and an
+ action filed, specifying an executable file with its arguments
+ which is run for a matching call. If no line matches a call, the
+ call is ignored.</p>
<p>The phone numbers are matched by the following way: if the
first character of the matching expression is not a tilde, the
@@ -47,139 +49,34 @@
to the end is taken es regular expression and matched with
<manref name="regexec" section="4"/>.</p>
- </description>
-
- <options>
-
- <option>
- <p><opt>-n | --no-daemon</opt></p>
- <optdesc><p>
- Do not daemonize (for debugging) (default: off)
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-s | --no-syslog</opt></p>
- <optdesc><p>
- Do not use syslog, use STDOUT instead (for debugging) (default: off).
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-h | --help</opt></p>
- <optdesc><p>
- Show help.
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-k | --kill</opt></p>
- <optdesc><p>
- Kill a running daemon.
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-c | --check-running</opt></p>
- <optdesc><p>
- Check if a daemon is running. Sets the return value to 0 if a daemon is already running or to 255 if not.
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-v | --version</opt></p>
- <optdesc><p>
- Show version
- </p></optdesc>
- </option>
-
- <option>
- <p><opt>-C | --channels=</opt><arg>CHANNELS</arg></p>
- <optdesc><p> Specifies how many ISDN channels to allocate. It
- should be greater or equal to one. Keep in mind that a
- standard ISDN card provides access to two distinct b channels
- only. Unless you have special hardware or more than one ISDN
- card in a single machine it makes no sense to set this
- paramater to any value greater than 2. This value specifies
- how many concurrent connections may be handled. (default:
- 2)</p></optdesc>
- </option>
-
- <option>
- <p><opt>--msntab=</opt><arg>MSNTABFILE</arg></p>
- <optdesc><p>Specify another msntab file than the default. (default: @pkgsysconfdir@/msntab)</p></optdesc>
- </option>
-
- <option>
- <p><opt>-L | --listen=</opt><arg>LISTENMSN</arg></p>
- <optdesc><p> Specifies which local phone numbers ivamd shall
- listen on. The incoming phone number is matched with shell
- globbing as described in <manref name="fnmatch"
- section="3">fnmatch</manref> with the extension that you may
- list more than one phone number seperated by commas or
- semicolons. (This is described in <manref name="ttyI"
- section="4">ttyI</manref> for the command AT&amp;L. Before
- passing the MSNs to the ISDN modem emulation ivamd replaces
- all occurences of "," to ";". This has certain advantages when
- passing the options from the bourne shell.) In addition to
- that you may specify more than one globbing string seperated
- by colons for different ISDN channels. If you specify fewer
- globbing strings than allocated channels the last globbing
- string will be reused for all excessive channels. It is safe
- to set this option to "*" as you may limit access to your
- telephony applications with the msntab file in a more powerful
- way. This option is only useful as "second line of defense" or
- to assign specific phone numbers to specific
- channels. (default: *)</p></optdesc>
- </option>
-
- <option>
- <p><opt>-d | --device=</opt><arg>DEVICES</arg></p>
- <optdesc><p>Specifies the TTY devices to use. You may specify
- more than one device separated by colons. All devices
- specified in this option will be opened, regardless of the
- argument of the -C option. If you specify fewer devices than
- the requested number of channels, all missing channels will be
- allocated automatically from the /dev/ttyI pool. The devices
- specified with this option are opened prior to the automatic
- usage of the ttyI devices. (default: empty, thus all devices
- will be allocated from the /dev/ttyI pool.)</p></optdesc>
- </option>
-
- <option>
- <p><opt>--no-drop-root</opt></p>
- <optdesc><p>If this option is given ivamd will not drop root
- priviliges and change to ivam:ivam. To stay root is always
- a bad idea, so don't use this for anything but
- debugging. (default: off)</p></optdesc>
- </option>
+ <p>The option field consists of a comma separated list of
+ options. The following options are defined: "rings=n" specifies
+ after how many rings a call is accepted. "pipehack" enables the
+ so-called pipe hack. This may improve latency for clients that
+ support it. This option will pass the output side of the STDOUT
+ pipe back to the client process as file descriptor 255. The
+ client may flush this pipe by reading from it. This is hack, but
+ a useful hack. "defaults" is a NOOP, use it if you don't want to
+ set any special options.</p>
+
+ <p>The action field should be the executable file name of the
+ telephony application to run for an incoming call. Two special
+ values are allowed: @ignore will ignore the call, @hangup will
+ hangup the call immediately after accepting it.</p>
+
+ <p>ivam2 comes with four ready-to-use telephony applications:
+ <manref name="ivam-voicebox" section="1"/>, <manref
+ name="ivam-autobox" section="1"/>, <manref name="ivam-call"
+ section="1"/>, <manref name="ivam-echo" section="1"/></p>
+
+ <p>Have a look on the default msntab file for configuration
+ examples.</p>
- <option>
- <p><opt>--reload</opt></p>
- <optdesc><p>Send a running daemon a HUP signal, thus causing a msntab reload.</p></optdesc>
- </option>
-
- <option>
- <p><opt>--info</opt></p>
- <optdesc><p>Send a running daemon an USR1 signal, thus causing it to dump its msntab file to syslog.</p></optdesc>
- </option>
-
- </options>
-
- <section name="Files">
- <p><file>/var/run/ivamd.pid</file>: the pid file
- for ivamd.</p>
- </section>
-
- <section name="Signals">
- <p><arg>SIGINT, SIGTERM, SIGQUIT</arg> ivamd will quit. This is issued by passing -k to ivamd.</p>
- <p><arg>SIGHUP</arg> ivamd will reload the msntab file immediately. Running connection are not interrupted.</p>
- <p><arg>SIGUSR1</arg> ivamd will print the current contents of the msntab to syslog.</p>
- </section>
+ </description>
<section name="Author">
- <p>ivamd was written by Lennart Poettering
- &lt;@PACKAGE_BUGREPORT@&gt;. ivamd is available
+ <p>ivam2 was written by Lennart Poettering
+ &lt;@PACKAGE_BUGREPORT@&gt;. ivam2 is available
at <url
href="@PACKAGE_URL@"/>
</p>
@@ -187,7 +84,7 @@
<section name="See also">
<p>
- <manref name="msntab" section="5"/>, <manref name="ivam-voicebox" section="8"/>
+ <manref name="ivamd" section="8"/>, <manref name="ivam-voicebox" section="1"/>, <manref name="ivam-autobox" section="1"/>, <manref name="ivam-call" section="1"/>, <manref name="ivam-echo" section="1"/>
</p>
</section>