summaryrefslogtreecommitdiff
path: root/doc/ztmonitor.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ztmonitor.sgml')
-rwxr-xr-xdoc/ztmonitor.sgml133
1 files changed, 133 insertions, 0 deletions
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:
+-->
+
+