git.hungrycats.org Git - xscreensaver/blob - hacks/glx/gltext.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 gltext - draws text spinning around in 3D
  17 .SH SYNOPSIS
  18 .B gltext
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
  20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
  21 [\-text \fIstring\fP]
  22 [\-program \fIcommand\fP]
  23 [\-wander] [\-no-wander]
  24 [\-spin \fIaxes\fP]
  25 [\-no-spin]
  26 [\-front] [\-no\-front]
  27 .SH DESCRIPTION
  28 The \fIgltext\fP program draws some text spinning around in 3D, using
  29 a font that appears to be made of solid tubes.
  30 .SH OPTIONS
  31 .I gltext
  32 accepts the following options:
  33 .TP 8
  34 .B \-window
  35 Draw on a newly-created window.  This is the default.
  36 .TP 8
  37 .B \-root
  38 Draw on the root window.
  39 .TP 8
  40 .B \-install
  41 Install a private colormap for the window.
  42 .TP 8
  43 .B \-visual \fIvisual\fP\fP
  44 Specify which visual to use.  Legal values are the name of a visual class,
  45 or the id number (decimal or hex) of a specific visual.
  46 .TP 8
  47 .B \-text \fIstring\fP
  48 The text to display.  This may contain newlines, but it shouldn't be
  49 very long.  The default is to display the machine name and OS version.
  50
  51 This may also be a format string acceptable to
  52 .BR date (1)
  53 and
  54 .BR strftime (3) ,
  55 in which case, it will be updated once a second.  So to make this
  56 program display a spinning digital clock, you could do this:
  57 .EX
  58 gltext -text "%A%n%d %b %Y%n%l:%M:%S %p"
  59 .EE
  60 To include a literal `%', you must double it: `%%'.
  61
  62 See the man page for
  63 .BR strftime (3)
  64 for more details.
  65 .TP 8
  66 .B \-program \fIcommand\fP
  67 The given program is run, and its output is displayed.
  68 If specified, this overrides \fI\-text\fP.
  69 The program will be re-run every 5 seconds to re-generate the text.
  70 It should run quickly, and shouldn't generate too much text.
  71 .TP 8
  72 .B \-fps
  73 Display a running tally of how many frames per second are being rendered.
  74 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  75 your GL performance.
  76 .TP 8
  77 .B \-wander
  78 Move the text around the screen.  This is the default.
  79 .TP 8
  80 .B \-no\-wander
  81 Keep the text centered on the screen.
  82 .TP 8
  83 .B \-spin
  84 Which axes around which the text should spin.  The default is "XYZ",
  85 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
  86 text in the plane of the screen while not rotating it into or out
  87 of the screen; etc.
  88 .TP 8
  89 .B \-no\-spin
  90 Don't spin the text at all: the same as \fB\-spin ""\fP.
  91 .TP 8
  92 .B \-front
  93 When spinning, never spin all the way around or upside down:
  94 always face mostly forward so that the text is easily readable.
  95 .TP 8
  96 .B \-no\-front
  97 Allow spins to go all the way around or upside down.  This is the default.
  98 .SH ENVIRONMENT
  99 .PP
 100 .TP 8
 101 .B DISPLAY
 102 to get the default host and display number.
 103 .TP 8
 104 .B XENVIRONMENT
 105 to get the name of a resource file that overrides the global resources
 106 stored in the RESOURCE_MANAGER property.
 107 .SH SEE ALSO
 108 .BR X (1),
 109 .BR xscreensaver (1)
 110 .SH COPYRIGHT
 111 Copyright \(co 2001-2005 by Jamie Zawinski.
 112 Permission to use, copy, modify, distribute, and sell this software and
 113 its documentation for any purpose is hereby granted without fee,
 114 provided that the above copyright notice appear in all copies and that
 115 both that copyright notice and this permission notice appear in
 116 supporting documentation.  No representations are made about the
 117 suitability of this software for any purpose.  It is provided "as is"
 118 without express or implied warranty.
 119 .SH AUTHOR
 120 Jamie Zawinski <jwz@jwz.org>