configure.ac: add libusb/libusbx support (for xpp)
[dahdi/tools.git] / xpp / astribank_allow.8
1 .TH "ASTRIBANK_ALLOW" "8" "29 March 2009" "" ""
2
3 .SH NAME
4 astribank_allow \- License Xorcom Astribank (xpp) capabilities.
5 .SH SYNOPSIS
6 .B astribank_allow \-D \fIdevice-path\fR [ options ]
7
8 .B astribank_allow [\-h]
9
10 .SH DESCRIPTION
11 Modern Astribanks (with USB product id's 116x) contain capabilities
12 that may be licensed.
13
14 .B astribank_allow
15 is used to upload/download the licensing information to/from the device.
16
17 Uploading a valid license file to an Astribank, changes its capabilities.
18 The change becomes effective after a firmware reset (either by powering
19 the device off and on again, or via the \fBastribank_tool\fR full reset option).
20
21 Downloading license from the device, produces a valid license file for its
22 current capabilities. This may be backed up, so the device may be later
23 restored to its previous capabilities.
24
25 The license file contains both a human readable description of the
26 device capabilities for the end user and a hash of the licensing
27 information used by Xorcom to generate/modify licensed capabilities.
28
29 .SH OPTIONS
30 .B \-D
31 .I device-path
32 .RS
33 Required. The device to read from/write to. This is
34 \fIbus_num\fR/\fIdevice_num\fR, where \fIbus_num\fR and \fIdevice_num\fR
35 are the first two numbers in the output of lsusb(8) or dahdi_hardware(8).
36 On older versions of this tool you needed a complete path to the device,
37 which would be /dev/bus/usb/\fIbus_num\fR/\fIdevice_num\fR, or
38 /proc/bus/usb/\fIbus_num\fR/\fIdevice_num\fR.
39 .RE
40
41 .B \-w
42 .RS
43 Write capabilities to EEPROM, otherwise read capabilities
44 .RE
45
46 .B \-f \fIfilename\fR
47 .RS
48 License filename (stdin/stdout if not specified)
49 .RE
50
51 .B \-m \fInum\fR
52 .RS
53 Choose the numeric code of license markers to generate.
54 This code select the type of \fIBEGIN\fR.../\fIEND\fR... strings
55 that delimit the license body.
56
57 Valid marker codes are listed with the \fB-h\fR option.
58 The default (and first) code is \fB1\fR. Zero is illegal value.
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), astribank_tool(8)
78
79 .SH AUTHOR
80 Alex Landau