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 --- doc/Makefile.am | 2 ++ doc/README.VoiceBox | 83 +---------------------------------------------------- doc/README.html.in | 14 ++++++++- 3 files changed, 16 insertions(+), 83 deletions(-) (limited to 'doc') 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 -- cgit