vgrabbj purpose is to read data from a v4l-device and put it in a file,
formatted as jpeg, png, or pnm. Except for the ftp-options described
below everything can also handled on the commandline.
Here the configuration statements are described.
Syntax is <keyword> <value>. Comments start with a ';' or '#'. Those
lines are ignored by vgrabbj. Case of the keywords and named options
doesn't matter except for the timestamp option as well as any filename.
The configuration file is parsed line by line. If any keyword appears
twice or more often, the last one is the one used.
On startup, the pre-defined configuration file /etc/vgrabbj.conf is
read. Then, commandline parameters are evaluated one by one, the last is
the most significant, if one option is provide twice or more often.
Same applies for the commandline parameter -c <config-file>.
GENERAL OPTIONS
DaemonSecondsseconds
Daemonize & loop with seconds intervals (min. 1).
Daemonmicroseconds
Daemonize & loop microseconds intervals (min. 1). Same as -l
except you can control it more precisely.
BrightnessOn|Off
Defines if vgrabbj's brightness adjustment is used. This option works only
if the device supports data fetch via read and RGB24 videopalette. See
ForcePalette on how-to set RGB24. Some device do not support RGB24,
hence, Brightness is ignored.
Qualityquality
Sets the quality of a jpeg output to quality (1-100, default: 75).
ImageSizeimagesize
Sets the imagesize of input device, where imagesize is one of:
Sets the width of the image to width. Needs -H.
The v4l-device has to support the image width you set with
this option.
ImageHeightheight
Sets the height of the image to height. Needs -w.
The v4l-device has to support the image height you set with
this option.
OutputFormatformat
Sets the output to format (either jpeg, png, or pnm, default: jpeg). Alternative, you may provide jpg for
jpeg.
OutputFile <filename>
Output is written to filename (default: /dev/stdout)
Archive <path/filename>
Additional output is written to path/filename (default: not set),
whereas the path-filename can include any strftime component. The path-
filename must not be on a different filesystem as the output defined above.
Additionally, you need to take care of the number of files stored. There is
no upper ceiling for archiving.
VideoDevice <device>
Sets the input device to device (default: /dev/video)
OpenOnceOn|Off
Defines if vgrabbj opens the device only while image data is grabbed
(Off) or keeps it opened while it is running (On).
Setting it to Off is helpful if you need access to the device besides
vgrabbj. This use is discouraged though, due to possible problems with memory
fragmentation. Default is On.
SetImageSizeOn|Off
Defines if the image size (see -i, -H, and -w) of the
device is set by vgrabbj. Necessary for certain v4l-devices which do not
support to be set to a particular image size (e.g. IBM-usb-cam, QuickCam).
For these devices you have to specify the size at module load time.
Default is On.
SwitchColorOn|Off
Switches colormap from BGR to RGB (or vice versa) if set to On. Default
is Off. Use if you have odd colors.
SwapRLOn|Off
Swaps left and right of the image like a mirror.. Default
is Off.
NoUseMmapOn|Off
Turns off the use of mmap'ed (better) memory allocation for grabbing frames.
Some (very rare) cams cannot use mmap'ed memory and have to use read. If you
want to switch easily, use this switch. If you don't know what I'm talking
about, leafe it like it is: Default is Off.
DebugLevelvalue
Sets the loglevel of vgrabbj. Valid for value are 0, 2, 3, 4, 6, 7
(default: 4). 0 means no messages at all, 7 is debug. Don't use 7 if
you are running vgrabbj in daemon mode, it'll surely fill your syslog.
Be aware, that loglevel 7 will also post you ftp-password (if defined)
in the logfile!
UseTmpOutOn|Off
Sets the use of the temporary outputfile. Default is On. Ignored in case
the default output (/dev/stdout) is used. If set to Off, the data
is written directly to the file defined by OutputFile.
If filename is different from /dev/stdout (given via -f
parameter or OutputFile, vgrabbj defaults to use a temporary file called filename.tmp to write the image. This file is then renamed to filename to shorten the time period corrupt data may be read from filename.
ForcePalettepalette
Force the usage of the specified palette. If palette is not
supported by either vgrabbj or the v4l-device, fallback to a palette
supported by both is provided. If no common denominator is available, vgrabbj
exits. Supported palettes are marked with * below. Possible values are (copy
from videodev.h):
value images are grabbed and immediately discarded. Only the
last image is written to the output. This might be helpful if your v4l-device
needs to take a couple of images to auto-adjust to the current light.
TIMESTAMP OPTIONS
The following options are available only if vgrabbj was compiled with
the freetype library available. The timestamp will only be enabled if
you all values evaluated (inlcuding defaults) lead to a valid configuration.
FontFilefilename
The TrueType font to be used for the timestamp
(default /usr/X11R6/lib/X11/fonts/TrueType/Arialn.ttf).
FontSizesize
Set the fontsize to size for timestamp (3-100, default: 12).
TimeStampformat-str
Defines the timestamp. format-str can be plain text or any
strftime format. Any '""' at the beginning or the end will be eliminated
for compatibility reasons, i.e. they are not necessary (default: "%a, %e.
%B %Y - %T" - see strftime(3) for details).
Positionvalue
Alignment of the timestamp in the image. Possible value:
ul = upper left, ur = upper right,
ll = lower left, lr = lower right,
uc = upper center, lc = lower center
(default: upper right). You can use either the short or the long version.
Blendvalue
Defines the blend between font background and image (1-100, default: 60).
BorderSizevalue
value pixels will be used as border around the timestamp string (1-255,
default: 2).
FTP OPTIONS
There are no options for ftp-upload on the command line. This is due to the need
to provide a password which would be visible via the ps(1) command.
EnableFtpOn|Off
Ftp-Connection will only be opened if set to On. Be aware that this
might bring up a dial-up connection. See KeepAlive.
RemoteHosthostname
Host to which a ftp-connection will be established everytime an image has
been written (see also: Daemon, DaemonSeconds, KeepAlive,
no default).
RemoteImagefilename
The filename consists of the full path and filename on the remote host
defined by RemoteHost (no default).
Usernameusername
The name of the user to log on the remote ftp-server (no default).
Passwordpassword
The password of the user to log on the remote ftp-server (no default).
KeepAliveOn|Off
If set to On, the connection will be kept. This will cause a dial-up
line to be up all the time, which in turn may cost a lot of money! If set
to Off, the connection will be established after an image was written
to the OutputFile. After transmission, the ftp-connection will be ended.
This may also result in phone charges, for which Author takes no responsibility.
See License.
This manual page was originally written by Michael Janssen
<janssen@cns.uni.edu>, for the Debian GNU/Linux system and enhanced by
Jens Gecius <devel@gecius.de>.