From de699318ba74dfb7a10857c5634e4210c726616b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 19 Jan 2004 17:49:05 +0000 Subject: Documentation finished git-svn-id: file:///home/lennart/svn/public/ivam2/trunk@43 dbf6933d-3bce-0310-9bcc-ed052ba35b35 --- conf/msntab | 3 +- doc/Makefile.am | 2 + doc/README.VoiceBox | 83 +--------------------- doc/README.html.in | 14 +++- man/Makefile.am | 14 ++-- man/ivam-autobox.1.xml.in | 111 +++++++++++++++++++++++++++++ man/ivam-createvb.1.xml.in | 69 ++++++++++++++++++ man/ivam-echo.1.xml.in | 57 +++++++++++++++ man/ivam-play.1.xml.in | 55 ++++++++++++++ man/ivam-spool.5.xml.in | 172 ++++++++++++++++++++++++++++++++++++++++++++ man/ivam-voicebox.1.xml.in | 126 +++++++++++++++++++++++++++++++++ man/ivam2.conf.5.xml.in | 67 ++++++++++++++++++ man/ivamd.8.xml.in | 6 +- man/msntab.5.xml.in | 173 +++++++++------------------------------------ 14 files changed, 722 insertions(+), 230 deletions(-) create mode 100644 man/ivam-autobox.1.xml.in create mode 100644 man/ivam-createvb.1.xml.in create mode 100644 man/ivam-echo.1.xml.in create mode 100644 man/ivam-play.1.xml.in create mode 100644 man/ivam-spool.5.xml.in create mode 100644 man/ivam-voicebox.1.xml.in create mode 100644 man/ivam2.conf.5.xml.in 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.

Documentation

-

Have a look on the man pages ivamd(8), ivam2.conf(5), msntab(5), ivam-autobox(1), ivam-voicebox(1), ivam-echo(1), ivam-play(1), ivam-createvb(1), ivam-spool(5). (An XSLT capable browser is required)

+

Have a look on the man pages ivamd(8), ivam2.conf(5), msntab(5), ivam-autobox(1), +ivam-voicebox(1), +ivam-echo(1), ivam-play(1), ivam-createvb(1), +ivam-spool(5). (An +XSLT capable browser is required)

The core daemon ivamd is configured through both the command line arguments and the file msntab. 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 @@ + + + + + + + + + + + + ivam-autobox [options] [spool_directory] + + + +

ivam-autobox is an extended version of the simple voice box + application . 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.

+ +

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.

+ +

You may pass an absolute path as argument to ivam-autobox to + be prepended to the local spool names, instead of @SPOOLDIR@.

+ +

Navigation in the voice boxes is identical to + ivam-voicebox.

+ + + + +

ivam-autobox accepts all the options accepts. In addition the following options are accepted:

+ + + + + + + + + + + + + +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + ivam-createvb SPOOLNAME + + + +

ivam-createvb is a simple tool which creates spool + directories for usage with or . 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 you have to + create each voice box you want to serve with this script. If you + use you may omit this + step, since voice boxes are created automatically on an incoming + call from the local phone number.

+ +

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.

+ + +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + ivam-echo + + + +

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 .

+ + +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + ivam-play FILENAME.ulaw(.gz) + + + +

ivam-play is a simple telephony application for ivam2 which + plays a .ulaw or .ulaw.gz file to the caller.

+ + +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + @SPOOLDIR@/SPOOLNAME + + + + +

This man page describes the layout of a voice box spool + directory as used by + and .

+ +

You may create ivam2 voice box spool directories with the + tool

+ + + +
+ +

The following files in the voice box spool directory may be used to + adjust configuration options:

+ + + + + + + + + + + + + + +
+ +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + ivam-voicebox [options] spool_directory + + + +

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 + for an explanation of the spool directory layout.

+ + +
+

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.

+
+ + + + + + + + + + + + + + + + + + + +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ , , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + + @pkgsysconfdir@/ivam2.conf + + + + +

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.

+ + +
+ +
+ +
+

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available + at +

+
+ +
+

+ +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ - + @@ -163,8 +163,8 @@
-

ivamd was written by Lennart Poettering - <@PACKAGE_BUGREPORT@>. ivamd is available +

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available at

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. --> - + @pkgsysconfdir@/msntab @@ -30,12 +30,14 @@ -

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.

+

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.

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 .

- - - - - - - - - - - - - - - - - - - - - - - - - +

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.

+ +

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.

+ +

ivam2 comes with four ready-to-use telephony applications: + , , ,

+ +

Have a look on the default msntab file for configuration + examples.

- - - - - - -
-

/var/run/ivamd.pid: the pid file - for ivamd.

-
- -
-

SIGINT, SIGTERM, SIGQUIT ivamd will quit. This is issued by passing -k to ivamd.

-

SIGHUP ivamd will reload the msntab file immediately. Running connection are not interrupted.

-

SIGUSR1 ivamd will print the current contents of the msntab to syslog.

-
+
-

ivamd was written by Lennart Poettering - <@PACKAGE_BUGREPORT@>. ivamd is available +

ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available at

@@ -187,7 +84,7 @@

- , + , , , ,

-- cgit