git.hungrycats.org Git - xscreensaver/blob - hacks/fontglide.man

   1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
   2 .SH NAME
   3 fontglide - characters float onto the screen to form words
   4 .SH SYNOPSIS
   5 .B fontglide
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP]
   8 [\-delay \fIusecs\fP]
   9 [\-scroll\fP]
  10 [\-page\fP]
  11 [\-random\fP]
  12 [\-speed \fIfloat\fP]
  13 [\-linger \fIfloat\fP]
  14 [\-program \fIsh-command\fP]
  15 [\-font \fIfont-name\fP]
  16 [\-bw \fIint\fP]
  17 [\-trails]
  18 [\-db]
  19 [\-debug]
  20 [\-fps]
  21 .SH DESCRIPTION
  22 The \fIfontglide\fP program reads text from a subprocess and puts it on
  23 the screen using large characters that glide in from the edges,
  24 assemble, then disperse.  Alternately, it can simply scroll whole
  25 sentences from right to left.
  26 .SH OPTIONS
  27 .I fontglide
  28 accepts the following options:
  29 .TP 8
  30 .B \-window
  31 Draw on a newly-created window.  This is the default.
  32 .TP 8
  33 .B \-root
  34 Draw on the root window.
  35 .TP 8
  36 .B \-install
  37 Install a private colormap for the window.
  38 .TP 8
  39 .B \-visual \fIvisual\fP\fP
  40 Specify which visual to use.  Legal values are the name of a visual class,
  41 or the id number (decimal or hex) of a specific visual.
  42 .TP 8
  43 .B \-delay \fIusecs\fP
  44 The delay between steps of the animation, in microseconds: default 10000.
  45 .TP 8
  46 .B \-page
  47 With this option, a page full of text will glide in, and disperse.
  48 .TP 8
  49 .B \-scroll
  50 With this option, sentences will scroll by from right to left.
  51 .TP 8
  52 .B \-random
  53 The default is to pick randomly between \fI\-page\fP and  \fI\-scroll\fP.
  54 .TP 8
  55 .B \-speed \fIfloat\fP
  56 How fast to animate; 2 means twice as fast, 0.5 means half as fast.
  57 Default 1.0.
  58 .TP 8
  59 .B \-linger \fIfloat\fP
  60 How long to leave the assembled text on the screen in \fI\-page\fP mode;
  61 2 means twice as long, 0.5 means half as long.  Default 1.0.  (The more
  62 words there are on the screen, the longer it lingers.)
  63 .TP 8
  64 .B \-program \fIsh-command\fP
  65 The command to run to generate the text to display.  This option may be
  66 any string acceptable to /bin/sh.  The program will be run at the end of
  67 a pipe, and any words that it prints to \fIstdout\fP will end up on
  68 the window.  (Whitespace and line breaks are ignored.)  If the program
  69 exits, it will be launched again after we have processed all the text
  70 it produced.  Default:
  71 .BR xscreensaver-text (1).
  72 .TP 8
  73 .B \-font\fP \fIstring\fP
  74 The base font pattern to use when loading fonts.  The default is to search
  75 for any Latin1 scalable proportional fonts on the system.  Once a base font
  76 is selected, it will be loaded in a random size.
  77 .TP 8
  78 .B \-bw \fIint\fP
  79 How thick an outline to draw around the characters.  Default 2 pixels.
  80 .TP 8
  81 .B \-trails\fP
  82 Leave "vapor trails" behind the moving text.  Default off.
  83 .TP 8
  84 .B \-no-db\fP
  85 Turn off double-buffering.  It may be faster, but will flicker.
  86 .TP 8
  87 .B \-debug\fP
  88 Draw some boxes showing character metrics, and print the name of the
  89 current font to stderr.
  90 .TP 8
  91 .B \-fps
  92 Display the current frame rate and CPU load.
  93 .SH ENVIRONMENT
  94 .PP
  95 .TP 8
  96 .B DISPLAY
  97 to get the default host and display number.
  98 .TP 8
  99 .B XENVIRONMENT
 100 to get the name of a resource file that overrides the global resources
 101 stored in the RESOURCE_MANAGER property.
 102 .SH SEE ALSO
 103 .BR xscreensaver (1),
 104 .BR xscreensaver-text (1),
 105 .BR fortune (1),
 106 .BR phosphor (MANSUFFIX),
 107 .BR apple2 (MANSUFFIX),
 108 .BR starwars (MANSUFFIX),
 109 .BR ljlatest (MANSUFFIX),
 110 .BR dadadodo (1),
 111 .BR webcollage (MANSUFFIX),
 112 .BR driftnet (1)
 113 .BR EtherPEG ,
 114 .BR EtherPeek
 115 .SH COPYRIGHT
 116 Copyright \(co 2003 by Jamie Zawinski.  Permission to use, copy, modify,
 117 distribute, and sell this software and its documentation for any purpose is
 118 hereby granted without fee, provided that the above copyright notice appear
 119 in all copies and that both that copyright notice and this permission notice
 120 appear in supporting documentation.  No representations are made about the
 121 suitability of this software for any purpose.  It is provided "as is" without
 122 express or implied warranty.
 123 .SH AUTHOR
 124 Jamie Zawinski <jwz@jwz.org>, 15-Sep-2003.