dbe5d5a96079f2de16bd07bb0260deb6e467c6d3
[xscreensaver] / hacks / glx / flyingtoasters.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 flyingtoasters - 3d space-age jet-powered flying toasters (and toast)
4 .SH SYNOPSIS
5 .B flyingtoasters
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-speed \fInumber\fP]
12 [\-ntoasters \fInumber\fP]
13 [\-nslices \fInumber\fP]
14 [\-no-texture]
15 [\-wireframe]
16 [\-fps]
17 .SH DESCRIPTION
18 Draws a squadron of shiny 3D space-age jet-powered flying toasters, and
19 associated toast, flying across your screen.
20 .SH OPTIONS
21 .TP 8
22 .B \-visual \fIvisual\fP
23 Specify which visual to use.  Legal values are the name of a visual class,
24 or the id number (decimal or hex) of a specific visual.
25 .TP 8
26 .B \-window
27 Draw on a newly-created window.  This is the default.
28 .TP 8
29 .B \-root
30 Draw on the root window.
31 .TP 8
32 .B \-delay \fInumber\fP
33 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
34 .TP 8
35 .B \-speed \fInumber\fP
36 How fast the toasters fly.  Larger for faster.  Default: 1.0.
37 .TP 8
38 .B \-ntoasters \fInumber\fP
39 How many toasters to draw.  Default 20.
40 .TP 8
41 .B \-nslices \fInumber\fP
42 How many slices of toast to draw.  Default 25.
43 .TP 8
44 .B \-no-texture
45 Turn off texture mapping (for slow machines.)
46 .TP 8
47 .B \-wireframe
48 Render in wireframe instead of solid.
49 .TP 8
50 .B \-fps
51 Display the current frame rate, CPU load, and polygon count.
52 .SH ENVIRONMENT
53 .PP
54 .TP 8
55 .B DISPLAY
56 to get the default host and display number.
57 .TP 8
58 .B XENVIRONMENT
59 to get the name of a resource file that overrides the global resources
60 stored in the RESOURCE_MANAGER property.
61 .SH SEE ALSO
62 .BR X (1),
63 .BR xscreensaver (1)
64 .BR After Dark
65 .SH COPYRIGHT
66 Copyright \(co 2003 by Jamie Zawinski.  Permission to use, copy,
67 modify, distribute, and sell this software and its documentation for
68 any purpose is hereby granted without fee, provided that the above
69 copyright notice appear in all copies and that both that copyright
70 notice and this permission notice appear in supporting documentation.
71 No representations are made about the suitability of this software for
72 any purpose.  It is provided "as is" without express or implied
73 warranty.
74
75 The original After Dark flying toasters, with the fluffy white wings,
76 were a trademark of Berkeley Systems.  Berkeley Systems ceased to exist
77 some time in 1998, having been gobbled up by Sierra Online, who were
78 subsequently gobbled up by Flipside and/or Vivendi (it's hard to tell
79 exactly what happened when.)
80
81 I doubt anyone even cares any more, but if they do, hopefully this
82 homage, with the space-age 3D jet-plane toasters, will be considered
83 different enough that whoever still owns the trademark to the
84 fluffy-winged 2D bitmapped toasters won't get all huffy at us.
85 .SH AUTHOR
86 Code by Jamie Zawinski.  Object models by Baconmonkey.