1 .TH USBIP "8" "February 2009" "usbip" "System 1 .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
2 .SH NAME 2 .SH NAME
3 usbip \- manage USB/IP devices 3 usbip \- manage USB/IP devices
4 .SH SYNOPSIS 4 .SH SYNOPSIS
5 .B usbip 5 .B usbip
6 [\fIoptions\fR] <\fIcommand\fR> <\fIargs\fR> 6 [\fIoptions\fR] <\fIcommand\fR> <\fIargs\fR>
7 7
8 .SH DESCRIPTION 8 .SH DESCRIPTION
9 On a USB/IP server, devices can be listed, bou 9 On a USB/IP server, devices can be listed, bound, and unbound using
10 this program. On a USB/IP client, devices exp 10 this program. On a USB/IP client, devices exported by USB/IP servers
11 can be listed, attached and detached. 11 can be listed, attached and detached.
12 12
13 .SH OPTIONS 13 .SH OPTIONS
14 .HP 14 .HP
15 \fB\-\-debug\fR 15 \fB\-\-debug\fR
16 .IP 16 .IP
17 Print debugging information. 17 Print debugging information.
18 .PP 18 .PP
19 19
20 .HP 20 .HP
21 \fB\-\-log\fR 21 \fB\-\-log\fR
22 .IP 22 .IP
23 Log to syslog. 23 Log to syslog.
24 .PP 24 .PP
25 25
26 .HP 26 .HP
27 \fB\-\-tcp-port PORT\fR 27 \fB\-\-tcp-port PORT\fR
28 .IP 28 .IP
29 Connect to PORT on remote host (used for attac 29 Connect to PORT on remote host (used for attach and list --remote).
30 .PP 30 .PP
31 31
32 .SH COMMANDS 32 .SH COMMANDS
33 .HP 33 .HP
34 \fBversion\fR 34 \fBversion\fR
35 .IP 35 .IP
36 Show version and exit. 36 Show version and exit.
37 .PP 37 .PP
38 38
39 .HP 39 .HP
40 \fBhelp\fR [\fIcommand\fR] 40 \fBhelp\fR [\fIcommand\fR]
41 .IP 41 .IP
42 Print the program help message, or help on a s 42 Print the program help message, or help on a specific command, and
43 then exit. 43 then exit.
44 .PP 44 .PP
45 45
46 .HP 46 .HP
47 \fBattach\fR \-\-remote=<\fIhost\fR> \-\-busid 47 \fBattach\fR \-\-remote=<\fIhost\fR> \-\-busid=<\fIbus_id\fR>
48 .IP 48 .IP
49 Attach a remote USB device. 49 Attach a remote USB device.
50 .PP 50 .PP
51 51
52 .HP 52 .HP
53 \fBattach\fR \-\-remote=<\fIhost\fR> \-\-devic 53 \fBattach\fR \-\-remote=<\fIhost\fR> \-\-device=<\fIdev_id\fR>
54 .IP 54 .IP
55 Attach a remote USB gadget. 55 Attach a remote USB gadget.
56 Only used when the remote usbipd is in device 56 Only used when the remote usbipd is in device mode.
57 .PP 57 .PP
58 58
59 .HP 59 .HP
60 \fBdetach\fR \-\-port=<\fIport\fR> 60 \fBdetach\fR \-\-port=<\fIport\fR>
61 .IP 61 .IP
62 Detach an imported USB device/gadget. 62 Detach an imported USB device/gadget.
63 .PP 63 .PP
64 64
65 .HP 65 .HP
66 \fBbind\fR \-\-busid=<\fIbusid\fR> 66 \fBbind\fR \-\-busid=<\fIbusid\fR>
67 .IP 67 .IP
68 Make a device exportable. 68 Make a device exportable.
69 .PP 69 .PP
70 70
71 .HP 71 .HP
72 \fBunbind\fR \-\-busid=<\fIbusid\fR> 72 \fBunbind\fR \-\-busid=<\fIbusid\fR>
73 .IP 73 .IP
74 Stop exporting a device so it can be used by a 74 Stop exporting a device so it can be used by a local driver.
75 .PP 75 .PP
76 76
77 .HP 77 .HP
78 \fBlist\fR \-\-remote=<\fIhost\fR> 78 \fBlist\fR \-\-remote=<\fIhost\fR>
79 .IP 79 .IP
80 List USB devices exported by a remote host. 80 List USB devices exported by a remote host.
81 .PP 81 .PP
82 82
83 .HP 83 .HP
84 \fBlist\fR \-\-device 84 \fBlist\fR \-\-device
85 .IP 85 .IP
86 List USB gadgets of local usbip-vudc. 86 List USB gadgets of local usbip-vudc.
87 Only used when the local usbipd is in device m 87 Only used when the local usbipd is in device mode.
88 Note that this can not list usbip-vudc USB gad 88 Note that this can not list usbip-vudc USB gadgets of the remote device mode usbipd.
89 .PP 89 .PP
90 90
91 .HP 91 .HP
92 \fBlist\fR \-\-local 92 \fBlist\fR \-\-local
93 .IP 93 .IP
94 List local USB devices. 94 List local USB devices.
95 .PP 95 .PP
96 96
97 .HP 97 .HP
98 \fBport\fR 98 \fBport\fR
99 .IP 99 .IP
100 List imported devices/gadgets. 100 List imported devices/gadgets.
101 .PP 101 .PP
102 102
103 103
104 .SH EXAMPLES 104 .SH EXAMPLES
105 105
106 client:# usbip list --remote=server 106 client:# usbip list --remote=server
107 - List devices exported by remote serv 107 - List devices exported by remote server.
108 108
109 client:# modprobe vhci-hcd 109 client:# modprobe vhci-hcd
110 110
111 client:# usbip attach --remote=server --bu 111 client:# usbip attach --remote=server --busid=1-2
112 - Connect the remote USB device. 112 - Connect the remote USB device.
113 113
114 client:# usbip port 114 client:# usbip port
115 - List imported devices/gadgets. 115 - List imported devices/gadgets.
116 116
117 client:# usbip detach --port=0 117 client:# usbip detach --port=0
118 - Detach the usb device. 118 - Detach the usb device.
119 119
120 The following example shows the usage of devic 120 The following example shows the usage of device mode
121 121
122 server:# usbip list --device 122 server:# usbip list --device
123 - List gadgets exported by local usbip 123 - List gadgets exported by local usbipd server.
124 124
125 client:# modprobe vhci-hcd 125 client:# modprobe vhci-hcd
126 126
127 client:# usbip attach --remote=server --de 127 client:# usbip attach --remote=server --device=usbip-vudc.0
128 - Connect the remote USB gadget. 128 - Connect the remote USB gadget.
129 129
130 client:# usbip port 130 client:# usbip port
131 - List imported devices/gadgets. 131 - List imported devices/gadgets.
132 132
133 client:# usbip detach --port=0 133 client:# usbip detach --port=0
134 - Detach the usb gadget. 134 - Detach the usb gadget.
135 135
136 .SH "SEE ALSO" 136 .SH "SEE ALSO"
137 \fBusbipd\fP\fB(8)\fB\fP 137 \fBusbipd\fP\fB(8)\fB\fP
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.