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