git.hungrycats.org Git - xscreensaver/blob - 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
  23 The image that it manipulates will be grabbed from the portion of
  24 the screen underlying the window, or from the system's video input,
  25 or from a random file on disk, as indicated by
  26 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  27 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  28 file; see
  29 .BR xscreensaver-demo (1)
  30 for more details.
  31 .PP
  32 See also
  33 .BR xanalogtv (1)
  34 for a more sophisticated (but more graphics-intensive) implementation
  35 of this concept.
  36 .SH OPTIONS
  37 .I xteevee
  38 accepts the following options:
  39 .TP 8
  40 .B \-window
  41 Draw on a newly-created window.  This is the default.
  42 .TP 8
  43 .B \-root
  44 Draw on the root window.
  45 .TP 8
  46 .B \-install
  47 Install a private colormap for the window.
  48 .TP 8
  49 .B \-visual \fIvisual\fP
  50 Specify which visual to use.  Legal values are the name of a visual class,
  51 or the id number (decimal or hex) of a specific visual.
  52 .TP 8
  53 .B \-cycle
  54 Cycle through all the available modes.  This is the default.
  55 .TP 8
  56 .B \-no-cycle
  57 Don't cycle modes.
  58 .TP 8
  59 .B \-static
  60 Explicitly select the "static" mode.
  61 .TP 8
  62 .B \-no-static
  63 Explicitly forbid the "static" mode.
  64 .TP 8
  65 .B \-roll
  66 Explicitly select the "vertical roll" mode.
  67 .TP 8
  68 .B \-no-roll
  69 Explicitly forbid the "vertical roll" mode.
  70 .TP 8
  71 .B \-bars
  72 Explicitly select the "color bars" mode.
  73 .TP 8
  74 .B \-no-bars
  75 Explicitly forbid the "color bars" mode.
  76 .SH ENVIRONMENT
  77 .PP
  78 .TP 8
  79 .B DISPLAY
  80 to get the default host and display number.
  81 .TP 8
  82 .B XENVIRONMENT
  83 to get the name of a resource file that overrides the global resources
  84 stored in the RESOURCE_MANAGER property.
  85 .SH X RESOURCES
  86 Notable X resources supported include the following:
  87 .PP
  88 .BR static,
  89 .BR roll
  90 and
  91 .BR bars
  92 are booleans, defining which modes are to be implicitly available if
  93 .I xteevee
  94 is run without command-line mode selections.
  95 .BR cycle
  96 is a boolean, defining if
  97 .I xteevee
  98 should cycle through each available mode or pick one and stick with it.
  99 .BR delayMode
 100 and
 101 .BR delayBetween
 102 are integers, defining how long each mode should be displayed and how
 103 long the time between them should be if
 104 .BR cycle
 105 is on.
 106 .BR staticSignal
 107 is an integer, defining the strength of the signal during the "static"
 108 mode, as a percentage.
 109 .SH BUGS
 110 .I xteevee
 111 should simulate more TV problems.
 112 .SH SEE ALSO
 113 .BR X (1),
 114 .BR xanalogtv (1),
 115 .BR apple2 (1),
 116 .BR bsod (1),
 117 .BR xscreensaver (1),
 118 .BR xscreensaver\-demo (1),
 119 .BR xscreensaver\-getimage (1)
 120 .SH COPYRIGHT
 121 Copyright \(co 1999 by Greg Knauss.  Permission to use, copy, modify,
 122 distribute, and sell this software and its documentation for any purpose is
 123 hereby granted without fee, provided that the above copyright notice appear
 124 in all copies and that both that copyright notice and this permission notice
 125 appear in supporting documentation.  No representations are made about the
 126 suitability of this software for any purpose.  It is provided "as is" without
 127 express or implied warranty.  If you've gotten this far, then you're obviously
 128 looking for something to do.  Go here: http://www.teevee.org.
 129 .SH AUTHOR
 130 Greg Knauss <greg@eod.com>, 19-Nov-1999.