diff options
Diffstat (limited to 'tools/usb/usbip/doc/usbip.8')
-rw-r--r-- | tools/usb/usbip/doc/usbip.8 | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8 new file mode 100644 index 000000000000..a6097be25d28 --- /dev/null +++ b/tools/usb/usbip/doc/usbip.8 | |||
@@ -0,0 +1,95 @@ | |||
1 | .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" | ||
2 | .SH NAME | ||
3 | usbip \- manage USB/IP devices | ||
4 | .SH SYNOPSIS | ||
5 | .B usbip | ||
6 | [\fIoptions\fR] <\fIcommand\fR> <\fIargs\fR> | ||
7 | |||
8 | .SH DESCRIPTION | ||
9 | On a USB/IP server, devices can be listed, bound, and unbound using | ||
10 | this program. On a USB/IP client, devices exported by USB/IP servers | ||
11 | can be listed, attached and detached. | ||
12 | |||
13 | .SH OPTIONS | ||
14 | .HP | ||
15 | \fB\-\-debug\fR | ||
16 | .IP | ||
17 | Print debugging information. | ||
18 | .PP | ||
19 | |||
20 | .HP | ||
21 | \fB\-\-log\fR | ||
22 | .IP | ||
23 | Log to syslog. | ||
24 | .PP | ||
25 | |||
26 | .HP | ||
27 | \fB\-\-tcp-port PORT\fR | ||
28 | .IP | ||
29 | Connect to PORT on remote host (used for attach and list --remote). | ||
30 | .PP | ||
31 | |||
32 | .SH COMMANDS | ||
33 | .HP | ||
34 | \fBversion\fR | ||
35 | .IP | ||
36 | Show version and exit. | ||
37 | .PP | ||
38 | |||
39 | .HP | ||
40 | \fBhelp\fR [\fIcommand\fR] | ||
41 | .IP | ||
42 | Print the program help message, or help on a specific command, and | ||
43 | then exit. | ||
44 | .PP | ||
45 | |||
46 | .HP | ||
47 | \fBattach\fR \-\-remote=<\fIhost\fR> \-\-busid=<\fIbus_id\fR> | ||
48 | .IP | ||
49 | Attach a remote USB device. | ||
50 | .PP | ||
51 | |||
52 | .HP | ||
53 | \fBdetach\fR \-\-port=<\fIport\fR> | ||
54 | .IP | ||
55 | Detach an imported USB device. | ||
56 | .PP | ||
57 | |||
58 | .HP | ||
59 | \fBbind\fR \-\-busid=<\fIbusid\fR> | ||
60 | .IP | ||
61 | Make a device exportable. | ||
62 | .PP | ||
63 | |||
64 | .HP | ||
65 | \fBunbind\fR \-\-busid=<\fIbusid\fR> | ||
66 | .IP | ||
67 | Stop exporting a device so it can be used by a local driver. | ||
68 | .PP | ||
69 | |||
70 | .HP | ||
71 | \fBlist\fR \-\-remote=<\fIhost\fR> | ||
72 | .IP | ||
73 | List USB devices exported by a remote host. | ||
74 | .PP | ||
75 | |||
76 | .HP | ||
77 | \fBlist\fR \-\-local | ||
78 | .IP | ||
79 | List local USB devices. | ||
80 | .PP | ||
81 | |||
82 | |||
83 | .SH EXAMPLES | ||
84 | |||
85 | client:# usbip list --remote=server | ||
86 | - List exportable usb devices on the server. | ||
87 | |||
88 | client:# usbip attach --remote=server --busid=1-2 | ||
89 | - Connect the remote USB device. | ||
90 | |||
91 | client:# usbip detach --port=0 | ||
92 | - Detach the usb device. | ||
93 | |||
94 | .SH "SEE ALSO" | ||
95 | \fBusbipd\fP\fB(8)\fB\fP | ||