diff options
-rwxr-xr-x | Makefile | 22 | ||||
-rwxr-xr-x | doc/ztcfg.8.gz | bin | 0 -> 958 bytes | |||
-rwxr-xr-x | doc/ztcfg.sgml | 167 | ||||
-rwxr-xr-x | doc/ztmonitor.8.gz | bin | 0 -> 865 bytes | |||
-rwxr-xr-x | doc/ztmonitor.sgml | 133 | ||||
-rwxr-xr-x | doc/zttool.8.gz | bin | 0 -> 722 bytes | |||
-rwxr-xr-x | doc/zttool.sgml | 104 |
7 files changed, 425 insertions, 1 deletions
@@ -116,7 +116,7 @@ PRIMARY=torisa #PRIMARY=wcfxo PWD:=$(shell pwd) -all: $(BUILDVER) $(LIBTONEZONE_SO) +all: $(BUILDVER) $(LIBTONEZONE_SO) manpages linux24: $(MODULESO) $(BINS) @@ -295,6 +295,23 @@ else # DYNFS @echo "**** If you are running udev, read README.udev" endif +manpages: doc/ztcfg.8.gz doc/ztmonitor.8.gz doc/zttool.8.gz + +doc/ztcfg.8.gz: doc/ztcfg.sgml + rm -f doc/ztcfg.8.gz + docbook2man -o doc doc/ztcfg.sgml + gzip doc/ztcfg.8 + +doc/zttool.8.gz: doc/zttool.sgml + rm -f doc/zttool.8.gz + docbook2man -o doc doc/zttool.sgml + gzip doc/zttool.8 + +doc/ztmonitor.8.gz: doc/ztmonitor.sgml + rm -f doc/ztmonitor.8.gz + docbook2man -o doc doc/ztmonitor.sgml + gzip doc/ztmonitor.8 + install: all devices install -D -m 755 ztcfg $(INSTALL_PREFIX)/sbin/ztcfg if [ -f sethdlc-new ]; then \ @@ -329,6 +346,9 @@ install: all devices install -D -m 644 zaptel.h $(INSTALL_PREFIX)/usr/include/linux/zaptel.h install -D -m 644 torisa.h $(INSTALL_PREFIX)/usr/include/linux/torisa.h install -D -m 644 tonezone.h $(INSTALL_PREFIX)/usr/include/tonezone.h + install -m 644 doc/ztcfg.8.gz $(INSTALL_PREFIX)/usr/share/man/man8 + install -m 644 doc/ztmonitor.8.gz $(INSTALL_PREFIX)/usr/share/man/man8 + install -m 644 doc/zttool.8.gz $(INSTALL_PREFIX)/usr/share/man/man8 if [ -f $(MODCONF) ]; then mv -f $(MODCONF) $(MODCONF).bak ; fi cat $(MODCONF).bak | grep -v "alias char-major-250" | \ grep -v "post-install torisa /sbin/ztcfg" | \ diff --git a/doc/ztcfg.8.gz b/doc/ztcfg.8.gz Binary files differnew file mode 100755 index 0000000..1c981c0 --- /dev/null +++ b/doc/ztcfg.8.gz diff --git a/doc/ztcfg.sgml b/doc/ztcfg.sgml new file mode 100755 index 0000000..356d85f --- /dev/null +++ b/doc/ztcfg.sgml @@ -0,0 +1,167 @@ +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ + +<!-- Man page for the ztcfg command of the zaptel package --> + + <!ENTITY dhfirstname "<firstname>Santiago</firstname>"> + <!ENTITY dhsurname "<surname>Ruano Rincón</surname>"> + <!-- Please adjust the date whenever revising the manpage. --> + <!ENTITY dhdate "<date>July 14, 2005</date>"> + <!ENTITY dhsection "<manvolnum>8</manvolnum>"> + <!ENTITY dhemail "<email>santiago@unicauca.edu.co</email>"> + <!ENTITY dhusername "Santiago Ruano Rincón"> + <!ENTITY dhucpackage "<refentrytitle>ztcfg</refentrytitle>"> + <!ENTITY dhpackage "ztcfg"> + + <!ENTITY debian "<productname>Debian</productname>"> + <!ENTITY gnu "<acronym>GNU</acronym>"> + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> +]> + +<refentry> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + <copyright> + <year>2005</year> + <holder>&dhusername;</holder> + </copyright> + &dhdate; + </refentryinfo> + <refmeta> + &dhucpackage; + + &dhsection; + </refmeta> + <refnamediv> + <refname>&dhpackage;</refname> + + <refpurpose>reads and loads zaptel.conf</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>&dhpackage;</command> + <arg choice='opt'><option>-c <replaceable>CFG_FILE</replaceable> </option></arg> + <arg choice='opt'><option>-s</option></arg> + <arg choice='opt'><option>-t</option></arg> + <arg choice='opt'><option>-v</option><arg choice='opt' rep='repeat'><option>-v</option></arg></arg> + + </cmdsynopsis> + + <cmdsynopsis> + <command>&dhpackage</command> + <arg choice='opt'><option>-h</option></arg> + </cmdsynopsis> + + </refsynopsisdiv> + + <refsect1> + <title>DESCRIPTION</title> + + <para><command>ztcfg</command> configures zaptel interface cards + from a config file.</para> + + <para>You generally need to run it with a valid configurations + in order for zaptel modules to work properly.</para> + + </refsect1> + + <refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term><option>-c</option> <replaceable>CFG_FILE</replaceable></term><listitem><para>Use an alternative configuration file instead of + <filename>/etc/zaptel.conf</filename></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option></term> + <listitem> + <para>Only shutdown spans. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option></term> + <listitem> + <para>Test mode. Don't do anything, just report what you + wanted to do.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option></term> + <listitem> + <para>Be more verbose. Add extra v-s for extra verbosity.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-h</option></term> + <listitem> + <para>Display a brief help about the usage of <command>&dhpackage</command></para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + + <refsect1> + <title>FILES</title> + + <para><filename>/etc/zaptel.conf</filename> The default location for the configuration file.</para> + + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + + <para>zttool(8), ztmonitor(8), asterisk(8).</para> + + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + </para> + <para> + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + </para> + + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> + + diff --git a/doc/ztmonitor.8.gz b/doc/ztmonitor.8.gz Binary files differnew file mode 100755 index 0000000..463cc78 --- /dev/null +++ b/doc/ztmonitor.8.gz diff --git a/doc/ztmonitor.sgml b/doc/ztmonitor.sgml new file mode 100755 index 0000000..612bad2 --- /dev/null +++ b/doc/ztmonitor.sgml @@ -0,0 +1,133 @@ +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ + +<!-- Man page for the ztmonitor command of the zaptel package --> + + + <!ENTITY dhfirstname "<firstname>Santiago</firstname>"> + <!ENTITY dhsurname "<surname>Ruano Rincón</surname>"> + <!-- Please adjust the date whenever revising the manpage. --> + <!ENTITY dhdate "<date>July 14, 2005</date>"> + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are + allowed: see man(7), man(1). --> + <!ENTITY dhsection "<manvolnum>8</manvolnum>"> + <!ENTITY dhemail "<email>santiago@unicauca.edu.co</email>"> + <!ENTITY dhusername "Santiago Ruano Rincón"> + <!ENTITY dhucpackage "<refentrytitle>ztmonitor</refentrytitle>"> + <!ENTITY dhpackage "ztmonitor"> + + <!ENTITY debian "<productname>Debian</productname>"> + <!ENTITY gnu "<acronym>GNU</acronym>"> + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> +]> + +<refentry> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + <copyright> + <year>2005</year> + <holder>&dhusername;</holder> + </copyright> + &dhdate; + </refentryinfo> + <refmeta> + &dhucpackage; + + &dhsection; + </refmeta> + <refnamediv> + <refname>&dhpackage;</refname> + + <refpurpose>checks the rx/tx levels of the zaptel + inteface cards.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>&dhpackage; </command> + <arg choice='req' ><option>channel number</option></arg> + <arg><option>-v</option></arg> + <arg><option>-f <replaceable>FILE</replaceable></option></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + + <para>&dhpackage; monitors a zaptel channel. It gives you a visual + representation of the sound strengths and makes it easy to see if + the received or transmitted signals are too high or out of + balance</para> + + + </refsect1> + + <refsect1> + <title>OPTIONS</title> + + <para>The first (mandatory) parameter is the number of the channel + to monitor.</para> + + <variablelist> + <varlistentry> + <term> + <option>-v</option> + </term> + <listitem> + <para>Display visual audio levels.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-f <replaceable>FILE</replaceable></option> + </term> + <listitem> + <para>Write output to FILE</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>SEE ALSO</title> + + <para>zttool(8), ztcfg(8), asterisk(8).</para> + + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + </para> + <para> + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + </para> + + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> + + diff --git a/doc/zttool.8.gz b/doc/zttool.8.gz Binary files differnew file mode 100755 index 0000000..4d7471d --- /dev/null +++ b/doc/zttool.8.gz diff --git a/doc/zttool.sgml b/doc/zttool.sgml new file mode 100755 index 0000000..82da1ee --- /dev/null +++ b/doc/zttool.sgml @@ -0,0 +1,104 @@ +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ + +<!-- Man page for the zttool command of the zaptel package --> + + + <!ENTITY dhfirstname "<firstname>Santiago</firstname>"> + <!ENTITY dhsurname "<surname>Ruano Rincón</surname>"> + <!-- Please adjust the date whenever revising the manpage. --> + <!ENTITY dhdate "<date>July 14, 2005</date>"> + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are + allowed: see man(7), man(1). --> + <!ENTITY dhsection "<manvolnum>8</manvolnum>"> + <!ENTITY dhemail "<email>santiago@unicauca.edu.co</email>"> + <!ENTITY dhusername "Santiago Ruano Rincón"> + <!ENTITY dhucpackage "<refentrytitle>zttool</refentrytitle>"> + <!ENTITY dhpackage "zttool"> + + <!ENTITY debian "<productname>Debian</productname>"> + <!ENTITY gnu "<acronym>GNU</acronym>"> + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> +]> + +<refentry> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + <copyright> + <year>2005</year> + <holder>&dhusername;</holder> + </copyright> + &dhdate; + </refentryinfo> + <refmeta> + &dhucpackage; + + &dhsection; + </refmeta> + <refnamediv> + <refname>&dhpackage;</refname> + + <refpurpose>Zaptel Tool shows status of Digium's interface cards.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>&dhpackage;</command> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + + <para>zttool shows the current status the Digium Zaptel inteface + cards plugged to the computer.</para> + + <para>It displays values like Current Alarms, SyncSource, Tx/Rx + Levels for each Zaptel interface.</para> + + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + + <para>ztmonitor(8), asterisk (8).</para> + + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + </para> + <para> + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + </para> + + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> + + |