5d2e31f1affe6c9e995a3f0fec3fddd247b8af46
[xscreensaver] / driver / xscreensaver-getimage-video.man
1 .TH XScreenSaver 1 "12-May-2004 (4.16)" "X Version 11"
2 .SH NAME
3 xscreensaver-getimage-video - put a video frame on the root window
4 .SH SYNOPSIS
5 .B xscreensaver-getimage-video
6 [\-display \fIhost:display.screen\fP] [\--verbose] [\--stdout]
7 .SH DESCRIPTION
8 The \fIxscreensaver\-getimage\-video\fP program is a helper program
9 for the xscreensaver hacks that manipulate images.  Specifically, it
10 is invoked by
11 .BR xscreensaver\-getimage (1)
12 as needed.  This is not a user-level command.
13
14 This program grabs a random frame of video from the system's video input,
15 and then loads it on the root window.  It does this by figuring out which
16 frame-grabbing programs are installed on the system, and invoking the
17 first one it finds.   Then it runs
18 .BR xscreensaver\-getimage\-file (1)
19 to load that image onto the root window.
20 .SH OPTIONS
21 .I xscreensaver-getimage-video
22 accepts the following options:
23 .TP 4
24 .B --verbose
25 Print diagnostics.
26 .TP 4
27 .B --stdout
28 Instead of loading the image onto the root window, write it to stdout
29 as a PBM file.
30 .SH SEE ALSO
31 .BR X (1),
32 .BR xscreensaver (1),
33 .BR xscreensaver\-demo (1),
34 .BR xscreensaver\-getimage (1),
35 .BR xscreensaver\-getimage\-file (1),
36 .BR bttvgrab (1),
37 .BR qcam (1),
38 .BR streamer (1),
39 .BR atitv (1),
40 .BR vidtomem (1)
41 .SH COPYRIGHT
42 Copyright \(co 2001 by Jamie Zawinski.  Permission to use, copy,
43 modify, distribute, and sell this software and its documentation for
44 any purpose is hereby granted without fee, provided that the above
45 copyright notice appear in all copies and that both that copyright
46 notice and this permission notice appear in supporting documentation.
47 No representations are made about the suitability of this software for
48 any purpose.  It is provided "as is" without express or implied
49 warranty.
50 .SH AUTHOR
51 Jamie Zawinski <jwz@jwz.org>, 14-Apr-01