Skip to content

Commit

Permalink
---
Browse files Browse the repository at this point in the history
yaml
---
r: 324605
b: refs/heads/master
c: 4faf3a8
h: refs/heads/master
i:
  324603: 7e2957d
v: v3
  • Loading branch information
W. Trevor King authored and Greg Kroah-Hartman committed Aug 17, 2012
1 parent d446d6a commit 73a1550
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 73 deletions.
2 changes: 1 addition & 1 deletion [refs]
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
---
refs/heads/master: ce591f76c79da49389091a2f62597c88b8a29374
refs/heads/master: 4faf3a8d1838b86e7b66441da9a088f347e1c56b
66 changes: 42 additions & 24 deletions trunk/drivers/staging/usbip/userspace/doc/usbip.8
Original file line number Diff line number Diff line change
Expand Up @@ -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
42 changes: 0 additions & 42 deletions trunk/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8

This file was deleted.

16 changes: 10 additions & 6 deletions trunk/drivers/staging/usbip/userspace/doc/usbipd.8
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

0 comments on commit 73a1550

Please sign in to comment.