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