http://www.jwz.org/xscreensaver/xscreensaver-5.07.tar.gz
[xscreensaver] / hacks / xanalogtv.man
1 .TH XScreenSaver 1 "10-Oct-03" "X Version 11"
2 .SH NAME
3 xanalogtv - Simulate reception on an old analog TV set
4 .SH SYNOPSIS
5 .B xanalogtv
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] 
8 [\-cycle] [\-no-cycle]
9 [\-fps]
10 .SH DESCRIPTION
11 .I xanalogtv
12 shows a simulation of an old TV set showing test patterns and any
13 other images you have provided. It reproduces a wide range of TV
14 reception bummage: snow, bloom, ghosting, and loss of vertical and
15 horizontal sync. It also simulates the TV warming up. It will cycle
16 through 12 channels, some with images you give it, and some with color
17 bars or nothing but static.
18 .PP
19 The images that it uses will be grabbed from the portion of the screen
20 underlying the window, or from the system's video input, or from a
21 random file on disk, as indicated by the \fIgrabDesktopImages\fP,
22 \fIgrabVideoFrames\fP, and \fIchooseRandomImages\fP options in the
23 \fI~/.xscreensaver\fP file; see
24 .BR xscreensaver-demo (1)
25 for more details. It looks best with a video input or
26 your digital photo collection.
27 .PP
28 .SH OPTIONS
29 .I xanalogtv
30 accepts the following options:
31 .TP 8
32 .B \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-install
39 Install a private colormap for the window.
40 .TP 8
41 .B \-visual \fIvisual\fP
42 Specify which visual to use.  Legal values are the name of a visual class,
43 or the id number (decimal or hex) of a specific visual.
44 .TP 8
45 .B \-fps
46 Display the current frame rate and CPU load.
47 .SH ENVIRONMENT
48 .PP
49 .TP 8
50 .B DISPLAY
51 to get the default host and display number.
52 .TP 8
53 .B XENVIRONMENT
54 to get the name of a resource file that overrides the global resources
55 stored in the RESOURCE_MANAGER property.
56 .SH X RESOURCES
57 Notable X resources supported include the following which correspond
58 to standard TV controls:
59 .BR analogTVTint ,
60 .BR analogTVColor ,
61 .BR analogTVBrightness ,
62 and
63 .BR analogTVContrast .
64 They range from 0 to 100, except for tint which is an angle 
65 between -180 and +180.
66
67 .SH SEE ALSO
68 .BR X (1),
69 .BR xteevee (MANSUFFIX),
70 .BR apple2 (MANSUFFIX),
71 .BR bsod (MANSUFFIX),
72 .BR xscreensaver (1),
73 .BR xscreensaver\-demo (1),
74 .BR xscreensaver\-getimage (1)
75 .SH COPYRIGHT
76 Copyright \(co 2003 by Trevor Blackwell.  Permission to use, copy, modify, 
77 distribute, and sell this software and its documentation for any purpose is 
78 hereby granted without fee, provided that the above copyright notice appear 
79 in all copies and that both that copyright notice and this permission notice
80 appear in supporting documentation.  No representations are made about the 
81 suitability of this software for any purpose.  It is provided "as is" without
82 express or implied warranty. 
83 .SH AUTHOR
84 Trevor Blackwell <tlb@tlb.org>