usbipd.8 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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. .SH DESCRIPTION
  8. .B usbipd
  9. provides USB/IP clients access to exported USB devices.
  10. Devices have to explicitly be exported using
  11. .B usbip bind
  12. before usbipd makes them available to other hosts.
  13. The daemon accepts connections from USB/IP clients
  14. on TCP port 3240 by default.
  15. .SH OPTIONS
  16. .HP
  17. \fB\-4\fR, \fB\-\-ipv4\fR
  18. .IP
  19. Bind to IPv4. Default is both.
  20. .PP
  21. .HP
  22. \fB\-6\fR, \fB\-\-ipv6\fR
  23. .IP
  24. Bind to IPv6. Default is both.
  25. .PP
  26. .HP
  27. \fB\-e\fR, \fB\-\-device\fR
  28. .IP
  29. Run in device mode. Rather than drive an attached device, create a virtual UDC to bind gadgets to.
  30. .PP
  31. .HP
  32. \fB\-D\fR, \fB\-\-daemon\fR
  33. .IP
  34. Run as a daemon process.
  35. .PP
  36. .HP
  37. \fB\-d\fR, \fB\-\-debug\fR
  38. .IP
  39. Print debugging information.
  40. .PP
  41. .HP
  42. \fB\-PFILE\fR, \fB\-\-pid FILE\fR
  43. .IP
  44. Write process id to FILE.
  45. .br
  46. If no FILE specified, use /var/run/usbipd.pid
  47. .PP
  48. \fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR
  49. .IP
  50. Listen on TCP/IP port PORT.
  51. .PP
  52. \fB\-h\fR, \fB\-\-help\fR
  53. .IP
  54. Print the program help message and exit.
  55. .PP
  56. .HP
  57. \fB\-v\fR, \fB\-\-version\fR
  58. .IP
  59. Show version.
  60. .PP
  61. .SH LIMITATIONS
  62. .B usbipd
  63. offers no authentication or authorization for USB/IP. Any
  64. USB/IP client can connect and use exported devices.
  65. .SH EXAMPLES
  66. server:# modprobe usbip-host
  67. server:# usbipd -D
  68. - Start usbip daemon.
  69. server:# usbip list --local
  70. - List driver assignments for usb devices.
  71. server:# usbip bind --busid=1-2
  72. - Bind usbip-host.ko to the device of busid 1-2.
  73. - A usb device 1-2 is now exportable to other hosts!
  74. - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
  75. The following example shows the usage of device mode
  76. server:# modprobe usbip-vudc
  77. - Use /sys/class/udc/ interface.
  78. - usbip-host is independent of this module.
  79. server:# usbipd -e -D
  80. - Start usbip daemon in device mode.
  81. server:# modprobe g_mass_storage file=/tmp/tmp.img
  82. - Bind a gadget to usbip-vudc.
  83. - in this example, a mass storage gadget is bound.
  84. server:# usbip list --device
  85. - List gadgets exported by local usbipd server.
  86. server:# modprobe -r g_mass_storage
  87. - Unbind a gadget from usbip-vudc.
  88. - in this example, the previous mass storage gadget is unbound.
  89. .SH "SEE ALSO"
  90. \fBusbip\fP\fB(8)\fB\fP