source: trunk/third/xscreensaver/hacks/phosphor.man @ 20148

Revision 20148, 3.5 KB checked in by ghudson, 21 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r20147, which included commits to RCS files with non-trunk default branches.
Line 
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
16phosphor - 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
23The \fIphosphor\fP program draws text on the screen in a very large
24pixelated font that looks like an old low resolution dumb tty.  The
25pixels flare and fade out as if the phosphor was very long-sustain.
26.SH OPTIONS
27.I phosphor
28accepts the following options:
29.TP 8
30.B \-window
31Draw on a newly-created window.  This is the default.
32.TP 8
33.B \-root
34Draw on the root window.
35.TP 8
36.B \-install
37Install a private colormap for the window.
38.TP 8
39.B \-visual \fIvisual\fP\fP
40Specify which visual to use.  Legal values are the name of a visual class,
41or the id number (decimal or hex) of a specific visual.
42.TP 8
43.B \-font \fIfont-name\fP
44The X font to use.  Phosphor can take any font and scale it up to pixelate
45it.  The default is \fIfixed\fP.
46.TP 8
47.B \-scale \fIint\fP
48How much to scale the font up: in other words, the size in real pixels of
49the simulated pixels.  Default 6.
50.TP 8
51.B \-ticks \fIint\fP
52The number of colors to use when fading to black.  Default 20.
53.TP 8
54.B \-delay \fIusecs\fP
55The speed of the terminal: how long to wait between drawing each character.
56Default 50000, or about 1/20th second.
57.TP 8
58.B \-program \fIsh-command\fP
59The command to run to generate the text to display.  This option may be
60any string acceptable to /bin/sh.  The program will be run at the end of
61a pipe, and any characters that it prints to \fIstdout\fP will be printed
62on phosphor's window.  The characters will be printed artificially slowly,
63as per the \fI\-delay\fP option above.  If the program exits, it will be
64launched again after 5 seconds.
65
66Note that phosphor is \fInot\fP a terminal emulator: programs that try to
67directly address the screen will not do what you might expect.  Phosphor
68merely draws the characters on the screen left to right, top to bottom.
69Lines wrap when they reach the right edge, and the screen scrolls when
70characters reach the bottom.
71
72In other words, programs like
73.BR fortune (1)
74will work, but programs like
75.BR top (1)
76won't.
77
78For example:
79.EX
80phosphor -program 'cat /usr/src/linux*/README'
81phosphor -program 'ping localhost'
82phosphor -program 'ps -e'
83phosphor -program 'od -txC -w6 /dev/random'
84.EE
85.SH ENVIRONMENT
86.PP
87.TP 8
88.B DISPLAY
89to get the default host and display number.
90.TP 8
91.B XENVIRONMENT
92to get the name of a resource file that overrides the global resources
93stored in the RESOURCE_MANAGER property.
94.SH SEE ALSO
95.BR xscreensaver (1),
96.BR fortune (1),
97.BR apple2 (1),
98.BR starwars (1),
99.BR fontglide (1),
100.BR ljlatest (1),
101.BR dadadodo (1),
102.BR webcollage (1),
103.BR driftnet (1)
104.BR EtherPEG ,
105.BR EtherPeek
106.SH COPYRIGHT
107Copyright \(co 1999 by Jamie Zawinski.  Permission to use, copy, modify,
108distribute, and sell this software and its documentation for any purpose is
109hereby granted without fee, provided that the above copyright notice appear
110in all copies and that both that copyright notice and this permission notice
111appear in supporting documentation.  No representations are made about the
112suitability of this software for any purpose.  It is provided "as is" without
113express or implied warranty.
114.SH AUTHOR
115Jamie Zawinski <jwz@jwz.org>, 27-Apr-99.
Note: See TracBrowser for help on using the repository browser.