git.hungrycats.org Git - xscreensaver/blob - hacks/glx/fliptext.man

   1 .TH XScreenSaver 1 "20-Mar-2005" "X Version 11"
   2 .SH NAME
   3 fliptext - draws pages of text whose lines transparently flip around
   4 .SH SYNOPSIS
   5 .B fliptext
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
   7 [\-visual \fIvisual\fP]
   8 [\-delay \fImicroseconds\fP]
   9 [\-program \fIcommand\fP]
  10 [\-size \fIinteger\fP ]
  11 [\-columns \fIinteger\fP]
  12 [\-left | \-center | \-right]
  13 [\-lines \fIinteger\fP]
  14 [\-speed \fIfloat\fP]
  15 [\-delay \fIusecs\fP]
  16 [\-font \fIxlfd\fP]
  17 [\-wireframe]
  18 [\-fps]
  19 .SH DESCRIPTION
  20 The \fIfliptext\fP program runs another program to generate a stream of
  21 text, then animates the lines of that text transparently flipping in
  22 and out in 3D.
  23 .SH OPTIONS
  24 .I fliptext
  25 accepts the following options:
  26 .TP 8
  27 .B \-window
  28 Draw on a newly-created window.  This is the default.
  29 .TP 8
  30 .B \-root
  31 Draw on the root window.
  32 .TP 8
  33 .B \-install
  34 Install a private colormap for the window.
  35 .TP 8
  36 .B \-visual \fIvisual\fP\fP
  37 Specify which visual to use.  Legal values are the name of a visual class,
  38 or the id number (decimal or hex) of a specific visual.
  39 .TP 8
  40 .B \-program \fIsh-command\fP
  41 This program will be run periodically, and its output will be the text
  42 that is displayed.  Default \fIxscreensaver\-text\fP.
  43
  44 You can configure the text printed through the "Advanced" tab of
  45 .BR xscreensaver\-demo (1),
  46 or by editing your ~/.xscreensaver file.
  47 .TP 8
  48 .B \-size \fIinteger\fP
  49 How large a font to use, in points.  (Well, in some arbitrary unit
  50 we're calling "points" for the sake of argument.)  Default: 20.
  51 .TP 8
  52 .B \-columns \fIinteger\fP
  53 At (approximately) what column to wrap lines.  Default 80.  Wrapping is
  54 done by pixels, not characters, and lines will always wrap at the
  55 edge of the screen regardless.
  56 .TP 8
  57 .B \-left | \-center | \-right
  58 Whether to align the text flush left, centered, or flush right.
  59 The default is to choose randomly each time a new screen of text
  60 is displayed.
  61 .TP 8
  62 .B \-lines \fIinteger\fP
  63 How many lines of text should be shown at once.  Default 8.
  64 .TP 8
  65 .B \-speed \fIratio\fP
  66 Change the animation speed; 0.5 to go half as fast, 2.0 to go twice as fast.
  67 .TP 8
  68 .B \-delay \fIusecs\fP
  69 The delay between frames of the animation; default is 10000 (1/10th second.)
  70 .TP 8
  71 .B \-font \fIfont-name\fP
  72 The name of the font to use.  For best effect, this should be a large
  73 font (at least 36 points.)  The bigger the font, the better looking the
  74 characters will be.  Note that the size of this font affects only the
  75 clarity of the characters, not their size on the screen: for that, use
  76 the \fI\-size\fP or \fI\-columns\fP options.
  77
  78 Default: -*-utopia-bold-r-normal-*-*-720-*-*-*-*-iso8859-1
  79 .TP 8
  80 .B \-fps
  81 Display the current frame rate, CPU load, and polygon count.
  82 .SH ENVIRONMENT
  83 .PP
  84 .TP 8
  85 .B DISPLAY
  86 to get the default host and display number.
  87 .TP 8
  88 .B XENVIRONMENT
  89 to get the name of a resource file that overrides the global resources
  90 stored in the RESOURCE_MANAGER property.
  91 .SH SEE ALSO
  92 .BR xscreensaver (1),
  93 .BR xscreensaver-text (1),
  94 .BR fortune (1),
  95 .BR phosphor (MANSUFFIX),
  96 .BR apple2 (MANSUFFIX),
  97 .BR fontglide (MANSUFFIX),
  98 .BR ljlatest (MANSUFFIX),
  99 .BR dadadodo (1),
 100 .BR webcollage (MANSUFFIX),
 101 .BR driftnet (1)
 102 .BR EtherPEG ,
 103 .BR EtherPeek
 104 .SH COPYRIGHT
 105 Copyright \(co 2005 by Jamie Zawinski.
 106 Permission to use, copy, modify, distribute, and sell this software and
 107 its documentation for any purpose is hereby granted without fee,
 108 provided that the above copyright notice appear in all copies and that
 109 both that copyright notice and this permission notice appear in
 110 supporting documentation.  No representations are made about the
 111 suitability of this software for any purpose.  It is provided "as is"
 112 without express or implied warranty.
 113 .SH AUTHOR
 114 Jamie Zawinski <jwz@jwz.org>