diff options
| author | Valentina Manea <valentina.manea.m@gmail.com> | 2014-08-20 00:30:59 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2014-08-25 13:38:56 -0400 |
| commit | 588b48caf65c4a92af567948ec0025065e749ddf (patch) | |
| tree | 6cf9771e522864db1685ffd7cabd31439fe93305 /tools/usb/usbip/doc | |
| parent | 1ddb55275d8489d0ecd4722a997531cf26a035cb (diff) | |
usbip: move usbip userspace code out of staging
At this point, USB/IP userspace code is fully functional
and can be moved out of staging.
Signed-off-by: Valentina Manea <valentina.manea.m@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'tools/usb/usbip/doc')
| -rw-r--r-- | tools/usb/usbip/doc/usbip.8 | 95 | ||||
| -rw-r--r-- | tools/usb/usbip/doc/usbipd.8 | 91 |
2 files changed, 186 insertions, 0 deletions
diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8 new file mode 100644 index 000000000000..a6097be25d28 --- /dev/null +++ b/tools/usb/usbip/doc/usbip.8 | |||
| @@ -0,0 +1,95 @@ | |||
| 1 | .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" | ||
| 2 | .SH NAME | ||
| 3 | usbip \- manage USB/IP devices | ||
| 4 | .SH SYNOPSIS | ||
| 5 | .B usbip | ||
| 6 | [\fIoptions\fR] <\fIcommand\fR> <\fIargs\fR> | ||
| 7 | |||
| 8 | .SH DESCRIPTION | ||
| 9 | On a USB/IP server, devices can be listed, bound, and unbound using | ||
| 10 | this program. On a USB/IP client, devices exported by USB/IP servers | ||
| 11 | can be listed, attached and detached. | ||
| 12 | |||
| 13 | .SH OPTIONS | ||
| 14 | .HP | ||
| 15 | \fB\-\-debug\fR | ||
| 16 | .IP | ||
| 17 | Print debugging information. | ||
| 18 | .PP | ||
| 19 | |||
| 20 | .HP | ||
| 21 | \fB\-\-log\fR | ||
| 22 | .IP | ||
| 23 | Log to syslog. | ||
| 24 | .PP | ||
| 25 | |||
| 26 | .HP | ||
| 27 | \fB\-\-tcp-port PORT\fR | ||
| 28 | .IP | ||
| 29 | Connect to PORT on remote host (used for attach and list --remote). | ||
| 30 | .PP | ||
| 31 | |||
| 32 | .SH COMMANDS | ||
| 33 | .HP | ||
| 34 | \fBversion\fR | ||
| 35 | .IP | ||
| 36 | Show version and exit. | ||
| 37 | .PP | ||
| 38 | |||
| 39 | .HP | ||
| 40 | \fBhelp\fR [\fIcommand\fR] | ||
| 41 | .IP | ||
| 42 | Print the program help message, or help on a specific command, and | ||
| 43 | then exit. | ||
| 44 | .PP | ||
| 45 | |||
| 46 | .HP | ||
| 47 | \fBattach\fR \-\-remote=<\fIhost\fR> \-\-busid=<\fIbus_id\fR> | ||
| 48 | .IP | ||
| 49 | Attach a remote USB device. | ||
| 50 | .PP | ||
| 51 | |||
| 52 | .HP | ||
| 53 | \fBdetach\fR \-\-port=<\fIport\fR> | ||
| 54 | .IP | ||
| 55 | Detach an imported USB device. | ||
| 56 | .PP | ||
| 57 | |||
| 58 | .HP | ||
| 59 | \fBbind\fR \-\-busid=<\fIbusid\fR> | ||
| 60 | .IP | ||
| 61 | Make a device exportable. | ||
| 62 | .PP | ||
| 63 | |||
| 64 | .HP | ||
| 65 | \fBunbind\fR \-\-busid=<\fIbusid\fR> | ||
| 66 | .IP | ||
| 67 | Stop exporting a device so it can be used by a local driver. | ||
| 68 | .PP | ||
| 69 | |||
| 70 | .HP | ||
| 71 | \fBlist\fR \-\-remote=<\fIhost\fR> | ||
| 72 | .IP | ||
| 73 | List USB devices exported by a remote host. | ||
| 74 | .PP | ||
| 75 | |||
| 76 | .HP | ||
| 77 | \fBlist\fR \-\-local | ||
| 78 | .IP | ||
| 79 | List local USB devices. | ||
| 80 | .PP | ||
| 81 | |||
| 82 | |||
| 83 | .SH EXAMPLES | ||
| 84 | |||
| 85 | client:# usbip list --remote=server | ||
| 86 | - List exportable usb devices on the server. | ||
| 87 | |||
| 88 | client:# usbip attach --remote=server --busid=1-2 | ||
| 89 | - Connect the remote USB device. | ||
| 90 | |||
| 91 | client:# usbip detach --port=0 | ||
| 92 | - Detach the usb device. | ||
| 93 | |||
| 94 | .SH "SEE ALSO" | ||
| 95 | \fBusbipd\fP\fB(8)\fB\fP | ||
diff --git a/tools/usb/usbip/doc/usbipd.8 b/tools/usb/usbip/doc/usbipd.8 new file mode 100644 index 000000000000..ac4635db3f03 --- /dev/null +++ b/tools/usb/usbip/doc/usbipd.8 | |||
| @@ -0,0 +1,91 @@ | |||
| 1 | .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" | ||
| 2 | .SH NAME | ||
| 3 | usbipd \- USB/IP server daemon | ||
| 4 | .SH SYNOPSIS | ||
| 5 | .B usbipd | ||
| 6 | [\fIoptions\fR] | ||
| 7 | |||
| 8 | .SH DESCRIPTION | ||
| 9 | .B usbipd | ||
| 10 | provides USB/IP clients access to exported USB devices. | ||
| 11 | |||
| 12 | Devices have to explicitly be exported using | ||
| 13 | .B usbip bind | ||
| 14 | before usbipd makes them available to other hosts. | ||
| 15 | |||
| 16 | The daemon accepts connections from USB/IP clients | ||
| 17 | on TCP port 3240 by default. | ||
| 18 | |||
| 19 | .SH OPTIONS | ||
| 20 | .HP | ||
| 21 | \fB\-4\fR, \fB\-\-ipv4\fR | ||
| 22 | .IP | ||
| 23 | Bind to IPv4. Default is both. | ||
| 24 | .PP | ||
| 25 | |||
| 26 | .HP | ||
| 27 | \fB\-6\fR, \fB\-\-ipv6\fR | ||
| 28 | .IP | ||
| 29 | Bind to IPv6. Default is both. | ||
| 30 | .PP | ||
| 31 | |||
| 32 | .HP | ||
| 33 | \fB\-D\fR, \fB\-\-daemon\fR | ||
| 34 | .IP | ||
| 35 | Run as a daemon process. | ||
| 36 | .PP | ||
| 37 | |||
| 38 | .HP | ||
| 39 | \fB\-d\fR, \fB\-\-debug\fR | ||
| 40 | .IP | ||
| 41 | Print debugging information. | ||
| 42 | .PP | ||
| 43 | |||
| 44 | .HP | ||
| 45 | \fB\-PFILE\fR, \fB\-\-pid FILE\fR | ||
| 46 | .IP | ||
| 47 | Write process id to FILE. | ||
| 48 | .br | ||
| 49 | If no FILE specified, use /var/run/usbipd.pid | ||
| 50 | .PP | ||
| 51 | |||
| 52 | \fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR | ||
| 53 | .IP | ||
| 54 | Listen on TCP/IP port PORT. | ||
| 55 | .PP | ||
| 56 | |||
| 57 | \fB\-h\fR, \fB\-\-help\fR | ||
| 58 | .IP | ||
| 59 | Print the program help message and exit. | ||
| 60 | .PP | ||
| 61 | |||
| 62 | .HP | ||
| 63 | \fB\-v\fR, \fB\-\-version\fR | ||
| 64 | .IP | ||
| 65 | Show version. | ||
| 66 | .PP | ||
| 67 | |||
| 68 | .SH LIMITATIONS | ||
| 69 | |||
| 70 | .B usbipd | ||
| 71 | offers no authentication or authorization for USB/IP. Any | ||
| 72 | USB/IP client can connect and use exported devices. | ||
| 73 | |||
| 74 | .SH EXAMPLES | ||
| 75 | |||
| 76 | server:# modprobe usbip | ||
| 77 | |||
| 78 | server:# usbipd -D | ||
| 79 | - Start usbip daemon. | ||
| 80 | |||
| 81 | server:# usbip list --local | ||
| 82 | - List driver assignments for usb devices. | ||
| 83 | |||
| 84 | server:# usbip bind --busid=1-2 | ||
| 85 | - Bind usbip-host.ko to the device of busid 1-2. | ||
| 86 | - A usb device 1-2 is now exportable to other hosts! | ||
| 87 | - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally. | ||
| 88 | |||
| 89 | .SH "SEE ALSO" | ||
| 90 | \fBusbip\fP\fB(8)\fB\fP | ||
| 91 | |||
