From e4c3dc5c0d1dc9cdd47fdb4ffb1ac49b9b768e5b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 19 Jan 2004 13:26:55 +0000 Subject: prelimernary documentation git-svn-id: file:///home/lennart/svn/public/ivam2/trunk@42 dbf6933d-3bce-0310-9bcc-ed052ba35b35 --- man/Makefile.am | 48 +++++++++++++ man/ivamd.8.xml.in | 184 ++++++++++++++++++++++++++++++++++++++++++++++++ man/msntab.5.xml.in | 199 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/xmltoman.css | 30 ++++++++ man/xmltoman.dtd | 39 ++++++++++ man/xmltoman.xsl | 120 +++++++++++++++++++++++++++++++ 6 files changed, 620 insertions(+) create mode 100644 man/Makefile.am create mode 100644 man/ivamd.8.xml.in create mode 100644 man/msntab.5.xml.in create mode 100644 man/xmltoman.css create mode 100644 man/xmltoman.dtd create mode 100644 man/xmltoman.xsl (limited to 'man') 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 @@ + + + + + + + + + + + + ivamd [options] + + + +

ivamd is an application server daemon for telephony + applications. It dispatches voice calls to subprocesses + according to a routing table msntab.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

/var/run/ivamd.pid: the pid file + for ivamd.

+
+ +
+

SIGINT, SIGTERM, SIGQUIT ivamd will quit. This is issued by passing -k to ivamd.

+

SIGHUP ivamd will reload the msntab file immediately. Running connection are not interrupted.

+

SIGUSR1 ivamd will print the current contents of the msntab to syslog.

+
+ +
+

ivamd was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivamd is available + at +

+
+ +
+

+ , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ +
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 @@ + + + + + + + + + + + + @pkgsysconfdir@/msntab + + + + +

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.

+ +

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 : + 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 + .

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

/var/run/ivamd.pid: the pid file + for ivamd.

+
+ +
+

SIGINT, SIGTERM, SIGQUIT ivamd will quit. This is issued by passing -k to ivamd.

+

SIGHUP ivamd will reload the msntab file immediately. Running connection are not interrupted.

+

SIGUSR1 ivamd will print the current contents of the msntab to syslog.

+
+ +
+

ivamd was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ivamd is available + at +

+
+ +
+

+ , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ +
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 @@ + + + + + + + + + + + + + + + + + + + + + + + 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 @@ + + + + + + + + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + + + + + + <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) + + + + +

Name

+

+ + - + +

+ + + +
+ + +

+ +

+
+ + +

+ +

+
+ + + + + + + + + + + + + + +
+ +
+
+ + +

Synopsis

+ +
+ + +

Synopsis

+ +
+ + +

Description

+ +
+ + +

Options

+ +
+ + +

+ +
+ + +
+
+ + + + + () + + + () + + + + + + + + +
-- cgit