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