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 \-maxlines
  79 Set the number of lines of text to display.  By default,
  80 .I gltext
  81 will print 8 lines of text at a time.  Use this option to increase or
  82 decrease that number.  Be aware that
  83 .I gltext
  84 is designed to work with a fairly small amount of text, so setting this
  85 value too high might result in slow performance or strange behaviour
  86 stemming from buffer overflows.  Increase at your own risk.
  87 .TP 8
  88 .B \-mono
  89 Display the text in a monospace font.  Default is a variable-width font.
  90 .TP 8
  91 .B \-no\-mono
  92 Display the text in a variable-width font.  This is the default.
  93 .TP 8
  94 .B \-wander
  95 Move the text around the screen.  This is the default.
  96 .TP 8
  97 .B \-no\-wander
  98 Keep the text centered on the screen.
  99 .TP 8
 100 .B \-wander\-speed
 101 Sets the speed at which the text wanders around.  Default is 0.02.
 102 .TP 8
 103 .B \-spin
 104 Which axes around which the text should spin.  The default is "XYZ",
 105 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
 106 text in the plane of the screen while not rotating it into or out
 107 of the screen; etc.
 108 .TP 8
 109 .B \-no\-spin
 110 Don't spin the text at all: the same as \fB\-spin ""\fP.
 111 .TP 8
 112 .B \-front
 113 When spinning, never spin all the way around or upside down:
 114 always face mostly forward so that the text is easily readable.
 115 .TP 8
 116 .B \-no\-front
 117 Allow spins to go all the way around or upside down.  This is the default.
 118 .TP 8
 119 .B \-wireframe
 120 Render in wireframe instead of solid.
 121 .TP 8
 122 .B \-fps
 123 Display the current frame rate, CPU load, and polygon count.
 124 .TP 8
 125 .B \-scale
 126 Sets the scale at which the text is rendered.  Bigger values will result
 127 in bigger text; smaller values will result in smaller text.  The default
 128 value is 0.01.
 129 .SH ENVIRONMENT
 130 .PP
 131 .TP 8
 132 .B DISPLAY
 133 to get the default host and display number.
 134 .TP 8
 135 .B XENVIRONMENT
 136 to get the name of a resource file that overrides the global resources
 137 stored in the RESOURCE_MANAGER property.
 138 .SH SEE ALSO
 139 .BR X (1),
 140 .BR xscreensaver (1)
 141 .BR xscreensaver-text (1)
 142 .SH COPYRIGHT
 143 Copyright \(co 2001-2014 by Jamie Zawinski.
 144 Permission to use, copy, modify, distribute, and sell this software and
 145 its documentation for any purpose is hereby granted without fee,
 146 provided that the above copyright notice appear in all copies and that
 147 both that copyright notice and this permission notice appear in
 148 supporting documentation.  No representations are made about the
 149 suitability of this software for any purpose.  It is provided "as is"
 150 without express or implied warranty.
 151 .SH AUTHOR
 152 Jamie Zawinski <jwz@jwz.org>