From http://www.jwz.org/xscreensaver/xscreensaver-5.38.tar.gz
[xscreensaver] / hacks / glx / gltext.man
index aac2d9ec7aaf53390822a68559f51c638027ee6e..0d30c5fff17c73f5860884615a5b336479d4d129 100644 (file)
@@ -17,13 +17,15 @@ gltext - draws text spinning around in 3D
 .SH SYNOPSIS
 .B gltext
 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
-[\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
+[\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
 [\-text \fIstring\fP]
 [\-program \fIcommand\fP]
 [\-wander] [\-no-wander]
 [\-spin \fIaxes\fP]
 [\-no-spin]
 [\-front] [\-no\-front]
+[\-wireframe]
+[\-fps]
 .SH DESCRIPTION
 The \fIgltext\fP program draws some text spinning around in 3D, using
 a font that appears to be made of solid tubes.  
@@ -66,13 +68,28 @@ for more details.
 .B \-program \fIcommand\fP
 The given program is run, and its output is displayed.
 If specified, this overrides \fI\-text\fP.
-The program will be re-run every 5 seconds to re-generate the text.
-It should run quickly, and shouldn't generate too much text.
+The output of this program will be repeatedely displayed, with new
+pages of text shifting in every few seconds.  Lines should be relatively
+short.  You might try:
+.EX
+-program 'xscreensaver-text --cols 20'
+.EE
 .TP 8
-.B \-fps
-Display a running tally of how many frames per second are being rendered.
-In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
-your GL performance.
+.B \-maxlines
+Set the number of lines of text to display.  By default, 
+.I gltext
+will print 8 lines of text at a time.  Use this option to increase or
+decrease that number.  Be aware that 
+.I gltext
+is designed to work with a fairly small amount of text, so setting this
+value too high might result in slow performance or strange behaviour
+stemming from buffer overflows.  Increase at your own risk.
+.TP 8
+.B \-mono
+Display the text in a monospace font.  Default is a variable-width font.
+.TP 8
+.B \-no\-mono
+Display the text in a variable-width font.  This is the default.  
 .TP 8
 .B \-wander
 Move the text around the screen.  This is the default.
@@ -80,6 +97,9 @@ Move the text around the screen.  This is the default.
 .B \-no\-wander
 Keep the text centered on the screen.
 .TP 8
+.B \-wander\-speed
+Sets the speed at which the text wanders around.  Default is 0.02.  
+.TP 8
 .B \-spin
 Which axes around which the text should spin.  The default is "XYZ",
 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
@@ -95,6 +115,17 @@ always face mostly forward so that the text is easily readable.
 .TP 8
 .B \-no\-front
 Allow spins to go all the way around or upside down.  This is the default.
+.TP 8
+.B \-wireframe
+Render in wireframe instead of solid.
+.TP 8
+.B \-fps
+Display the current frame rate, CPU load, and polygon count.
+.TP 8
+.B \-scale
+Sets the scale at which the text is rendered.  Bigger values will result
+in bigger text; smaller values will result in smaller text.  The default
+value is 0.01.  
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -107,8 +138,9 @@ stored in the RESOURCE_MANAGER property.
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)
+.BR xscreensaver-text (1)
 .SH COPYRIGHT
-Copyright \(co 2001-2005 by Jamie Zawinski.
+Copyright \(co 2001-2014 by Jamie Zawinski.
 Permission to use, copy, modify, distribute, and sell this software and
 its documentation for any purpose is hereby granted without fee,
 provided that the above copyright notice appear in all copies and that