[Asterisk-cvs] zaptel/doc ztcfg.8.gz, NONE, 1.1 ztcfg.sgml, NONE, 1.1 ztmonitor.8.gz, NONE, 1.1 ztmonitor.sgml, NONE, 1.1 zttool.8.gz, NONE, 1.1 zttool.sgml, NONE, 1.1

kpfleming at lists.digium.com kpfleming at lists.digium.com
Fri Jul 15 16:43:24 CDT 2005


Update of /usr/cvsroot/zaptel/doc
In directory mongoose.digium.com:/tmp/cvs-serv12414/doc

Added Files:
	ztcfg.8.gz ztcfg.sgml ztmonitor.8.gz ztmonitor.sgml 
	zttool.8.gz zttool.sgml 
Log Message:
add manpages for zaptel utilities (bug #4715)


--- NEW FILE: ztcfg.8.gz ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: ztcfg.sgml ---
<!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 at 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:
-->



--- NEW FILE: ztmonitor.8.gz ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: ztmonitor.sgml ---
<!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 at 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:
-->



--- NEW FILE: zttool.8.gz ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: zttool.sgml ---
<!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 at 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:
-->






More information about the svn-commits mailing list