Man page for dahdi_maint

Fix dahdi_maint's usage message while we're at it.

Signed-off-by: Tzafrir Cohen <tzafrir.cohen@xorcom.com>

git-svn-id: http://svn.astersk.org/svn/dahdi/tools/trunk@10198 17933a7a-c749-41c5-a318-cba88f637d49
This commit is contained in:
Tzafrir Cohen 2011-09-09 13:45:00 +00:00
parent b487a96ada
commit 2d576dcea0
2 changed files with 68 additions and 4 deletions

View File

@ -53,12 +53,14 @@ void display_help(char *argv0, int exitcode)
fprintf(stderr, " -h, --help display help\n"); fprintf(stderr, " -h, --help display help\n");
fprintf(stderr, " -s, --span <span num> specify the span\n"); fprintf(stderr, " -s, --span <span num> specify the span\n");
fprintf(stderr, " -l, --loopback <localhost|networkline|"\ fprintf(stderr, " -l, --loopback <localhost|networkline|"\
"networkpayload|off>\n"\ "networkpayload|loopup|"\
"loopdown|off>\n"\
"\t\tlocalhost - loop back towards host\n"\ "\t\tlocalhost - loop back towards host\n"\
"\t\tnetworkline - network line loopback\n"\ "\t\tnetworkline - network line loopback\n"\
"\t\tnetworkpayload - network payload loopback\n"\ "\t\tnetworkpayload - network payload loopback\n"\
"\t\tloopup - transmit loopup signal\n"\ "\t\tloopup - transmit loopup signal\n"\
"\t\tloopdown - transmit loopdown signal\n"); "\t\tloopdown - transmit loopdown signal\n"\
"\t\toff - end loopback mode\n");
fprintf(stderr, " -i, --insert <fas|multi|crc|cas|prbs|bipolar>"\ fprintf(stderr, " -i, --insert <fas|multi|crc|cas|prbs|bipolar>"\
"\n\t\tinsert an error of a specific type\n"); "\n\t\tinsert an error of a specific type\n");
fprintf(stderr, " -r, --reset "\ fprintf(stderr, " -r, --reset "\
@ -107,10 +109,10 @@ int main(int argc, char *argv[])
while ((c = getopt_long(argc, argv, "hj:l:p:s:i:g:r", while ((c = getopt_long(argc, argv, "hj:l:p:s:i:g:r",
long_options, &option_index)) != -1) { long_options, &option_index)) != -1) {
switch (c) { switch (c) {
case 'h': /* local host loopback */ case 'h':
display_help(argv[0], 0); display_help(argv[0], 0);
break; break;
case 'l': /* network line loopback */ case 'l': /* loopback */
larg = optarg; larg = optarg;
doloopback = 1; doloopback = 1;
break; break;

62
doc/dahdi_maint.8 Normal file
View File

@ -0,0 +1,62 @@
.TH "DAHDI_MAINT" "8" "9 Sep 2011" "" ""
.SH NAME
dahdi_maint \- Sets Dahdi spans into maintenance mode, e.g.: loopback
.SH SYNOPSIS
.B dahdi_maint \-s \fInum\fB [options]
.B dahdi_maint <\-h|\-\-help>
.SH DESCRIPTION
dahdi_maint uses the DAHDI_MAINT interface to set a Dahdi span (port
of a Dahdi adapter card) into loopback mode or similar maintenance mode.
.SH OPTIONS
.B \-s \-\-span \fInum\fR
.RS
The span number. Required.
.RE
.B \-l \-\-loopback <localhost|networkline|networkpayload|loopup|loopdown|off>
.RS
Loopback type. One of:
.IP localhost 4
loop back towards host
.IP networkline 4
network line loopback
.IP networkpayload 4
network payload loopback
.IP loopup 4
transmit loopup signal
.IP loopdown 4
transmit loopdown signal
.IP off 4
end loopback mode
.RE
.B \-i \-\-insert <fas|multi|crc|cas|prbs|bipolar>
.RS
Insert an error of a specific type
.RE
.SH EXAMPLES
Enable network line loopback on span 1:
dahdi_maint -s 1 --loopback networkline
Disable network line loopback on span 1:
dahdi_maint -s 1 --loopback off
.SH SEE ALSO
.PP
dahdi_tool(8), dahdi_cfg(8), asterisk(8).
.SH AUTHOR
.PP
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.