-
Notifications
You must be signed in to change notification settings - Fork 12
/
webcamd.8
254 lines (254 loc) · 6.79 KB
/
webcamd.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
.\"
.\" Copyright (c) 2010 Dru Lavigne <dru@freebsd.org>
.\"
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"
.Dd April 4, 2023
.Dt WEBCAMD 8
.Os FreeBSD
.Sh NAME
.Nm webcamd
.Nd daemon which provide access to USB webcam, USB DVB, USB radio, USB input, USB tablet and more devices
.Sh SYNOPSIS
.Nm
.Op Fl B
.Op Fl D Ar <host:port:ndev>
.Op Fl L Ar <host:port:ndev>
.Op Fl U Ar <user>
.Op Fl G Ar <group>
.Op Fl M Ar <matchindex>
.Op Fl N Ar <devicename>
.Op Fl S Ar <deviceserialnumber>
.Op Fl d Ar [ugen]<unit>.<addr>
.Op Fl i Ar <interface or client number>
.Op Fl v Ar <video device number>
.Op Fl c Ar <devname>
.Op Fl m Ar <parameter>=<value>
.Op Fl r
.Op Fl l
.Op Fl s
.Op Fl h
.Sh DESCRIPTION
.Nm
is a daemon that enables the use of hundreds of different USB webcam,
USB DVB, USB radio, USB input, USB tablet and more devices under the
FreeBSD operating system.
The
.Nm
daemon is basically a port of Linux USB device drivers into userspace
in FreeBSD.
.Pp
.Nm
requires the
.Xr cuse 3
kernel module.
To load the driver as a module at boot time, place the following line
in
.Xr loader.conf 5 :
.Pp
cuse_load="YES"
.Pp
To start
.Nm
automatically at system startup, place the following line in
.Xr rc.conf 5 :
.Pp
webcamd_enable="YES"
.Pp
Once
.Nm
is running, supported USB devices will be available for use by other applications.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl B
Run the daemon in background mode.
.It Fl d
Specify the <unit>.<addr> of the USB device to use.
This option can be combined with -N and -S options.
.It Fl f
If the device requires a firmware file, specify the path to the firmware.
The default firmware path is /boot/modules.
.It Fl h
Print help text showing available options.
.It Fl m
Specify the value of a parameter.
Note that escaping is not supported for strings.
.It Fl i
Specify the interface number to use.
.It Fl r
Do not set realtime priority.
.It Fl S
Attach to device matching the given serial number.
This option can be combined with -d and -N options.
.It Fl M
Specify the match index when using -S and -N options.
This option is useful when multiple USB devices share the same serial
and devicename to be able to distinguish them.
Default is zero.
.It Fl N
Attach to device matching the given device name.
This option can be combined with -d and -S options.
.It Fl l
List the available USB devices and the needed command line for binding
to the given device.
.It Fl s
Show available parameters.
.It Fl v
Specify the video device number.
.It Fl c
Create device of specified type. Valid values: v4l2loopback
For multiple v4l2loopback devices, specify
.Bd -literal -offset indent
-m v4l2loopback.devices=2
.Ed
.It Fl U
Set the user identification for all character devices created by webcamd.
Default value: webcamd
.It Fl G
Set the group identification for all character devices created by webcamd.
Default value: webcamd
.It Fl D
Enable vTuner client support.
Connect to one or more remote DVB device instead of using USB.
The vTuner protocol needs eight ports for normal operation which are allocated back to back.
One port for control communication and the other port for data communication.
NOTE: If you want to start multiple vTuner clients in the background by use of the
.Fl B
option, you need to supply a unique interface number for each client using th
.Fl i
option.
.It Fl L
Enable vTuner server support.
Make the DVB device available on TCP/IP instead of
.Xr cuse 3 .
If the ndev parameter is negative, all present DVB devices
are mapped to TCP/IP.
Else only the given number of DVB devices are mapped.
The vTuner protocol needs eight ports for normal operation which are allocated back to back.
One port for control communication and the other port for data communication.
.El
.Sh EXAMPLES
With the USB device connected, determine the [ugen]<unit>.<addr> values using
.Xr usbconfig 8 :
.Pp
.Bd -literal -offset indent
usbconfig
ugen7.2: <product 0x0991 vendor 0x046d> at usbus7, cfg=0 md=HOST spd=HIGH (480Mbps) pwr=ON
.Ed
.Pp
Create a vTuner client:
.Bd -literal -offset indent
webcamd -D 127.0.0.1:5100:1:2
.Ed
.Pp
Create a vTuner server:
.Bd -literal -offset indent
webcamd -L 127.0.0.1:5100:-1
.Ed
.Pp
Create two V4L2 loopback devices:
.Bd -literal -offset indent
webcamd -c v4l2loopback -m v4l2loopback.devices=2
.Ed
.Pp
.Sh NOTES
All character devices are created using the 0660 mode which gives the user and group read and write permissions.
.Sh FILES
.Bl -tag -compact
.It Pa /usr/local/etc/devd/webcamd.conf
.It Pa /usr/local/etc/rc.d/webcamd
.It Pa /var/run/webcamd.*.0.pid
.El
.Sh SEE ALSO
.Xr a800 4 ,
.Xr af9005 4 ,
.Xr af9015 4 ,
.Xr anysee 4 ,
.Xr au0828 4 ,
.Xr au6610 4 ,
.Xr b2c2 4 ,
.Xr benq 4 ,
.Xr ce6230 4 ,
.Xr cinergy 4 ,
.Xr conex 4 ,
.Xr cpiax 4 ,
.Xr cxusb 4 ,
.Xr dib0700 4 ,
.Xr digitv 4 ,
.Xr dtt200u 4 ,
.Xr dtv5100 4 ,
.Xr dw2102 4 ,
.Xr ec168 4 ,
.Xr em28xx 4 ,
.Xr et61x251 4 ,
.Xr finepix 4 ,
.Xr friio 4 ,
.Xr gl860 4 ,
.Xr gl861 4 ,
.Xr gp8psk 4 ,
.Xr hdpvr 4 ,
.Xr ibmcam 4 ,
.Xr jeilinj 4 ,
.Xr m5602 4 ,
.Xr m920x 4 ,
.Xr mars 4 ,
.Xr mr800 4 ,
.Xr mr97310a 4 ,
.Xr nova-t 4 ,
.Xr opera1 4 ,
.Xr ov519 4 ,
.Xr ov534 4 ,
.Xr pacxxx 4 ,
.Xr pvrusb2 4 ,
.Xr pwc 4 ,
.Xr s2255 4 ,
.Xr se401 4 ,
.Xr siano 4 ,
.Xr sn9c102 4 ,
.Xr sn9c20x 4 ,
.Xr sonixj 4 ,
.Xr spca5xx 4 ,
.Xr sq905c 4 ,
.Xr stk014 4 ,
.Xr stv06xx 4 ,
.Xr sunplus 4 ,
.Xr t613 4 ,
.Xr ttusb2 4 ,
.Xr tv8532 4 ,
.Xr umt 4 ,
.Xr usbvision 4 ,
.Xr uvc 4 ,
.Xr vc032x 4 ,
.Xr vp702x 4 ,
.Xr vp7045 4 ,
.Xr zc3xx 4 ,
.Xr zr364xx 4
.Sh AUTHORS
.Nm
was written by
.An Hans Petter Selasky hselasky@freebsd.org . This man page was written by
Dru Lavigne dru@freebsd.org.
.Pp