Commit 4faf3a8d authored by W. Trevor King's avatar W. Trevor King Committed by Greg Kroah-Hartman

staging: usbip: userspace: update man pages for v1.0.0

This brings them back up to date after:

  commit e9837bbb
  Author: matt mooney <mfm@muteddisk.com>
  Date:   Thu May 26 06:17:11 2011 -0700

    staging: usbip: userspace tools v1.0.0

I couldn't find a current equivalent for

  client:# usbip --port

Perhaps that functionality has been deprecated due to better logging.
It seems like libsrc/usbip_common.h's usbip_status_string is no longer
used.
Signed-off-by: default avatarW. Trevor King <wking@tremily.us>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ce591f76
......@@ -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
.TH USBIP_BIND_DRIVER "8" "February 2009" "usbip" "System Administration Utilities"
.SH NAME
usbip_bind_driver \- change driver binding for USB/IP
.SH SYNOPSIS
.B usbip_bind_driver
[\fIoptions\fR]
.SH DESCRIPTION
Driver bindings for USB devices can be changed using
this program. It is used to export and unexport USB
devices over USB/IP.
.SH OPTIONS
.TP
\fB\-u\fR, \fB\-\-usbip\fR <busid>
Make a device exportable
.TP
\fB\-o\fR, \fB\-\-other\fR <busid>
Use a device by a local driver
.TP
\fB\-l\fR, \fB\-\-list\fR
Print usb devices and their drivers
.TP
\fB\-L\fR, \fB\-\-list2\fR
Print usb devices and their drivers in parseable mode
.SH EXAMPLES
server:# usbip_bind_driver --list
- List driver assignments for usb devices.
server:# usbip_bind_driver --usbip 1-2
- Bind usbip-host.ko to the device of busid 1-2.
- A usb device 1-2 is now exportable to other hosts!
server:# usbip_bind_driver --other 1-2
- Shutdown exporting and use the device locally.
.SH "SEE ALSO"
\fBusbip\fP\fB(8)\fB\fP,
\fBusbipd\fP\fB(8)\fB\fP
......@@ -10,7 +10,7 @@ usbipd \- USB/IP server daemon
provides USB/IP clients access to exported USB devices.
Devices have to explicitly be exported using
.B usbip_bind_driver
.B usbip bind
before usbipd makes them available to other hosts.
The daemon accepts connections from USB/IP clients
......@@ -29,6 +29,11 @@ Run as a daemon process.
Print debugging information.
.PP
\fB\-h\fR, \fB\-\-help\fR
.IP
Print the program help message and exit.
.PP
.HP
\fB\-v\fR, \fB\-\-version\fR
.IP
......@@ -48,15 +53,14 @@ USB/IP client can connect and use exported devices.
server:# usbipd -D
- Start usbip daemon.
server:# usbip_bind_driver --list
server:# usbip list --local
- List driver assignments for usb devices.
server:# usbip_bind_driver --usbip 1-2
server:# usbip bind --busid=1-2
- Bind usbip-host.ko to the device of busid 1-2.
- A usb device 1-2 is now exportable to other hosts!
- Use 'usbip_bind_driver --other 1-2' when you want to shutdown exporting and use the device locally.
- Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
.SH "SEE ALSO"
\fBusbip\fP\fB(8)\fB\fP,
\fBusbip_attach_driver\fP\fB(8)\fB\fP
\fBusbip\fP\fB(8)\fB\fP
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment