aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2012-08-17 06:49:37 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2012-08-17 12:44:04 -0400
commit4faf3a8d1838b86e7b66441da9a088f347e1c56b (patch)
tree94b7d9edd94f03d080b273f51bf5283cacf91920
parentce591f76c79da49389091a2f62597c88b8a29374 (diff)
staging: usbip: userspace: update man pages for v1.0.0
This brings them back up to date after: commit e9837bbb3e694eef4c55c934ebf1f8a0399b142c 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: W. Trevor King <wking@tremily.us> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r--drivers/staging/usbip/userspace/doc/usbip.866
-rw-r--r--drivers/staging/usbip/userspace/doc/usbip_bind_driver.842
-rw-r--r--drivers/staging/usbip/userspace/doc/usbipd.816
3 files changed, 52 insertions, 72 deletions
diff --git a/drivers/staging/usbip/userspace/doc/usbip.8 b/drivers/staging/usbip/userspace/doc/usbip.8
index 1653bb2cd7d1..6e0d74503792 100644
--- a/drivers/staging/usbip/userspace/doc/usbip.8
+++ b/drivers/staging/usbip/userspace/doc/usbip.8
@@ -3,69 +3,87 @@
3usbip \- manage USB/IP devices 3usbip \- manage USB/IP devices
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B usbip 5.B usbip
6[\fIoptions\fR] 6[\foptions\R] <\fIcommand\fR> <\fIargs\fR>
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9Devices exported by USB/IP servers can be listed, attached and 9On a USB/IP server, devices can be listed, bound, and unbound using
10detached using this program. 10this program. On a USB/IP client, devices exported by USB/IP servers
11can be listed, attached and detached.
11 12
12.SH OPTIONS 13.SH OPTIONS
13.HP 14.HP
14\fB\-a\fR, \fB\-\-attach\fR <host> <bus_id> 15\fB\-\-debug\fR
15.IP 16.IP
16Attach a remote USB device. 17Print debugging information.
18.PP
19
20.HP
21\fB\-\-log\fR
22.IP
23Log to syslog.
24.PP
25
26.SH COMMANDS
27.HP
28\fBversion\fR
29.IP
30Show version and exit.
17.PP 31.PP
18 32
19.HP 33.HP
20\fB\-x\fR, \fB\-\-attachall\fR <host> 34\fBhelp\fR [\fIcommand\fR]
21.IP 35.IP
22Attach all remote USB devices on the specific host. 36Print the program help message, or help on a specific command, and
37then exit.
23.PP 38.PP
24 39
25.HP 40.HP
26\fB\-d\fR, \fB\-\-detach\fR <ports> 41\fBattach\fR \-\-host=<\fIhost\fR> \-\-busid=<\fIbus_id\fR>
42.IP
43Attach a remote USB device.
44.PP
45
46.HP
47\fBdetach\fR \-\-port=<\fIport\fR>
27.IP 48.IP
28Detach an imported USB device. 49Detach an imported USB device.
29.PP 50.PP
30 51
31.HP 52.HP
32\fB\-l\fR, \fB\-\-list\fR <hosts> 53\fBbind\fR \-\-busid=<\fIbusid\fR>
33.IP 54.IP
34List exported USB devices. 55Make a device exportable.
35.PP 56.PP
36 57
37.HP 58.HP
38\fB\-p\fR, \fB\-\-port\fR 59\fBunbind\fR \-\-busid=<\fIbusid\fR>
39.IP 60.IP
40List virtual USB port status. 61Stop exporting a device so it can be used by a local driver.
41.PP 62.PP
42 63
43.HP 64.HP
44\fB\-D\fR, \fB\-\-debug\fR 65\fBlist\fR \-\-remote=<\fIhost\fR>
45.IP 66.IP
46Print debugging information. 67List USB devices exported by a remote host.
47.PP 68.PP
48 69
49.HP 70.HP
50\fB\-v\fR, \fB\-\-version\fR 71\fBlist\fR \-\-local
51.IP 72.IP
52Show version. 73List local USB devices.
53.PP 74.PP
54 75
76
55.SH EXAMPLES 77.SH EXAMPLES
56 78
57 client:# usbip --list server 79 client:# usbip list --remote=server
58 - List exportable usb devices on the server. 80 - List exportable usb devices on the server.
59 81
60 client:# usbip --attach server 1-2 82 client:# usbip attach --host=server --busid=1-2
61 - Connect the remote USB device. 83 - Connect the remote USB device.
62 84
63 client:# usbip --port 85 client:# usbip detach --port=0
64 - Show virtual port status.
65
66 client:# usbip --detach 0
67 - Detach the usb device. 86 - Detach the usb device.
68 87
69.SH "SEE ALSO" 88.SH "SEE ALSO"
70\fBusbipd\fP\fB(8)\fB\fP, 89\fBusbipd\fP\fB(8)\fB\fP
71\fBusbip_attach_driver\fP\fB(8)\fB\fP
diff --git a/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8 b/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8
deleted file mode 100644
index d43bbd6be934..000000000000
--- a/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8
+++ /dev/null
@@ -1,42 +0,0 @@
1.TH USBIP_BIND_DRIVER "8" "February 2009" "usbip" "System Administration Utilities"
2.SH NAME
3usbip_bind_driver \- change driver binding for USB/IP
4
5.SH SYNOPSIS
6.B usbip_bind_driver
7[\fIoptions\fR]
8
9.SH DESCRIPTION
10Driver bindings for USB devices can be changed using
11this program. It is used to export and unexport USB
12devices over USB/IP.
13
14.SH OPTIONS
15.TP
16\fB\-u\fR, \fB\-\-usbip\fR <busid>
17Make a device exportable
18.TP
19\fB\-o\fR, \fB\-\-other\fR <busid>
20Use a device by a local driver
21.TP
22\fB\-l\fR, \fB\-\-list\fR
23Print usb devices and their drivers
24.TP
25\fB\-L\fR, \fB\-\-list2\fR
26Print usb devices and their drivers in parseable mode
27
28.SH EXAMPLES
29
30 server:# usbip_bind_driver --list
31 - List driver assignments for usb devices.
32
33 server:# usbip_bind_driver --usbip 1-2
34 - Bind usbip-host.ko to the device of busid 1-2.
35 - A usb device 1-2 is now exportable to other hosts!
36
37 server:# usbip_bind_driver --other 1-2
38 - Shutdown exporting and use the device locally.
39
40.SH "SEE ALSO"
41\fBusbip\fP\fB(8)\fB\fP,
42\fBusbipd\fP\fB(8)\fB\fP
diff --git a/drivers/staging/usbip/userspace/doc/usbipd.8 b/drivers/staging/usbip/userspace/doc/usbipd.8
index 006559f1df25..d896936f1780 100644
--- a/drivers/staging/usbip/userspace/doc/usbipd.8
+++ b/drivers/staging/usbip/userspace/doc/usbipd.8
@@ -10,7 +10,7 @@ usbipd \- USB/IP server daemon
10provides USB/IP clients access to exported USB devices. 10provides USB/IP clients access to exported USB devices.
11 11
12Devices have to explicitly be exported using 12Devices have to explicitly be exported using
13.B usbip_bind_driver 13.B usbip bind
14before usbipd makes them available to other hosts. 14before usbipd makes them available to other hosts.
15 15
16The daemon accepts connections from USB/IP clients 16The daemon accepts connections from USB/IP clients
@@ -29,6 +29,11 @@ Run as a daemon process.
29Print debugging information. 29Print debugging information.
30.PP 30.PP
31 31
32\fB\-h\fR, \fB\-\-help\fR
33.IP
34Print the program help message and exit.
35.PP
36
32.HP 37.HP
33\fB\-v\fR, \fB\-\-version\fR 38\fB\-v\fR, \fB\-\-version\fR
34.IP 39.IP
@@ -48,15 +53,14 @@ USB/IP client can connect and use exported devices.
48 server:# usbipd -D 53 server:# usbipd -D
49 - Start usbip daemon. 54 - Start usbip daemon.
50 55
51 server:# usbip_bind_driver --list 56 server:# usbip list --local
52 - List driver assignments for usb devices. 57 - List driver assignments for usb devices.
53 58
54 server:# usbip_bind_driver --usbip 1-2 59 server:# usbip bind --busid=1-2
55 - Bind usbip-host.ko to the device of busid 1-2. 60 - Bind usbip-host.ko to the device of busid 1-2.
56 - A usb device 1-2 is now exportable to other hosts! 61 - A usb device 1-2 is now exportable to other hosts!
57 - Use 'usbip_bind_driver --other 1-2' when you want to shutdown exporting and use the device locally. 62 - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
58 63
59.SH "SEE ALSO" 64.SH "SEE ALSO"
60\fBusbip\fP\fB(8)\fB\fP, 65\fBusbip\fP\fB(8)\fB\fP
61\fBusbip_attach_driver\fP\fB(8)\fB\fP
62 66