Loading...
1.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
2.SH NAME
3usbipd \- USB/IP server daemon
4.SH SYNOPSIS
5.B usbipd
6[\fIoptions\fR]
7
8.SH DESCRIPTION
9.B usbipd
10provides USB/IP clients access to exported USB devices.
11
12Devices have to explicitly be exported using
13.B usbip bind
14before usbipd makes them available to other hosts.
15
16The daemon accepts connections from USB/IP clients
17on TCP port 3240 by default.
18
19.SH OPTIONS
20.HP
21\fB\-4\fR, \fB\-\-ipv4\fR
22.IP
23Bind to IPv4. Default is both.
24.PP
25
26.HP
27\fB\-6\fR, \fB\-\-ipv6\fR
28.IP
29Bind to IPv6. Default is both.
30.PP
31
32.HP
33\fB\-e\fR, \fB\-\-device\fR
34.IP
35Run 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
41Run as a daemon process.
42.PP
43
44.HP
45\fB\-d\fR, \fB\-\-debug\fR
46.IP
47Print debugging information.
48.PP
49
50.HP
51\fB\-PFILE\fR, \fB\-\-pid FILE\fR
52.IP
53Write process id to FILE.
54.br
55If no FILE specified, use /var/run/usbipd.pid
56.PP
57
58\fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR
59.IP
60Listen on TCP/IP port PORT.
61.PP
62
63\fB\-h\fR, \fB\-\-help\fR
64.IP
65Print the program help message and exit.
66.PP
67
68.HP
69\fB\-v\fR, \fB\-\-version\fR
70.IP
71Show version.
72.PP
73
74.SH LIMITATIONS
75
76.B usbipd
77offers no authentication or authorization for USB/IP. Any
78USB/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
95The 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
1.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
2.SH NAME
3usbipd \- USB/IP server daemon
4.SH SYNOPSIS
5.B usbipd
6[\fIoptions\fR]
7
8.SH DESCRIPTION
9.B usbipd
10provides USB/IP clients access to exported USB devices.
11
12Devices have to explicitly be exported using
13.B usbip bind
14before usbipd makes them available to other hosts.
15
16The daemon accepts connections from USB/IP clients
17on TCP port 3240 by default.
18
19.SH OPTIONS
20.HP
21\fB\-4\fR, \fB\-\-ipv4\fR
22.IP
23Bind to IPv4. Default is both.
24.PP
25
26.HP
27\fB\-6\fR, \fB\-\-ipv6\fR
28.IP
29Bind to IPv6. Default is both.
30.PP
31
32.HP
33\fB\-D\fR, \fB\-\-daemon\fR
34.IP
35Run as a daemon process.
36.PP
37
38.HP
39\fB\-d\fR, \fB\-\-debug\fR
40.IP
41Print debugging information.
42.PP
43
44.HP
45\fB\-PFILE\fR, \fB\-\-pid FILE\fR
46.IP
47Write process id to FILE.
48.br
49If no FILE specified, use /var/run/usbipd.pid
50.PP
51
52\fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR
53.IP
54Listen on TCP/IP port PORT.
55.PP
56
57\fB\-h\fR, \fB\-\-help\fR
58.IP
59Print the program help message and exit.
60.PP
61
62.HP
63\fB\-v\fR, \fB\-\-version\fR
64.IP
65Show version.
66.PP
67
68.SH LIMITATIONS
69
70.B usbipd
71offers no authentication or authorization for USB/IP. Any
72USB/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