summaryrefslogtreecommitdiffstats
path: root/man/ivam-autobox.1.xml.in
blob: 04c8298619e6e210cc8fcd006d2ff48780525c93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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>