diff options
Diffstat (limited to 'man/msntab.5.xml.in')
| -rw-r--r-- | man/msntab.5.xml.in | 173 |
1 files changed, 35 insertions, 138 deletions
diff --git a/man/msntab.5.xml.in b/man/msntab.5.xml.in index c108a68..0db536a 100644 --- a/man/msntab.5.xml.in +++ b/man/msntab.5.xml.in @@ -22,7 +22,7 @@ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. --> - <manpage name="msntab" section="5" desc="ivam2 MSN Routing Table"> + <manpage name="msntab" section="5" desc="ivam2 MSN routing table"> <synopsis> <cmd>@pkgsysconfdir@/msntab</cmd> @@ -30,12 +30,14 @@ <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>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 @@ -47,139 +49,34 @@ 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&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> + <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> - <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> + </description> <section name="Author"> - <p>ivamd was written by Lennart Poettering - <@PACKAGE_BUGREPORT@>. ivamd is available + <p>ivam2 was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivam2 is available at <url href="@PACKAGE_URL@"/> </p> @@ -187,7 +84,7 @@ <section name="See also"> <p> - <manref name="msntab" section="5"/>, <manref name="ivam-voicebox" section="8"/> + <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> |