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] [-visual vis‐
11       ual]  [-delay  microseconds] [-program command] [-size integer ] [-col‐
12       umns integer] [-wrap | -no-wrap] [-left | -center | -right] [-lines in‐
13       teger]  [-spin  float]  [-steps  integer]  [-delay  usecs] [-font xlfd]
14       [-no-textures] [-no-smooth] [-no-thick] [-fps]
15

DESCRIPTION

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

OPTIONS

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

ENVIRONMENT

132       DISPLAY to get the default host and display number.
133
134       XENVIRONMENT
135               to get the name of a resource file that  overrides  the  global
136               resources stored in the RESOURCE_MANAGER property.
137

SEE ALSO

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

AUTHOR

154       Jamie  Zawinski  <jwz@jwz.org>  and  Claudio  Matauoka   <claudio@hell‐
155       labs.org>
156
157
158
159X Version 11               6.00-4.fc34 (05-May-2021)              starwars(6x)
Impressum