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] [\-delay \fImicroseconds\fP] [\-fps]
  21 [\-program \fIcommand\fP]
  22 [\-size \fIinteger\fP ]
  23 [\-columns \fIinteger\fP]
  24 [\-wrap | \-no\-wrap]
  25 [\-left | \-center | \-right]
  26 [\-lines \fIinteger\fP]
  27 [\-spin \fIfloat\fP]
  28 [\-steps \fIinteger\fP]
  29 [\-delay \fIusecs\fP]
  30 [\-no-smooth]
  31 [\-no-thick]
  32 .SH DESCRIPTION
  33 The \fIstarwars\fP program runs another program to generate a stream of
  34 text, then animates that text receeding into the background at an angle,
  35 in front of a star field.
  36 .SH OPTIONS
  37 .I starwars
  38 accepts the following options:
  39 .TP 8
  40 .B \-window
  41 Draw on a newly-created window.  This is the default.
  42 .TP 8
  43 .B \-root
  44 Draw on the root window.
  45 .TP 8
  46 .B \-install
  47 Install a private colormap for the window.
  48 .TP 8
  49 .B \-visual \fIvisual\fP\fP
  50 Specify which visual to use.  Legal values are the name of a visual class,
  51 or the id number (decimal or hex) of a specific visual.
  52 .TP 8
  53 .B \-program \fIsh-command\fP
  54 The command to run to generate the text to display.  This option may be
  55 any string acceptable to /bin/sh.  The program will be run at the end of
  56 a pipe, and any characters that it prints to \fIstdout\fP will be printed
  57 on the starwars window.  If the program exits, it will be launched again
  58 after we have processed all the text it produced.
  59
  60 Note that starwars is \fInot\fP a terminal emulator: programs that try to
  61 directly address the screen will not do what you might expect.  This
  62 program merely draws the characters on the screen left to right, top
  63 to bottom, in perspective.  Lines (may) wrap when they reach the right
  64 edge.
  65
  66 In other words, programs like
  67 .BR fortune (1)
  68 will work, but programs like
  69 .BR top (1)
  70 won't.
  71
  72 Some examples:
  73 .EX
  74 starwars -columns 30 -program \\
  75   'wget -qO- http://webcrawler.com/cgi-bin/SearchTicker'
  76 starwars -columns 76 -program 'cat /usr/src/linux/README'
  77 starwars -program 'ping www.starwars.com'
  78 starwars -no-wrap -left -program 'finger @gnu.org'
  79 starwars -no-wrap -left -program 'ps -ef'
  80 .EE
  81 .TP 8
  82 .B \-size \fIinteger\fP
  83 How large a font to use, in points.  (Well, in some arbitrary unit
  84 we're calling "points" for the sake of argument.)  The \fB\-columns\fP
  85 option overrides this.
  86 .TP 8
  87 .B \-columns \fIinteger\fP
  88 How many columns of text should be visible on the bottom line of the
  89 screen.  The default is 80.  This option overrides the \fB\-size\fP
  90 option: if you specify a number of columns, the font will be scaled
  91 as needed to fit.
  92 .TP 8
  93 .B \-wrap
  94 Word-wrap lines when they reach the rightmost column.  This is the default.
  95 .TP 8
  96 .B \-no\-wrap
  97 Do not word-wrap: just let the lines go off the right side of the screen.
  98 .TP 8
  99 .B \-left | \-center | \-right
 100 Whether to align the text flush left, centered, or flush right.
 101 The default is centered.
 102 .TP 8
 103 .B \-lines \fIinteger\fP
 104 How many lines should be allowed to be on the screen before they fall off
 105 the end.  The default is 125.
 106 .TP 8
 107 .B \-spin \fIfloat\fP
 108 The star field on the background slowly rotates.  This is how fast.
 109 The default is 0.03.
 110 .TP 8
 111 .B \-steps \fIinteger\fP
 112 How many steps should be used to scroll a single line.  The default is 35.
 113 If the animation looks jerky to you, increase this number.
 114 .TP 8
 115 .B \-delay \fIusecs\fP
 116 The delay between steps of the animation; default is 40000 (1/25th second.)
 117 .TP 8
 118 .B \-fps
 119 Display a running tally of how many frames per second are being rendered.
 120 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
 121 your GL performance.
 122 .TP 8
 123 .B \-no\-smooth
 124 Turn off anti-aliasing of the lines used to draw the font.
 125 This will make the text blockier, but may improve performance.
 126 .TP 8
 127 .B \-no\-thick
 128 Turn off use of thick lines for the characters that are close to the
 129 foreground.  This will make the text appear unnaturally skinny, but
 130 may improve performance.
 131 .SH ENVIRONMENT
 132 .PP
 133 .TP 8
 134 .B DISPLAY
 135 to get the default host and display number.
 136 .TP 8
 137 .B XENVIRONMENT
 138 to get the name of a resource file that overrides the global resources
 139 stored in the RESOURCE_MANAGER property.
 140 .SH SEE ALSO
 141 .BR X (1),
 142 .BR xscreensaver (1)
 143 .SH COPYRIGHT
 144 Copyright \(co 1998-2001 by Jamie Zawinski and Claudio Matsuoka.
 145 Permission to use, copy, modify, distribute, and sell this software and
 146 its documentation for any purpose is hereby granted without fee,
 147 provided that the above copyright notice appear in all copies and that
 148 both that copyright notice and this permission notice appear in
 149 supporting documentation.  No representations are made about the
 150 suitability of this software for any purpose.  It is provided "as is"
 151 without express or implied warranty.
 152 .SH AUTHOR
 153 Jamie Zawinski <jwz@jwz.org> and Claudio Matauoka <claudio@helllabs.org>