tools/usb/usbip/doc/usbipd.8

   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\-e\fR, \fB\-\-device\fR
  34 .IP
  35 Run in device mode. Rather than drive an attached device, create a virtual UDC to bind gadgets to.
  36 .PP
  37
  38 .HP
  39 \fB\-D\fR, \fB\-\-daemon\fR
  40 .IP
  41 Run as a daemon process.
  42 .PP
  43
  44 .HP
  45 \fB\-d\fR, \fB\-\-debug\fR
  46 .IP
  47 Print debugging information.
  48 .PP
  49
  50 .HP
  51 \fB\-PFILE\fR, \fB\-\-pid FILE\fR
  52 .IP
  53 Write process id to FILE.
  54 .br
  55 If no FILE specified, use /var/run/usbipd.pid
  56 .PP
  57
  58 \fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR
  59 .IP
  60 Listen on TCP/IP port PORT.
  61 .PP
  62
  63 \fB\-h\fR, \fB\-\-help\fR
  64 .IP
  65 Print the program help message and exit.
  66 .PP
  67
  68 .HP
  69 \fB\-v\fR, \fB\-\-version\fR
  70 .IP
  71 Show version.
  72 .PP
  73
  74 .SH LIMITATIONS
  75
  76 .B usbipd
  77 offers no authentication or authorization for USB/IP. Any
  78 USB/IP client can connect and use exported devices.
  79
  80 .SH EXAMPLES
  81
  82     server:# modprobe usbip-host
  83
  84     server:# usbipd -D
  85         - Start usbip daemon.
  86
  87     server:# usbip list --local
  88         - List driver assignments for usb devices.
  89
  90     server:# usbip bind --busid=1-2
  91         - Bind usbip-host.ko to the device of busid 1-2.
  92         - A usb device 1-2 is now exportable to other hosts!
  93         - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
  94
  95 The following example shows the usage of device mode
  96
  97     server:# modprobe usbip-vudc
  98         - Use /sys/class/udc/ interface.
  99         - usbip-host is independent of this module.
 100
 101     server:# usbipd -e -D
 102         - Start usbip daemon in device mode.
 103
 104     server:# modprobe g_mass_storage file=/tmp/tmp.img
 105         - Bind a gadget to usbip-vudc.
 106         - in this example, a mass storage gadget is bound.
 107
 108     server:# usbip list --device
 109         - List gadgets exported by local usbipd server.
 110
 111     server:# modprobe -r g_mass_storage
 112         - Unbind a gadget from usbip-vudc.
 113         - in this example, the previous mass storage gadget is unbound.
 114
 115 .SH "SEE ALSO"
 116 \fBusbip\fP\fB(8)\fB\fP
 117