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

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