add new man pages, don't install man page for ztmonitor since it is not itself installed (issue #5157)

git-svn-id: http://svn.digium.com/svn/zaptel/trunk@770 5390a7c7-147a-4af0-8ec9-7488f05a26cb

5 files changed, 166 insertions, 1 deletions

diff --git a/Makefile b/Makefile
index be993b3..5b8bae0 100755
--- a/Makefile
+++ b/Makefile
@@ -331,7 +331,6 @@ install: all devices
 	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 $(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" | \
diff --git a/doc/fxotune.8 b/doc/fxotune.8
new file mode 100755
index 0000000..2236a70
--- /dev/null
+++ b/doc/fxotune.8
@@ -0,0 +1,66 @@
+.TH FXOTUNE 8 "September 10th, 2005" "Xorcom Rapid Asterisk" "Linux Programmer's Manual"
+.SH NAME
+.B fxotune
+\(em automatically tune FXO channels on a Digium TDM400 card
+.SH SYNOPSIS
+.B fxotune -i 
+.I <dialstr> 
+\(em detect 
+
+.B fxotune -s 
+\(em load settings
+
+.SH DESCRIPTION
+.B fxotune 
+is a script that fine-tune parameters of the FXO modules of the TDM400
+card. Whene run in 
+.I detect
+mode (-i) it detects and tunes all the FXO channels of such cards. It 
+needs a dial string after which the line(s) will give dial tone.
+
+It writes settings to a configuration file (/etc/fxotune.conf , name 
+is hardwired) from which it can be loaded (e.g: at startup) using -s .
+
+
+.SH OPTIONS
+.B -i
+.RS
+.I dialstr
+Start detecting optimal settings.  
+.I dialstr
+Is a number needed to dial to get a dial tone.
+The test can take several minutes, and must be performed when Asterisk
+is not running.
+
+For example: 
+.RS
+fxotune -i 9
+.RE
+if you need to dial 9 for an external line. If you always get a line, you
+can simply use any digit.
+.RE
+
+.B -s
+.RS
+Load settings from the last test. Used at startup.
+.RE
+
+.SH FILES
+.I /etc/fxotune.conf
+.RS
+The configuration file generated by fxotune in detect mode and from which
+configuration is loaded when 
+.B -s
+is used.
+
+.SH SEE ALSO 
+ztcfg(8), zttool(8), ztmonitor(8), asterisk(8). 
+
+.SH AUTHOR 
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+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/torisatool.8 b/doc/torisatool.8
new file mode 100755
index 0000000..b6acfc1
--- /dev/null
+++ b/doc/torisatool.8
@@ -0,0 +1,29 @@
+.TH ztspeed 8 "2005-9-10" 
+.SH NAME 
+torisatool \(em get errors from a Tormenta ISA card
+.SH SYNOPSIS 
+.B torisatool 
+.I chanenl
+.B showerrors
+
+.SH DESCRIPTION 
+.B torisatool
+is a tool to list errors from a Tormenta ISA E1/T1 Zaptel adapter
+(normally used with the Asterisk(8) PBX).
+
+.SH OPTIONS
+.B channel
+zaptel channel number to check. 
+
+.SH SEE ALSO 
+zttool(8), ztmonitor(8), zttest(8), ztcfg(8), ztspeed(8), asterisk(8). 
+
+.SH AUTHOR 
+
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+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/ztspeed.8 b/doc/ztspeed.8
new file mode 100755
index 0000000..bbe097b
--- /dev/null
+++ b/doc/ztspeed.8
@@ -0,0 +1,26 @@
+.TH ztspeed 8 "2005-06-25" 
+.SH NAME 
+ztspeed \(em A generic speed test
+.SH SYNOPSIS 
+.B ztspeed
+
+.SH DESCRIPTION 
+.B ztspeed
+runs a simple 100% CPU loop for 5 seconds to see how many loops are
+performed. Used to measure how much CPU zaptel \fBreally\fR is taking.
+
+.SH OPTIONS
+None. Nothing else to see.
+
+.SH SEE ALSO 
+zttool(8), ztmonitor(8), zttest(8), ztcfg(8), asterisk(8). 
+
+.SH AUTHOR 
+
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+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/zttest.8 b/doc/zttest.8
new file mode 100755
index 0000000..79b1772
--- /dev/null
+++ b/doc/zttest.8
@@ -0,0 +1,45 @@
+.TH zttest 8 "2005-06-25" 
+.SH "NAME" 
+zttest \(em Test if the zaptel timer provides timely response
+.SH "SYNOPSIS" 
+.B zttest 
+.I [ -v ]
+
+.SH "DESCRIPTION" 
+.B zttest
+zttest runs a timing test in a loop and prints the result of each loop.
+The test is as follows:
+
+It reads 8192 bytes from the zaptel timer device (\fI/dev/zap/pseudo\fR). 
+This should take exactly 8000 ms . It uses calls to
+.I gettimeofday(2) 
+before and after that read to check that indeed exactly 8000ms have passed.
+
+Values of 100% and 99.99% Are normally considered a definite 
+.I pass.
+Values of 99.98% and 99.97% are probably OK as well.
+
+.SH OPTIONS
+.B -v
+.RS
+Be more verbose: print one line per test.
+.RE
+
+.SH FILES
+.B /dev/zap/pseudo
+.RS
+.RE
+The device file used to access the zaptel timer.
+
+.SH SEE ALSO 
+zttool(8), ztmonitor(8), ztspeed(8), ztcfg(8), asterisk(8). gettimeofday(2)
+
+.SH AUTHOR 
+
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+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.