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