| 1 |
.TH sane\-v4l 5 "14 Jul 2008" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-v4l |
| 3 |
.SH NAME |
| 4 |
sane\-v4l \- SANE interface for Video for Linux API |
| 5 |
.SH DESCRIPTION |
| 6 |
The |
| 7 |
.B sane\-v4l |
| 8 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 9 |
provides generic access to video cameras and similar equipment using |
| 10 |
the V4L (Video for Linux) API. |
| 11 |
.PP |
| 12 |
This is ALPHA software. Really! Important features are missing and there are |
| 13 |
lots of bugs. The code is currently only tested on a Linux 2.4 system with a |
| 14 |
Hauppauge WinTV video card. |
| 15 |
.PP |
| 16 |
.SH "DEVICE NAMES" |
| 17 |
This backend expects device names of the form: |
| 18 |
.PP |
| 19 |
.RS |
| 20 |
.I special |
| 21 |
.RE |
| 22 |
.PP |
| 23 |
Where |
| 24 |
.I special |
| 25 |
is the UNIX path-name for the special device that corresponds to the |
| 26 |
v4l device. The special device name must be a v4l device or a symlink |
| 27 |
to such a device. For example, such a device name could be |
| 28 |
.I /dev/video0 |
| 29 |
or |
| 30 |
.IR /dev/bttv0 . |
| 31 |
.SH CONFIGURATION |
| 32 |
The contents of the |
| 33 |
.I v4l.conf |
| 34 |
file is a list of device names that correspond to v4l |
| 35 |
devices. Empty lines and lines starting with a hash mark (#) are |
| 36 |
ignored. A sample configuration file is shown below: |
| 37 |
.PP |
| 38 |
.RS |
| 39 |
/dev/bttv0 |
| 40 |
.br |
| 41 |
# this is a comment |
| 42 |
.br |
| 43 |
/dev/video3 |
| 44 |
.RE |
| 45 |
.SH FILES |
| 46 |
.TP |
| 47 |
.I /etc/sane.d/v4l.conf |
| 48 |
The backend configuration file (see also description of |
| 49 |
.B SANE_CONFIG_DIR |
| 50 |
below). |
| 51 |
.TP |
| 52 |
.I /usr/lib64/sane/libsane\-v4l.a |
| 53 |
The static library implementing this backend. |
| 54 |
.TP |
| 55 |
.I /usr/lib64/sane/libsane\-v4l.so |
| 56 |
The shared library implementing this backend (present on systems that |
| 57 |
support dynamic loading). |
| 58 |
.SH ENVIRONMENT |
| 59 |
.TP |
| 60 |
.B SANE_CONFIG_DIR |
| 61 |
This environment variable specifies the list of directories that may |
| 62 |
contain the configuration file. On *NIX systems, the directories are |
| 63 |
separated by a colon (`:'), under OS/2, they are separated by a |
| 64 |
semi-colon (`;'). If this variable is not set, the configuration file |
| 65 |
is searched in two default directories: first, the current working |
| 66 |
directory (".") and then in |
| 67 |
.IR /etc/sane.d . |
| 68 |
If the value of the |
| 69 |
environment variable ends with the directory separator character, then |
| 70 |
the default directories are searched after the explicitly specified |
| 71 |
directories. For example, setting |
| 72 |
.B SANE_CONFIG_DIR |
| 73 |
to "/tmp/config:" would result in directories |
| 74 |
.IR tmp/config , |
| 75 |
.IR . , |
| 76 |
and |
| 77 |
.I /etc/sane.d |
| 78 |
being searched (in this order). |
| 79 |
.TP |
| 80 |
.B SANE_DEBUG_V4L |
| 81 |
If the library was compiled with debug support enabled, this |
| 82 |
environment variable controls the debug level for this backend. E.g., |
| 83 |
a value of 128 requests all debug output to be printed. Smaller |
| 84 |
levels reduce verbosity. |
| 85 |
.SH AUTHOR |
| 86 |
Juergen G. Schimmer, Henning Meier-Geinitz |
| 87 |
|
| 88 |
.SH BUGS: |
| 89 |
If more than one video card is present, a crash may occur. Frequency and geometry |
| 90 |
selection is missing. |
| 91 |
.br |
| 92 |
Send bug reports to the SANE mailing list: |
| 93 |
.IR sane\[email protected] . |
| 94 |
You must be subscribed to the list to send mail. See |
| 95 |
.I http://www.sane\-project.org/mailing\-lists.html |
| 96 |
for details. |
| 97 |
|
| 98 |
.SH SEE ALSO |
| 99 |
.BR sane (7), |
| 100 |
.BR xcam (1) |