summaryrefslogtreecommitdiffstats
path: root/man/msntab.5.xml.in
blob: c108a68e35a66b848a1eabbb2b77d0f61518a292 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<?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="msntab" section="5" desc="ivam2 MSN Routing Table">

	<synopsis>
	  <cmd>@pkgsysconfdir@/msntab</cmd>
	</synopsis>
	
    <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>The phone numbers are matched by the following way: if the
      first character of the matching expression is not a tilde, the
      whole expression is matched using an extended version of POSIX
      shell globbing based on <manref name="fnmatch" section="4"/>:
      you may specify more than one glob expression seperated by
      commas or semicolons. If the first character of the matching
      expression is a tilde the expression from its second character
      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>

      <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>

	<section name="Author">
	  <p>ivamd was written by Lennart Poettering
		&lt;@PACKAGE_BUGREPORT@&gt;. ivamd is available
		at <url
		href="@PACKAGE_URL@"/>
	  </p>
	</section>
	
	<section name="See also">
	  <p>
		<manref name="msntab" section="5"/>, <manref name="ivam-voicebox" 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>