git.hungrycats.org Git - xscreensaver/blob - hacks/glx/starwars.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 "25-Jul-98" "X Version 11"
  15 .SH NAME
  16 starwars - draws a perspective text crawl, like at the beginning of the movie
  17 .SH SYNOPSIS
  18 .B starwars
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
  20 [\-visual \fIvisual\fP]
  21 [\-delay \fImicroseconds\fP]
  22 [\-program \fIcommand\fP]
  23 [\-size \fIinteger\fP ]
  24 [\-columns \fIinteger\fP]
  25 [\-wrap | \-no\-wrap]
  26 [\-left | \-center | \-right]
  27 [\-lines \fIinteger\fP]
  28 [\-spin \fIfloat\fP]
  29 [\-steps \fIinteger\fP]
  30 [\-delay \fIusecs\fP]
  31 [\-font \fIxlfd\fP]
  32 [\-no\-textures]
  33 [\-no\-smooth]
  34 [\-no\-thick]
  35 [\-fps]
  36 .SH DESCRIPTION
  37 The \fIstarwars\fP program runs another program to generate a stream of
  38 text, then animates that text receeding into the background at an angle,
  39 in front of a star field.
  40 .SH OPTIONS
  41 .I starwars
  42 accepts the following options:
  43 .TP 8
  44 .B \-window
  45 Draw on a newly-created window.  This is the default.
  46 .TP 8
  47 .B \-root
  48 Draw on the root window.
  49 .TP 8
  50 .B \-install
  51 Install a private colormap for the window.
  52 .TP 8
  53 .B \-visual \fIvisual\fP\fP
  54 Specify which visual to use.  Legal values are the name of a visual class,
  55 or the id number (decimal or hex) of a specific visual.
  56 .TP 8
  57 .B \-program \fIsh-command\fP
  58 The command to run to generate the text to display.  This option may be
  59 any string acceptable to /bin/sh.  The program will be run at the end of
  60 a pipe, and any characters that it prints to \fIstdout\fP will be printed
  61 on the starwars window.  If the program exits, it will be launched again
  62 after we have processed all the text it produced.
  63
  64 Note that starwars is \fInot\fP a terminal emulator: programs that try to
  65 directly address the screen will not do what you might expect.  This
  66 program merely draws the characters on the screen left to right, top
  67 to bottom, in perspective.  Lines (may) wrap when they reach the right
  68 edge.
  69
  70 In other words, programs like
  71 .BR fortune (1)
  72 will work, but programs like
  73 .BR top (1)
  74 won't.
  75
  76 Some examples:
  77 .EX
  78 starwars -program 'cat /usr/src/linux*/README'
  79 starwars -columns 30 -program 'ping www.starwars.com'
  80 starwars -left -no-wrap -program 'ps -auxwwf'
  81 starwars -left -no-wrap -columns 45 -program 'top -bn1'
  82 starwars -left -columns 40 -program 'od -txC /dev/urandom'
  83 starwars -font fixed -program 'od -txC /dev/urandom'
  84 .EE
  85 .TP 8
  86 .B \-size \fIinteger\fP
  87 How large a font to use, in points.  (Well, in some arbitrary unit
  88 we're calling "points" for the sake of argument.)  Default: 24.
  89 .TP 8
  90 .B \-columns \fIinteger\fP
  91 How many columns of text should be visible on the bottom line of the
  92 screen.  Default: 60.
  93
  94 Only one of \fI\-columns\fP and \fI\-size\fP may be specified;
  95 if both are specified, \fI\-columns\fP takes priority.
  96 .TP 8
  97 .B \-wrap
  98 Word-wrap lines when they reach the rightmost column.  This is the default.
  99 .TP 8
 100 .B \-no\-wrap
 101 Do not word-wrap: just let the lines go off the right side of the screen.
 102 .TP 8
 103 .B \-left | \-center | \-right
 104 Whether to align the text flush left, centered, or flush right.
 105 The default is centered.
 106 .TP 8
 107 .B \-lines \fIinteger\fP
 108 How many lines should be allowed to be on the screen before they fall off
 109 the end.  The default is 125.
 110 .TP 8
 111 .B \-spin \fIfloat\fP
 112 The star field on the background slowly rotates.  This is how fast.
 113 The default is 0.03.
 114 .TP 8
 115 .B \-steps \fIinteger\fP
 116 How many steps should be used to scroll a single line.  The default is 35.
 117 If the animation looks jerky to you, increase this number.
 118 .TP 8
 119 .B \-delay \fIusecs\fP
 120 The delay between steps of the animation; default is 40000 (1/25th second.)
 121 .TP 8
 122 .B \-font \fIfont-name\fP
 123 The name of the font to use.  For best effect, this should be a large
 124 font (at least 36 points.)  The bigger the font, the better looking the
 125 characters will be.  Note that the size of this font affects only the
 126 clarity of the characters, not their size on the screen: for that, use
 127 the \fI\-size\fP or \fI\-columns\fP options.
 128
 129 Default: -*-utopia-bold-r-normal-*-*-720-*-*-*-*-iso8859-1
 130 .TP 8
 131 .B \-no\-textures
 132 Instead of texture-mapping a real font to render the text, use a
 133 built-in font composed of line segments.  On graphics cards without
 134 texture support, the line-segment font will have much better
 135 performance.
 136 .TP 8
 137 .B \-no\-smooth
 138 When using the line-segment font, turn off anti-aliasing of the lines
 139 used to draw the font.  This will make the text blockier, but may
 140 improve performance.
 141 .TP 8
 142 .B \-no\-thick
 143 When using the line-segment font, turn off use of thick lines for the
 144 characters that are close to the foreground.  This will make the text
 145 appear unnaturally skinny, but may improve performance.
 146 .TP 8
 147 .B \-fps
 148 Display the current frame rate, CPU load, and polygon count.
 149 .SH ENVIRONMENT
 150 .PP
 151 .TP 8
 152 .B DISPLAY
 153 to get the default host and display number.
 154 .TP 8
 155 .B XENVIRONMENT
 156 to get the name of a resource file that overrides the global resources
 157 stored in the RESOURCE_MANAGER property.
 158 .SH SEE ALSO
 159 .BR xscreensaver (1),
 160 .BR xscreensaver-text (1),
 161 .BR fortune (1),
 162 .BR phosphor (MANSUFFIX),
 163 .BR apple2 (MANSUFFIX),
 164 .BR fontglide (MANSUFFIX),
 165 .BR ljlatest (MANSUFFIX),
 166 .BR dadadodo (1),
 167 .BR webcollage (MANSUFFIX),
 168 .BR driftnet (1)
 169 .BR EtherPEG ,
 170 .BR EtherPeek
 171 .SH COPYRIGHT
 172 Copyright \(co 1998-2005 by Jamie Zawinski and Claudio Matsuoka.
 173 Permission to use, copy, modify, distribute, and sell this software and
 174 its documentation for any purpose is hereby granted without fee,
 175 provided that the above copyright notice appear in all copies and that
 176 both that copyright notice and this permission notice appear in
 177 supporting documentation.  No representations are made about the
 178 suitability of this software for any purpose.  It is provided "as is"
 179 without express or implied warranty.
 180 .SH AUTHOR
 181 Jamie Zawinski <jwz@jwz.org> and Claudio Matauoka <claudio@helllabs.org>