summaryrefslogtreecommitdiff
path: root/doc/zttest.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zttest.8')
-rwxr-xr-xdoc/zttest.845
1 files changed, 45 insertions, 0 deletions
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.