ftp://ftp.linux.ncsu.edu/mirror/ftp.redhat.com/pub/redhat/linux/enterprise/4/en/os...
[xscreensaver] / hacks / glx / lament.man
1 .TH XScreenSaver 1 "25-Jul-98" "X Version 11"
2 .SH NAME
3 lament - animates the Lament Configuration
4 .SH SYNOPSIS
5 .B lament
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
8 [\-texture] [\-no\-texture] [\-wireframe]
9 .SH DESCRIPTION
10 The \fIlament\fP program draws an animation of a particular puzzle box
11 repeatedly solving itself.
12 .SH OPTIONS
13 .I lament
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 \-texture
30 Use texture maps.  This is the default.
31 .TP 8
32 .B \-no\-texture
33 Do not use texture maps.  This is boring and wrong.
34 .TP 8
35 .B \-wireframe
36 Only draw outlines.
37 .TP 8
38 .B \-delay \fImicroseconds\fP
39 How long to pause between frames.  Default is 20000, or 0.02 second.
40 .TP 8
41 .B \-fps
42 Display a running tally of how many frames per second are being rendered.
43 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
44 your GL performance.
45 .SH ENVIRONMENT
46 .PP
47 .TP 8
48 .B DISPLAY
49 to get the default host and display number.
50 .TP 8
51 .B XENVIRONMENT
52 to get the name of a resource file that overrides the global resources
53 stored in the RESOURCE_MANAGER property.
54 .SH BUGS
55 This hack is glacially slow on machines lacking hardware texture support.
56
57 Occasionally opens doors, admitting theologians of the Order of the Gash.
58 .SH SEE ALSO
59 .BR X (1),
60 .BR xscreensaver (1)
61 .SH COPYRIGHT
62 Copyright \(co 1998 by Jamie Zawinski.  Permission to use, copy, modify, 
63 distribute, and sell this software and its documentation for any purpose is 
64 hereby granted without fee, provided that the above copyright notice appear 
65 in all copies and that both that copyright notice and this permission notice
66 appear in supporting documentation.  No representations are made about the 
67 suitability of this software for any purpose.  It is provided "as is" without
68 express or implied warranty.
69 .SH AUTHOR
70 Jamie Zawinski <jwz@jwz.org>, 25-Jul-98.