http://ftp.x.org/contrib/applications/xscreensaver-3.23.tar.gz
[xscreensaver] / hacks / xteevee.man
1 .TH XScreenSaver 1 "19-Nov-99" "X Version 11"
2 .SH NAME
3 xteevee - Simulate various TV problems
4 .SH SYNOPSIS
5 .B xteevee
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] 
8 [\-cycle] [\-no-cycle]
9 [\-static] [\-no-static] [\-roll] [\-no-roll] [\-bars] [\-no-bars] 
10 .SH DESCRIPTION
11 .I xteevee
12 simulates various television problems, fondly re-creating the days when
13 computers were fun and I spent my time with an Atari 400 hooked up to a
14 black-and-white TV I found in someone's trash.
15 .PP
16 When run,
17 .I xteevee
18 picks a mode to display from the available options.  If modes are explicitly
19 set on the command-line, they over-ride the implicit options and will be
20 choosen among exclusively.  If modes are explicitly excluded from the
21 command-line, the they are simply removed from contention.
22 .PP
23 .SH OPTIONS
24 .I xteevee
25 accepts the following options:
26 .TP 8
27 .B \-window
28 Draw on a newly-created window.  This is the default.
29 .TP 8
30 .B \-root
31 Draw on the root window.
32 .TP 8
33 .B \-install
34 Install a private colormap for the window.
35 .TP 8
36 .B \-visual \fIvisual\fP
37 Specify which visual to use.  Legal values are the name of a visual class,
38 or the id number (decimal or hex) of a specific visual.
39 .TP 8
40 .B \-cycle
41 Cycle through all the available modes.  This is the default.
42 .TP 8
43 .B \-no-cycle
44 Don't cycle modes.
45 .TP 8
46 .B \-static
47 Explicitly select the "static" mode.
48 .TP 8
49 .B \-no-static
50 Explicitly forbid the "static" mode.
51 .TP 8
52 .B \-roll
53 Explicitly select the "vertical roll" mode.
54 .TP 8
55 .B \-no-roll
56 Explicitly forbid the "vertical roll" mode.
57 .TP 8
58 .B \-bars
59 Explicitly select the "color bars" mode.
60 .TP 8
61 .B \-no-bars
62 Explicitly forbid the "color bars" mode.
63 .SH ENVIRONMENT
64 .PP
65 .TP 8
66 .B DISPLAY
67 to get the default host and display number.
68 .TP 8
69 .B XENVIRONMENT
70 to get the name of a resource file that overrides the global resources
71 stored in the RESOURCE_MANAGER property.
72 .SH X RESOURCES
73 Notable X resources supported include the following:
74 .PP
75 .BR static,
76 .BR roll
77 and
78 .BR bars
79 are booleans, defining which modes are to be implicitly available if
80 .I xteevee
81 is run without command-line mode selections.
82 .BR cycle
83 is a boolean, defining if
84 .I xteevee
85 should cycle through each available mode or pick one and stick with it.
86 .BR delayMode
87 and
88 .BR delayBetween
89 are integers, defining how long each mode should be displayed and how
90 long the time between them should be if
91 .BR cycle
92 is on.
93 .BR staticSignal
94 is an integer, defining the strength of the signal during the "static"
95 mode, as a percentage.
96 .SH BUGS
97 .I xteevee
98 should simulate more TV problems.
99 .SH SEE ALSO
100 .BR X (1),
101 .BR xscreensaver (1)
102 .SH COPYRIGHT
103 Copyright \(co 1999 by Greg Knauss.  Permission to use, copy, modify, 
104 distribute, and sell this software and its documentation for any purpose is 
105 hereby granted without fee, provided that the above copyright notice appear 
106 in all copies and that both that copyright notice and this permission notice
107 appear in supporting documentation.  No representations are made about the 
108 suitability of this software for any purpose.  It is provided "as is" without
109 express or implied warranty.  If you've gotten this far, then you're obviously
110 looking for something to do.  Go here: http://www.teevee.org.
111 .SH AUTHOR
112 Greg Knauss <greg@eod.com>, 19-Nov-1999.