1starwars(6x)                  XScreenSaver manual                 starwars(6x)
2
3
4

NAME

6       starwars - draws a perspective text crawl, like at the beginning of the
7       movie
8

SYNOPSIS

10       starwars [--display host:display.screen]  [--window]  [--root]  [--win‐
11       dow-id number] [--visual visual] [--delay microseconds] [--program com‐
12       mand] [--size  integer  ]  [--columns  integer]  [--wrap  |  --no-wrap]
13       [--left | --center | --right] [--lines integer] [--spin float] [--steps
14       integer] [--delay usecs] [--font  xlfd]  [--no-textures]  [--no-smooth]
15       [--no-thick] [--fps]
16

DESCRIPTION

18       The starwars program runs another program to generate a stream of text,
19       then animates that text receeding into the background at an  angle,  in
20       front of a star field.
21

OPTIONS

23       starwars accepts the following options:
24
25       --window
26               Draw on a newly-created window.  This is the default.
27
28       --root  Draw on the root window.
29
30       --window-id number
31               Draw on the specified window.
32
33       --install
34               Install a private colormap for the window.
35
36       --visual visual
37               Specify  which  visual  to use.  Legal values are the name of a
38               visual class, or the id number (decimal or hex) of  a  specific
39               visual.
40
41       --program sh-command
42               The  command  to run to generate the text to display.  This op‐
43               tion may be any string acceptable to /bin/sh.  The program will
44               be  run at the end of a pipe, and any characters that it prints
45               to stdout will be printed on the starwars window.  If the  pro‐
46               gram  exits,  it will be launched again after we have processed
47               all the text it produced.
48
49               Note that starwars is not a terminal  emulator:  programs  that
50               try  to  directly address the screen will not do what you might
51               expect.  This program merely draws the characters on the screen
52               left to right, top to bottom, in perspective.  Lines (may) wrap
53               when they reach the right edge.
54
55               In other words, programs like fortune(1) will  work,  but  pro‐
56               grams like top(1) won't.
57
58               Some examples:
59
60                    starwars -program 'cat /usr/src/linux*/README'
61                    starwars -columns 30 -program 'ping www.starwars.com'
62                    starwars -left -no-wrap -program 'ps -auxwwf'
63                    starwars -left -no-wrap -columns 45 -program 'top -bn1'
64                    starwars -left -columns 40 -program 'od -txC /dev/urandom'
65                    starwars -font fixed -program 'od -txC /dev/urandom'
66
67
68       --size integer
69               How  large  a font to use, in points.  (Well, in some arbitrary
70               unit we're calling "points" for the  sake  of  argument.)   De‐
71               fault: 24.
72
73       --columns integer
74               How  many  columns of text should be visible on the bottom line
75               of the screen.  Default: 60.
76
77               Only one of --columns and --size may be specified; if both  are
78               specified, --columns takes priority.
79
80       --wrap  Word-wrap  lines when they reach the rightmost column.  This is
81               the default.
82
83       --no-wrap
84               Do not word-wrap: just let the lines go off the right  side  of
85               the screen.
86
87       --left | --center | --right
88               Whether to align the text flush left, centered, or flush right.
89               The default is centered.
90
91       --lines integer
92               How many lines should be allowed to be  on  the  screen  before
93               they fall off the end.  The default is 125.
94
95       --spin float
96               The  star  field on the background slowly rotates.  This is how
97               fast.  The default is 0.03.
98
99       --steps integer
100               How many steps should be used to scroll a single line.  The de‐
101               fault  is  35.   If  the animation looks jerky to you, increase
102               this number.
103
104       --delay usecs
105               The delay between steps of  the  animation;  default  is  40000
106               (1/25th second.)
107
108       --font font-name
109               The name of the font to use.  For best effect, this should be a
110               large font (at least 36 points.)  The bigger the font, the bet‐
111               ter looking the characters will be.  Note that the size of this
112               font affects only the clarity of the characters, not their size
113               on the screen: for that, use the --size or --columns options.
114
115               Default: -*-utopia-bold-r-normal-*-*-720-*-*-*-*-iso8859-1
116
117       --no-textures
118               Instead  of texture-mapping a real font to render the text, use
119               a built-in font composed of line segments.  On  graphics  cards
120               without  texture  support, the line-segment font will have much
121               better performance.
122
123       --no-smooth
124               When using the line-segment font, turn off anti-aliasing of the
125               lines used to draw the font.  This will make the text blockier,
126               but may improve performance.
127
128       --no-thick
129               When using the line-segment font, turn off use of  thick  lines
130               for the characters that are close to the foreground.  This will
131               make the text appear unnaturally skinny, but may  improve  per‐
132               formance.
133
134       --fps   Display the current frame rate, CPU load, and polygon count.
135

ENVIRONMENT

137       DISPLAY to get the default host and display number.
138
139       XENVIRONMENT
140               to  get  the  name of a resource file that overrides the global
141               resources stored in the RESOURCE_MANAGER property.
142
143       XSCREENSAVER_WINDOW
144               The window ID to use with --root.
145

SEE ALSO

147       xscreensaver(1), xscreensaver-text(6x), fortune(1),  phosphor(6x),  ap‐
148       ple2(6x),  fontglide(6x),  ljlatest(6x),  dadadodo(1),  webcollage(6x),
149       driftnet(1) EtherPEG, EtherPeek
150
152       Copyright © 1998-2005 by Jamie Zawinski and Claudio Matsuoka.   Permis‐
153       sion  to  use, copy, modify, distribute, and sell this software and its
154       documentation for any purpose is hereby granted without  fee,  provided
155       that the above copyright notice appear in all copies and that both that
156       copyright notice and this permission notice appear in supporting  docu‐
157       mentation.   No  representations are made about the suitability of this
158       software for any purpose.  It is provided "as is"  without  express  or
159       implied warranty.
160

AUTHOR

162       Jamie   Zawinski  <jwz@jwz.org>  and  Claudio  Matauoka  <claudio@hell‐
163       labs.org>
164
165
166
167X Version 11               6.08-1.fc39 (17-Oct-2023)              starwars(6x)
Impressum