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 output of this program will be repeatedely displayed, with new
  72 pages of text shifting in every few seconds.  Lines should be relatively
  73 short.  You might try:
  74 .EX
  75 -program 'xscreensaver-text --cols 20'
  76 .EE
  77 .TP 8
  78 .B \-wander
  79 Move the text around the screen.  This is the default.
  80 .TP 8
  81 .B \-no\-wander
  82 Keep the text centered on the screen.
  83 .TP 8
  84 .B \-spin
  85 Which axes around which the text should spin.  The default is "XYZ",
  86 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
  87 text in the plane of the screen while not rotating it into or out
  88 of the screen; etc.
  89 .TP 8
  90 .B \-no\-spin
  91 Don't spin the text at all: the same as \fB\-spin ""\fP.
  92 .TP 8
  93 .B \-front
  94 When spinning, never spin all the way around or upside down:
  95 always face mostly forward so that the text is easily readable.
  96 .TP 8
  97 .B \-no\-front
  98 Allow spins to go all the way around or upside down.  This is the default.
  99 .TP 8
 100 .B \-wireframe
 101 Render in wireframe instead of solid.
 102 .TP 8
 103 .B \-fps
 104 Display the current frame rate, CPU load, and polygon count.
 105 .SH ENVIRONMENT
 106 .PP
 107 .TP 8
 108 .B DISPLAY
 109 to get the default host and display number.
 110 .TP 8
 111 .B XENVIRONMENT
 112 to get the name of a resource file that overrides the global resources
 113 stored in the RESOURCE_MANAGER property.
 114 .SH SEE ALSO
 115 .BR X (1),
 116 .BR xscreensaver (1)
 117 .BR xscreensaver-text (1)
 118 .SH COPYRIGHT
 119 Copyright \(co 2001-2014 by Jamie Zawinski.
 120 Permission to use, copy, modify, distribute, and sell this software and
 121 its documentation for any purpose is hereby granted without fee,
 122 provided that the above copyright notice appear in all copies and that
 123 both that copyright notice and this permission notice appear in
 124 supporting documentation.  No representations are made about the
 125 suitability of this software for any purpose.  It is provided "as is"
 126 without express or implied warranty.
 127 .SH AUTHOR
 128 Jamie Zawinski <jwz@jwz.org>