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