3e4e2a68a16f9f2546606cd6d718952ecf4411f3
[xscreensaver] / hacks / glx / gltext.man
1 .TH XScreenSaver 1 "25-Jul-98" "X Version 11"
2 .SH NAME
3 gltext - draws text spinning around in 3D
4 .SH SYNOPSIS
5 .B gltext
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
7 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
8 [\-text \fIstring\fP]
9 .SH DESCRIPTION
10 The \fIgltext\fP program draws some text spinning around in 3D, using
11 a font that appears to be made of solid tubes.  
12 .SH OPTIONS
13 .I gltext
14 accepts the following options:
15 .TP 8
16 .B \-window
17 Draw on a newly-created window.  This is the default.
18 .TP 8
19 .B \-root
20 Draw on the root window.
21 .TP 8
22 .B \-install
23 Install a private colormap for the window.
24 .TP 8
25 .B \-visual \fIvisual\fP\fP
26 Specify which visual to use.  Legal values are the name of a visual class,
27 or the id number (decimal or hex) of a specific visual.
28 .TP 8
29 .B \-text \fIstring\fP
30 The text to display.  This may contain newlines, but it shouldn't be
31 very long.  The default is to display the machine name and OS version.
32 .TP 8
33 .B \-fps
34 Display a running tally of how many frames per second are being rendered.
35 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
36 your GL performance.
37 .SH ENVIRONMENT
38 .PP
39 .TP 8
40 .B DISPLAY
41 to get the default host and display number.
42 .TP 8
43 .B XENVIRONMENT
44 to get the name of a resource file that overrides the global resources
45 stored in the RESOURCE_MANAGER property.
46 .SH SEE ALSO
47 .BR X (1),
48 .BR xscreensaver (1)
49 .SH COPYRIGHT
50 Copyright \(co 2001 by Jamie Zawinski.
51 Permission to use, copy, modify, distribute, and sell this software and
52 its documentation for any purpose is hereby granted without fee,
53 provided that the above copyright notice appear in all copies and that
54 both that copyright notice and this permission notice appear in
55 supporting documentation.  No representations are made about the
56 suitability of this software for any purpose.  It is provided "as is"
57 without express or implied warranty.
58 .SH AUTHOR
59 Jamie Zawinski <jwz@jwz.org>