diff options
Diffstat (limited to 'drivers/staging/usbip/userspace/doc/usbip.8')
-rw-r--r-- | drivers/staging/usbip/userspace/doc/usbip.8 | 66 |
1 files changed, 42 insertions, 24 deletions
diff --git a/drivers/staging/usbip/userspace/doc/usbip.8 b/drivers/staging/usbip/userspace/doc/usbip.8 index 1653bb2cd7d..6e0d7450379 100644 --- a/drivers/staging/usbip/userspace/doc/usbip.8 +++ b/drivers/staging/usbip/userspace/doc/usbip.8 @@ -3,69 +3,87 @@ usbip \- manage USB/IP devices .SH SYNOPSIS .B usbip -[\fIoptions\fR] +[\foptions\R] <\fIcommand\fR> <\fIargs\fR> .SH DESCRIPTION -Devices exported by USB/IP servers can be listed, attached and -detached using this program. +On a USB/IP server, devices can be listed, bound, and unbound using +this program. On a USB/IP client, devices exported by USB/IP servers +can be listed, attached and detached. .SH OPTIONS .HP -\fB\-a\fR, \fB\-\-attach\fR <host> <bus_id> +\fB\-\-debug\fR .IP -Attach a remote USB device. +Print debugging information. +.PP + +.HP +\fB\-\-log\fR +.IP +Log to syslog. +.PP + +.SH COMMANDS +.HP +\fBversion\fR +.IP +Show version and exit. .PP .HP -\fB\-x\fR, \fB\-\-attachall\fR <host> +\fBhelp\fR [\fIcommand\fR] .IP -Attach all remote USB devices on the specific host. +Print the program help message, or help on a specific command, and +then exit. .PP .HP -\fB\-d\fR, \fB\-\-detach\fR <ports> +\fBattach\fR \-\-host=<\fIhost\fR> \-\-busid=<\fIbus_id\fR> +.IP +Attach a remote USB device. +.PP + +.HP +\fBdetach\fR \-\-port=<\fIport\fR> .IP Detach an imported USB device. .PP .HP -\fB\-l\fR, \fB\-\-list\fR <hosts> +\fBbind\fR \-\-busid=<\fIbusid\fR> .IP -List exported USB devices. +Make a device exportable. .PP .HP -\fB\-p\fR, \fB\-\-port\fR +\fBunbind\fR \-\-busid=<\fIbusid\fR> .IP -List virtual USB port status. +Stop exporting a device so it can be used by a local driver. .PP .HP -\fB\-D\fR, \fB\-\-debug\fR +\fBlist\fR \-\-remote=<\fIhost\fR> .IP -Print debugging information. +List USB devices exported by a remote host. .PP .HP -\fB\-v\fR, \fB\-\-version\fR +\fBlist\fR \-\-local .IP -Show version. +List local USB devices. .PP + .SH EXAMPLES - client:# usbip --list server + client:# usbip list --remote=server - List exportable usb devices on the server. - client:# usbip --attach server 1-2 + client:# usbip attach --host=server --busid=1-2 - Connect the remote USB device. - client:# usbip --port - - Show virtual port status. - - client:# usbip --detach 0 + client:# usbip detach --port=0 - Detach the usb device. .SH "SEE ALSO" -\fBusbipd\fP\fB(8)\fB\fP, -\fBusbip_attach_driver\fP\fB(8)\fB\fP +\fBusbipd\fP\fB(8)\fB\fP |