diff options
Diffstat (limited to 'man/ivamd.8.xml.in')
-rw-r--r-- | man/ivamd.8.xml.in | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/man/ivamd.8.xml.in b/man/ivamd.8.xml.in new file mode 100644 index 0000000..0b753c5 --- /dev/null +++ b/man/ivamd.8.xml.in @@ -0,0 +1,184 @@ +<?xml version="1.0" standalone='no'?> +<!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="ivamd" section="8" desc="ISDN Voice Box Answering Machine Daemon"> + + <synopsis> + <cmd>ivamd [<arg>options</arg>]</cmd> + </synopsis> + + <description> + <p>ivamd is an application server daemon for telephony + applications. It dispatches voice calls to subprocesses + according to a routing table msntab.</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"/> 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"/> 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> + + <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 + <@PACKAGE_BUGREPORT@>. 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> |