diff options
author | Lennart Poettering <lennart@poettering.net> | 2004-01-19 13:26:55 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2004-01-19 13:26:55 +0000 |
commit | e4c3dc5c0d1dc9cdd47fdb4ffb1ac49b9b768e5b (patch) | |
tree | 1517947448ad0dc962770f5636efb1a520ded994 /man | |
parent | 2db4e16e39a91180dae55014176b20efa0b0c686 (diff) |
prelimernary documentation
git-svn-id: file:///home/lennart/svn/public/ivam2/trunk@42 dbf6933d-3bce-0310-9bcc-ed052ba35b35
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 48 | ||||
-rw-r--r-- | man/ivamd.8.xml.in | 184 | ||||
-rw-r--r-- | man/msntab.5.xml.in | 199 | ||||
-rw-r--r-- | man/xmltoman.css | 30 | ||||
-rw-r--r-- | man/xmltoman.dtd | 39 | ||||
-rw-r--r-- | man/xmltoman.xsl | 120 |
6 files changed, 620 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..3e30491 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,48 @@ +# $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. + +SUFFIXES=.xml .xml.in .8 .5 .8.xml .5.xml + +pkgsysconfdir=$(sysconfdir)/@PACKAGE@ + +man_MANS = ivamd.8 msntab.5 + +noinst_DATA = ivamd.8.xml msntab.5.xml + +EXTRA_DIST = $(man_MANS) ivamd.8.xml.in msntab.5.xml.in xmltoman.css xmltoman.xsl xmltoman.dtd + +CLEANFILES = ivamd.8.xml msntab.5.xml + +.xml.in.xml: Makefile + sed -e 's,@sysconfdir\@,$(sysconfdir),g' \ + -e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \ + -e 's,@sbindir\@,$(sbindir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +if USE_XMLTOMAN + +CLEANFILES += $(man_MANS) + +.8.xml.8: Makefile + xmltoman $< > $@ + +.5.xml.5: Makefile + xmltoman $< > $@ + +endif 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> diff --git a/man/msntab.5.xml.in b/man/msntab.5.xml.in new file mode 100644 index 0000000..c108a68 --- /dev/null +++ b/man/msntab.5.xml.in @@ -0,0 +1,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&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> diff --git a/man/xmltoman.css b/man/xmltoman.css new file mode 100644 index 0000000..0811e82 --- /dev/null +++ b/man/xmltoman.css @@ -0,0 +1,30 @@ +/* $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. +***/ + +body { color: black; background-color: white; margin: 0.5cm; } +a:link, a:visited { color: #900000; } +h1 { text-transform:uppercase; font-size: 18pt; color: #00009F; } +p { margin-left:1cm; margin-right:1cm; } +.cmd { font-family:monospace; } +.file { font-family:monospace; } +.arg { text-transform:uppercase; font-family:monospace; font-style: italic; } +.opt { font-family:monospace; font-weight: bold; } +.manref { font-family:monospace; } +.option .optdesc { margin-left:2cm; } diff --git a/man/xmltoman.dtd b/man/xmltoman.dtd new file mode 100644 index 0000000..c6031fb --- /dev/null +++ b/man/xmltoman.dtd @@ -0,0 +1,39 @@ +<!-- $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. +--> + +<!ELEMENT manpage (synopsis | description | section | options | seealso)*> +<!ATTLIST manpage name CDATA #REQUIRED section CDATA #REQUIRED desc CDATA #IMPLIED> +<!ELEMENT arg (#PCDATA)> +<!ELEMENT p (#PCDATA | arg | url | manref | opt | file )*> +<!ELEMENT synopsis (cmd | p)+> +<!ELEMENT description (p)+> +<!ELEMENT section (p | option)*> +<!ATTLIST section name CDATA #REQUIRED> +<!ELEMENT option (#PCDATA | p | optdesc)*> +<!ELEMENT optdesc (#PCDATA | p )*> +<!ELEMENT cmd (#PCDATA | arg)*> +<!ELEMENT options (p | option)*> +<!ELEMENT seealso (p)*> +<!ELEMENT opt (#PCDATA)> +<!ELEMENT file (#PCDATA)> +<!ELEMENT manref EMPTY> +<!ATTLIST manref name CDATA #REQUIRED section CDATA #REQUIRED href CDATA #IMPLIED> +<!ELEMENT url EMPTY> +<!ATTLIST url href CDATA #REQUIRED> diff --git a/man/xmltoman.xsl b/man/xmltoman.xsl new file mode 100644 index 0000000..2da97be --- /dev/null +++ b/man/xmltoman.xsl @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml"> + +<!-- + 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. +--> + +<xsl:template match="/manpage"> + <xsl:text disable-output-escaping="yes"> + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + </xsl:text> + <html> + + <head> + <title> + <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) + </title> + <link rel="stylesheet" type="text/css" href="xmltoman.css"/> + </head> + <body> + <h1>Name</h1> + <p><xsl:value-of select="@name"/> + <xsl:if test="string-length(@desc) > 0"> + - <xsl:value-of select="@desc"/> + </xsl:if> + </p> + <xsl:apply-templates /> + </body> + </html> +</xsl:template> + +<xsl:template match="p"> + <p> + <xsl:apply-templates/> + </p> +</xsl:template> + +<xsl:template match="cmd"> + <p class="cmd"> + <xsl:apply-templates/> + </p> +</xsl:template> + +<xsl:template match="arg"> + <span class="arg"><xsl:apply-templates/></span> +</xsl:template> + +<xsl:template match="opt"> + <span class="opt"><xsl:apply-templates/></span> +</xsl:template> + +<xsl:template match="file"> + <span class="file"><xsl:apply-templates/></span> +</xsl:template> + +<xsl:template match="optdesc"> + <div class="optdesc"> + <xsl:apply-templates/> + </div> +</xsl:template> + +<xsl:template match="synopsis"> + <h1>Synopsis</h1> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="seealso"> + <h1>Synopsis</h1> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="description"> + <h1>Description</h1> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="options"> + <h1>Options</h1> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="section"> + <h1><xsl:value-of select="@name"/></h1> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="option"> + <div class="option"><xsl:apply-templates/></div> +</xsl:template> + +<xsl:template match="manref"> + <xsl:choose> + <xsl:when test="string-length(@href) > 0"> + <a class="manref"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</a> + </xsl:when> + <xsl:otherwise> + <span class="manref"><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</span> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="url"> + <a class="url"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@href"/></a> +</xsl:template> + +</xsl:stylesheet> |