| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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 | |
| Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 76 | server:# modprobe usbip-host |
| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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 | |