summaryrefslogtreecommitdiff
path: root/doc/ztmonitor.sgml
blob: 612bad293367862a08bad8f6a42c6e3f8947535f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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:
-->