summaryrefslogtreecommitdiffstats
path: root/man/msntab.5.xml.in
blob: 0db536a5f496ed45ed0a573f12d9789bc72733b7 (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
<?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
      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.</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>

      <p>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.</p>

      <p>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.</p>

      <p>ivam2 comes with four ready-to-use telephony applications:
      <manref name="ivam-voicebox" section="1"/>, <manref
      name="ivam-autobox" section="1"/>, <manref name="ivam-call"
      section="1"/>, <manref name="ivam-echo" section="1"/></p>

      <p>Have a look on the default msntab file for configuration
      examples.</p>

    </description>

	<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="ivamd" section="8"/>, <manref name="ivam-voicebox" section="1"/>, <manref name="ivam-autobox" section="1"/>, <manref name="ivam-call" section="1"/>, <manref name="ivam-echo" 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>