git.hungrycats.org Git - xscreensaver/blob - hacks/phosphor.man

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
  15 .SH NAME
  16 phosphor - simulates an old terminal with long-sustain phosphor
  17 .SH SYNOPSIS
  18 .B phosphor
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
  20 [\-visual \fIvisual\fP] [\-font \fIfont\fP] [\-scale \fIint\fP]
  21 [\-ticks \fIint\fP] [\-delay \fIusecs\fP] [\-program \fIcommand\fP]
  22 .SH DESCRIPTION
  23 The \fIphosphor\fP program draws text on the screen in a very large
  24 pixelated font that looks like an old low resolution dumb tty.  The
  25 pixels flare and fade out as if the phosphor was very long-sustain.
  26 .SH OPTIONS
  27 .I phosphor
  28 accepts the following options:
  29 .TP 8
  30 .B \-window
  31 Draw on a newly-created window.  This is the default.
  32 .TP 8
  33 .B \-root
  34 Draw on the root window.
  35 .TP 8
  36 .B \-install
  37 Install a private colormap for the window.
  38 .TP 8
  39 .B \-visual \fIvisual\fP\fP
  40 Specify which visual to use.  Legal values are the name of a visual class,
  41 or the id number (decimal or hex) of a specific visual.
  42 .TP 8
  43 .B \-font \fIfont-name\fP
  44 The X font to use.  Phosphor can take any font and scale it up to pixelate
  45 it.  The default is \fIfixed\fP.
  46 .TP 8
  47 .B \-scale \fIint\fP
  48 How much to scale the font up: in other words, the size in real pixels of
  49 the simulated pixels.  Default 6.
  50 .TP 8
  51 .B \-ticks \fIint\fP
  52 The number of colors to use when fading to black.  Default 20.
  53 .TP 8
  54 .B \-delay \fIusecs\fP
  55 The speed of the terminal: how long to wait between drawing each character.
  56 Default 50000, or about 1/20th second.
  57 .TP 8
  58 .B \-program \fIsh-command\fP
  59 The command to run to generate the text to display.  This option may be
  60 any string acceptable to /bin/sh.  The program will be run at the end of
  61 a pipe, and any characters that it prints to \fIstdout\fP will be printed
  62 on phosphor's window.  The characters will be printed artificially slowly,
  63 as per the \fI\-delay\fP option above.  If the program exits, it will be
  64 launched again after 5 seconds.
  65
  66 Note that phosphor is \fInot\fP a terminal emulator: programs that try to
  67 directly address the screen will not do what you might expect.  Phosphor
  68 merely draws the characters on the screen left to right, top to bottom.
  69 Lines wrap when they reach the right edge, and the screen scrolls when
  70 characters reach the bottom.
  71
  72 In other words, programs like
  73 .BR fortune (1)
  74 will work, but programs like
  75 .BR top (1)
  76 won't.
  77
  78 Here's a good trick, to get phosphor to display recent web search terms:
  79 .EX
  80 phosphor -program \\
  81   'wget -qO- http://webcrawler.com/cgi-bin/SearchTicker'
  82 .EE
  83 .SH ENVIRONMENT
  84 .PP
  85 .TP 8
  86 .B DISPLAY
  87 to get the default host and display number.
  88 .TP 8
  89 .B XENVIRONMENT
  90 to get the name of a resource file that overrides the global resources
  91 stored in the RESOURCE_MANAGER property.
  92 .SH SEE ALSO
  93 .BR wget (1),
  94 .BR X (1),
  95 .BR xscreensaver (1)
  96 .SH COPYRIGHT
  97 Copyright \(co 1999 by Jamie Zawinski.  Permission to use, copy, modify,
  98 distribute, and sell this software and its documentation for any purpose is
  99 hereby granted without fee, provided that the above copyright notice appear
 100 in all copies and that both that copyright notice and this permission notice
 101 appear in supporting documentation.  No representations are made about the
 102 suitability of this software for any purpose.  It is provided "as is" without
 103 express or implied warranty.
 104 .SH AUTHOR
 105 Jamie Zawinski <jwz@jwz.org>, 27-Apr-99.