configure.ac: add libusb/libusbx support (for xpp)
[dahdi/tools.git] / xpp / astribank_tool.8
1 .TH "ASTRIBANK_TOOL" "8" "29 March 2009" "" ""
2
3 .SH NAME
4 astribank_tool \- Xorcom Astribank (xpp) control tool
5 .SH SYNOPSIS
6 .B astribank_tool [ options ] [ operation... ] \-D \fIdevice-path\fR
7
8 .B astribank_tool [\-h]
9
10 .SH DESCRIPTION
11 .B astribank_tool
12 is a tool to control the USB-level functionality of an Astribank.
13 The tool operates on a single Astribank at a time (given as parameter
14 to the \-D command line option).
15
16 .SH OPTIONS
17 .B \-D 
18 .I device-path
19 .RS
20 Required. The device to read from/write to. This is
21 \fIbus_num\fR/\fIdevice_num\fR, where \fIbus_num\fR and \fIdevice_num\fR
22 are the first two numbers in the output of lsusb(8) or dahdi_hardware(8).
23 On older versions of this tool you needed a complete path to the device,
24 which would be /dev/bus/usb/\fIbus_num\fR/\fIdevice_num\fR, or
25 /proc/bus/usb/\fIbus_num\fR/\fIdevice_num\fR.
26 .RE
27
28 .B \-p \fInum\fR
29 .RS
30 Set the TwinStar port number. Either 0 or 1.
31
32 (TODO: explain).
33 .RE
34
35 .B \-r \fItype\fR
36 .RS
37 Reset the Astribank and renumerate its USB connection to power on product ID.
38
39 Tyep can be: \fBhalf\fR or \fBfull\fR.
40
41 (TODO: explain those).
42 .RE
43
44 .B \-w 0|1
45 .RS
46 Enable (1) or disable (0) the TwinStar watchdog. When enabled, the
47 Astribank will jump to the second port if this system is "not working"
48 and the system on the second port is available.
49 .RE
50
51 .B \-Q
52 .RS
53 Query astribank properties via MPP protocol.
54 .RE
55
56 .B \-n
57 .RS
58 Renumerate the Astribank product number (e.g: from 1161 to 1162).
59 .RE
60
61 .B \-v
62 .RS
63 Increase verbosity. May be used multiple times.
64 .RE
65
66 .B \-d \fImask\fR
67 .RS
68 Set debug mask to \fImask\fR. Default is 0, 0xFF is "everything".
69 .RE
70
71 .B \-h
72 .RS
73 Displays usage message.
74 .RE
75
76 .SH SEE ALSO
77 fxload(8), lsusb(8), astribank_hexload(8)
78
79 .SH AUTHOR
80 This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
81 Permission is granted to copy, distribute and/or modify this document under
82 the terms of the GNU General Public License, Version 2 any 
83 later version published by the Free Software Foundation.
84
85 On Debian systems, the complete text of the GNU General Public
86 License can be found in /usr/share/common\-licenses/GPL.