began for maemo
[xscreensaver] / xscreensaver / hacks / compass.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 compass - draws a spinning compass.
4 .SH SYNOPSIS
5 .B compass
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-no-db]
12 .SH DESCRIPTION
13 This draws a compass, with all elements spinning about randomly, for that
14 ``lost and nauseous'' feeling.
15 .SH OPTIONS
16 .TP 8
17 .B \-visual \fIvisual\fP
18 Specify which visual to use.  Legal values are the name of a visual class,
19 or the id number (decimal or hex) of a specific visual.
20 .TP 8
21 .B \-window
22 Draw on a newly-created window.  This is the default.
23 .TP 8
24 .B \-root
25 Draw on the root window.
26 .TP 8
27 .B \-delay \fInumber\fP
28 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
29 .TP 8
30 .B \-db | \-no-db
31 Double Buffer.  Boolean.
32 .SH ENVIRONMENT
33 .PP
34 .TP 8
35 .B DISPLAY
36 to get the default host and display number.
37 .TP 8
38 .B XENVIRONMENT
39 to get the name of a resource file that overrides the global resources
40 stored in the RESOURCE_MANAGER property.
41 .SH SEE ALSO
42 .BR X (1),
43 .BR xscreensaver (1)
44 .SH COPYRIGHT
45 Copyright \(co 2002 by Jamie Zawinski.  Permission to use, copy, modify, 
46 distribute, and sell this software and its documentation for any purpose is 
47 hereby granted without fee, provided that the above copyright notice appear 
48 in all copies and that both that copyright notice and this permission notice
49 appear in supporting documentation.  No representations are made about the 
50 suitability of this software for any purpose.  It is provided "as is" without
51 express or implied warranty.
52 .SH AUTHOR
53 Jamie Zawinski.