From 6aa852bfcc456827bf81a2feb6eba4639ea94e23 Mon Sep 17 00:00:00 2001 From: kpfleming Date: Fri, 15 Jul 2005 20:51:12 +0000 Subject: add manpages for zaptel utilities (bug #4715) git-svn-id: http://svn.digium.com/svn/zaptel/trunk@695 5390a7c7-147a-4af0-8ec9-7488f05a26cb --- Makefile | 22 ++++++- doc/ztcfg.8.gz | Bin 0 -> 958 bytes doc/ztcfg.sgml | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ztmonitor.8.gz | Bin 0 -> 865 bytes doc/ztmonitor.sgml | 133 ++++++++++++++++++++++++++++++++++++++++++ doc/zttool.8.gz | Bin 0 -> 722 bytes doc/zttool.sgml | 104 +++++++++++++++++++++++++++++++++ 7 files changed, 425 insertions(+), 1 deletion(-) create mode 100755 doc/ztcfg.8.gz create mode 100755 doc/ztcfg.sgml create mode 100755 doc/ztmonitor.8.gz create mode 100755 doc/ztmonitor.sgml create mode 100755 doc/zttool.8.gz create mode 100755 doc/zttool.sgml diff --git a/Makefile b/Makefile index 274ce38..776e9a0 100755 --- a/Makefile +++ b/Makefile @@ -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 new file mode 100755 index 0000000..1c981c0 Binary files /dev/null and b/doc/ztcfg.8.gz differ 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 @@ + + + Santiago"> + Ruano Rincón"> + + July 14, 2005"> + 8"> + santiago@unicauca.edu.co"> + + ztcfg"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + reads and loads zaptel.conf + + + + + &dhpackage; + + + + + + + + + &dhpackage + + + + + + + DESCRIPTION + + ztcfg configures zaptel interface cards + from a config file. + + You generally need to run it with a valid configurations + in order for zaptel modules to work properly. + + + + + OPTIONS + + + + + CFG_FILEUse an alternative configuration file instead of + /etc/zaptel.conf + + + + + + + Only shutdown spans. + + + + + + + + Test mode. Don't do anything, just report what you + wanted to do. + + + + + + + Be more verbose. Add extra v-s for extra verbosity. + + + + + + + Display a brief help about the usage of &dhpackage + + + + + + + + + + FILES + + /etc/zaptel.conf The default location for the configuration file. + + + + + SEE ALSO + + zttool(8), ztmonitor(8), asterisk(8). + + + + AUTHOR + + 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. + + + 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 new file mode 100755 index 0000000..463cc78 Binary files /dev/null and b/doc/ztmonitor.8.gz differ 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 @@ + + + + Santiago"> + Ruano Rincón"> + + July 14, 2005"> + + 8"> + santiago@unicauca.edu.co"> + + ztmonitor"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + checks the rx/tx levels of the zaptel + inteface cards. + + + + &dhpackage; + + + + + + + DESCRIPTION + + &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 + + + + + + OPTIONS + + The first (mandatory) parameter is the number of the channel + to monitor. + + + + + + + + Display visual audio levels. + + + + + + + + Write output to FILE + + + + + + SEE ALSO + + zttool(8), ztcfg(8), asterisk(8). + + + + AUTHOR + + 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. + + + 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 new file mode 100755 index 0000000..4d7471d Binary files /dev/null and b/doc/zttool.8.gz differ 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 @@ + + + + Santiago"> + Ruano Rincón"> + + July 14, 2005"> + + 8"> + santiago@unicauca.edu.co"> + + zttool"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + Zaptel Tool shows status of Digium's interface cards. + + + + &dhpackage; + + + + DESCRIPTION + + zttool shows the current status the Digium Zaptel inteface + cards plugged to the computer. + + It displays values like Current Alarms, SyncSource, Tx/Rx + Levels for each Zaptel interface. + + + + + SEE ALSO + + ztmonitor(8), asterisk (8). + + + + AUTHOR + + 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. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + + + + -- cgit v1.2.3