diff options
author | kpfleming <kpfleming@5390a7c7-147a-4af0-8ec9-7488f05a26cb> | 2005-09-15 00:10:23 +0000 |
---|---|---|
committer | kpfleming <kpfleming@5390a7c7-147a-4af0-8ec9-7488f05a26cb> | 2005-09-15 00:10:23 +0000 |
commit | 212ef87253dd19865fb2c3e7a6375f856d390961 (patch) | |
tree | 0eda4e778744c113a4d03fe135616af3aa9329eb | |
parent | 6e95744959ae3ec915bfc34b97363fe09fbfb16f (diff) |
only put uncompressed man pages into source tree (issue #5158)
don't keep SGML sources (troff version is fine)
git-svn-id: http://svn.digium.com/svn/zaptel/trunk@769 5390a7c7-147a-4af0-8ec9-7488f05a26cb
-rwxr-xr-x | Makefile | 25 | ||||
-rwxr-xr-x | doc/ztcfg.8 | 57 | ||||
-rwxr-xr-x | doc/ztcfg.8.gz | bin | 958 -> 0 bytes | |||
-rwxr-xr-x | doc/ztcfg.sgml | 167 | ||||
-rwxr-xr-x | doc/ztmonitor.8 | 42 | ||||
-rwxr-xr-x | doc/ztmonitor.8.gz | bin | 865 -> 0 bytes | |||
-rwxr-xr-x | doc/ztmonitor.sgml | 133 | ||||
-rwxr-xr-x | doc/zttool.8 | 33 | ||||
-rwxr-xr-x | doc/zttool.8.gz | bin | 722 -> 0 bytes | |||
-rwxr-xr-x | doc/zttool.sgml | 104 |
10 files changed, 136 insertions, 425 deletions
@@ -116,7 +116,7 @@ PRIMARY=torisa #PRIMARY=wcfxo PWD:=$(shell pwd) -all: $(BUILDVER) $(LIBTONEZONE_SO) manpages +all: $(BUILDVER) $(LIBTONEZONE_SO) linux24: $(MODULESO) $(BINS) @@ -296,23 +296,6 @@ 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 \ @@ -347,9 +330,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 + install -m 644 doc/ztcfg.8 $(INSTALL_PREFIX)/usr/share/man/man8 + install -m 644 doc/ztmonitor.8 $(INSTALL_PREFIX)/usr/share/man/man8 + install -m 644 doc/zttool.8 $(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 b/doc/ztcfg.8 new file mode 100755 index 0000000..3b7aba5 --- /dev/null +++ b/doc/ztcfg.8 @@ -0,0 +1,57 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ZTCFG" "8" "15 July 2005" "" "" + +.SH NAME +ztcfg \- reads and loads zaptel.conf +.SH SYNOPSIS + +\fBztcfg\fR [ \fB-c \fICFG_FILE\fB \fR ] [ \fB-s\fR ] [ \fB-t\fR ] [ \fB-v [ -v\fI ...\fB ]\fR ] + + +\fBztcfg\fR [ \fB-h\fR ] + +.SH "DESCRIPTION" +.PP +\fBztcfg\fR configures zaptel interface cards +from a config file. +.PP +You generally need to run it with a valid configurations +in order for zaptel modules to work properly. +.SH "OPTIONS" +.TP +\fB-c \fICFG_FILE\fB\fR +Use an alternative configuration file instead of +\fI/etc/zaptel.conf\fR +.TP +\fB-s\fR +Only shutdown spans. +.TP +\fB-t\fR +Test mode. Don't do anything, just report what you +wanted to do. +.TP +\fB-v\fR +Be more verbose. Add extra v-s for extra verbosity. +.TP +\fB-h\fR +Display a brief help about the usage of \fBztcfg\fR +.SH "FILES" +.PP +\fI/etc/zaptel.conf\fR The default location for the configuration file. +.SH "SEE ALSO" +.PP +zttool(8), ztmonitor(8), asterisk(8). +.SH "AUTHOR" +.PP +This manual page was written by Santiago Ruano Rincón <santiago@unicauca.edu.co> 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. +.PP +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/ztcfg.8.gz b/doc/ztcfg.8.gz Binary files differdeleted file mode 100755 index 1c981c0..0000000 --- a/doc/ztcfg.8.gz +++ /dev/null diff --git a/doc/ztcfg.sgml b/doc/ztcfg.sgml deleted file mode 100755 index 356d85f..0000000 --- a/doc/ztcfg.sgml +++ /dev/null @@ -1,167 +0,0 @@ -<!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 b/doc/ztmonitor.8 new file mode 100755 index 0000000..50382b4 --- /dev/null +++ b/doc/ztmonitor.8 @@ -0,0 +1,42 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ZTMONITOR" "8" "15 July 2005" "" "" + +.SH NAME +ztmonitor \- checks the rx/tx levels of the zaptel inteface cards. +.SH SYNOPSIS + +\fBztmonitor \fR \fBchannel number\fR [ \fB-v\fR ] [ \fB-f \fIFILE\fB\fR ] + +.SH "DESCRIPTION" +.PP +ztmonitor 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 +.SH "OPTIONS" +.PP +The first (mandatory) parameter is the number of the channel +to monitor. +.TP +\fB -v \fR +Display visual audio levels. +.TP +\fB -f \fIFILE\fB \fR +Write output to FILE +.SH "SEE ALSO" +.PP +zttool(8), ztcfg(8), asterisk(8). +.SH "AUTHOR" +.PP +This manual page was written by Santiago Ruano Rincón <santiago@unicauca.edu.co> 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. +.PP +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/ztmonitor.8.gz b/doc/ztmonitor.8.gz Binary files differdeleted file mode 100755 index 463cc78..0000000 --- a/doc/ztmonitor.8.gz +++ /dev/null diff --git a/doc/ztmonitor.sgml b/doc/ztmonitor.sgml deleted file mode 100755 index 612bad2..0000000 --- a/doc/ztmonitor.sgml +++ /dev/null @@ -1,133 +0,0 @@ -<!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 b/doc/zttool.8 new file mode 100755 index 0000000..66695ed --- /dev/null +++ b/doc/zttool.8 @@ -0,0 +1,33 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ZTTOOL" "8" "15 July 2005" "" "" + +.SH NAME +zttool \- Zaptel Tool shows status of Digium's interface cards. +.SH SYNOPSIS + +\fBzttool\fR + +.SH "DESCRIPTION" +.PP +zttool shows the current status the Digium Zaptel inteface +cards plugged to the computer. +.PP +It displays values like Current Alarms, SyncSource, Tx/Rx +Levels for each Zaptel interface. +.SH "SEE ALSO" +.PP +ztmonitor(8), asterisk (8). +.SH "AUTHOR" +.PP +This manual page was written by Santiago Ruano Rincón <santiago@unicauca.edu.co> 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. +.PP +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/zttool.8.gz b/doc/zttool.8.gz Binary files differdeleted file mode 100755 index 4d7471d..0000000 --- a/doc/zttool.8.gz +++ /dev/null diff --git a/doc/zttool.sgml b/doc/zttool.sgml deleted file mode 100755 index 82da1ee..0000000 --- a/doc/zttool.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!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: ---> - - |