- added some validation checks to reading of script config (bug #531),

updated comments accordingly
- changed default for user_audio_files from 1 to 0


git-svn-id: https://svn.ibp.de/svn/capisuite/trunk/capisuite@49 4ebea2bb-67d4-0310-8558-a5799e421b66

scripts/answering_machine.confin

@@ -1,4 +1,4 @@
-# $Id: answering_machine.confin,v 1.2 2003/02/21 13:12:19 gernot Exp $
+# $Id: answering_machine.confin,v 1.3 2003/03/20 08:56:21 gernot Exp $
 #
 # This is the configuration file for the answering machine scripts distributed
 # with CapiSuite
@@ -29,11 +29,15 @@
 
 [GLOBAL]
 
+# audio_dir (MANDATORY)
+#
 # Directory where audio snippets used in the answering machine script are
 # located. If user_audio_files is enabled (see below), each user can also
 # provide his own audio snippets in his user_dir (see below).
 audio_dir="@pkgdatadir@/"
 
+# voice_user_dir (MANDATORY)
+#
 # Directory for all user-specific data. Contains one subdirectory
 # for each user (named like his userid). The following directory tree is used:
 #
@@ -43,31 +47,37 @@ audio_dir="@pkgdatadir@/"
 # user_dir/username/received  -  all received calls (voice and fax) will be saved here
 voice_user_dir="@spooldir@/users/"
 
+# user_audio_files (optional, defaults to 0)
+#
 # Controls wether the user_dir (see below) will also be searched for audio
 # files. If set to "1", the script will look in the user_dir and then in
 # audio_dir for a needed audio file. If "0", only audio_dir is used.
 # This doesn't affect the announcement, which can and should be different
 # for each user in any case.
-user_audio_files="1"
+user_audio_files="0"
 
+# voice_delay (MANDATORY)
+#
 # Global setting for the time in seconds before incoming voice calls are
-# accepted.
+# accepted. 
 voice_delay="15"
 
+# announcement (optional, defaults to "announcement.la")
+#
 # This value gives the default name of the announcement file which is searched
-# in the user_dir. Each user should provide one in his/her own dir.
+# in the user_dir. Each user should provide one in his/her own dir. 
 announcement="announcement.la"
 
-# record_length
+# record_length (optional, defaults to 60)
 #
 # Global setting for the maximal record length of the answering machine
 # in seconds
 record_length="60"
 
-# record_silence_timeout
+# record_silence_timeout (optional, defaults to 5)
 #
 # Global setting for the length of silence after which recording is
-# finished by the answering machine.
+# finished by the answering machine
 record_silence_timeout="5"
 
 ###############################################################################
@@ -83,26 +93,30 @@ record_silence_timeout="5"
 #
 # Additionally, the following options are possible:
 #
-# voice_numbers="13,14"
+# voice_numbers="<num1>,<num2>" (optional, if not set this user can't receive)
+#
 #   This list contains the numbers on which this user wants to receive incoming
 #   voice calls. The values are separated by commas. You can also use the special 
 #   entry "*" which stands for accepting ALL incoming calls (use with care!).
 #
-# voice_email="name@domain.de"
+# voice_email="name@domain.de" (optional, defaults to empty string)
+#
 #   If given, this string indicates an email-address where the received faxes
 #   and voice calls will be sent to. If it is empty, the recorded calls and
 #   faxes will be sent to the user on the current system. It's also used to
 #   send status reports for sent fax jobs to. If you don't want to get emails,
 #   see the "action" option below
 #
-# pin="<PIN number>"
+# pin="<PIN number>" (optional, defaults to empty)
+#
 #   pin for activating the remote inquiry. Start typing when the announcement
 #   is played. If you don't want remote inquiry function for your answering
 #   machine for security or other reasons, just set this to an empty string.
 #   You can use as many digits as you want. The script will wait 2 seconds after
 #   each typed digit for the next one.
 #
-# voice_action="<action>"
+# voice_action="<action>" (MANDATORY)
+#
 #   Here you can define what action will be taken when a call is received.
 #   Currently, three possible actions are supported:
 #