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