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