~cyphermox/ubuntu/precise/xscreensaver/merge-5.15-2

« back to all changes in this revision

Viewing changes to hacks/glx/companioncube.man

  • Committer: Mathieu Trudel-Lapierre
  • Date: 2011-12-21 15:57:35 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: mathieu@canonical.com-20111221155735-m43kxy7824n1p36y
Merging shared upstream rev into target branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH XScreenSaver 1 "" "X Version 11"
 
2
.SH NAME
 
3
companioncube - a vital aparatus.
 
4
.SH SYNOPSIS
 
5
.B companioncube
 
6
[\-display \fIhost:display.screen\fP]
 
7
[\-visual \fIvisual\fP]
 
8
[\-window]
 
9
[\-root]
 
10
[\-delay \fInumber\fP]
 
11
[\-speed \fIratio\fP]
 
12
[\-spin]
 
13
[\-wander]
 
14
[\-count \fInumber\fP]
 
15
[\-wireframe]
 
16
[\-fps]
 
17
.SH DESCRIPTION
 
18
The symptoms most commonly produced by Enrichment Center testing are
 
19
superstition, perceiving inanimate objects as alive, and hallucinations.
 
20
The Enrichment Center reminds you that the weighted companion cube will
 
21
never threaten to stab you and, in fact, cannot speak.  In the event that
 
22
the Weighted Companion Cube does speak, the Enrichment Center urges you to
 
23
disregard its advice.
 
24
.SH OPTIONS
 
25
.TP 8
 
26
.B \-visual \fIvisual\fP
 
27
Specify which visual to use.  Legal values are the name of a visual class,
 
28
or the id number (decimal or hex) of a specific visual.
 
29
.TP 8
 
30
.B \-window
 
31
Draw on a newly-created window.  This is the default.
 
32
.TP 8
 
33
.B \-root
 
34
Draw on the root window.
 
35
.TP 8
 
36
.B \-delay \fInumber\fP
 
37
Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
 
38
.TP 8
 
39
.B \-speed \fInumber\fP
 
40
How fast the animation should run.
 
41
Less than 1 for slower, greater than 1 for faster.
 
42
.TP 8
 
43
.B \-count \fInumber\fP
 
44
How many cubes.  Default 3.
 
45
.TP 8
 
46
.B \-spin
 
47
.B \-no\-spin
 
48
Instead of bouncing, float and spin.
 
49
.TP 8
 
50
.B \-wander
 
51
.B \-no\-wander
 
52
Instead of bouncing, float and drift.
 
53
.TP 8
 
54
.B \-wireframe
 
55
Render in wireframe instead of solid.
 
56
.TP 8
 
57
.B \-fps
 
58
Display the current frame rate, CPU load, and polygon count.
 
59
.SH ENVIRONMENT
 
60
.PP
 
61
.TP 8
 
62
.B DISPLAY
 
63
to get the default host and display number.
 
64
.TP 8
 
65
.B XENVIRONMENT
 
66
to get the name of a resource file that overrides the global resources
 
67
stored in the RESOURCE_MANAGER property.
 
68
.SH SEE ALSO
 
69
.BR X (1),
 
70
.BR tronbit (1),
 
71
.BR lament (1),
 
72
.BR dangerball (1),
 
73
.BR xscreensaver (1)
 
74
.SH COPYRIGHT
 
75
Copyright \(co 2011 by Jamie Zawinski.  Permission to use, copy,
 
76
modify, distribute, and sell this software and its documentation for
 
77
any purpose is hereby granted without fee, provided that the above
 
78
copyright notice appear in all copies and that both that copyright
 
79
notice and this permission notice appear in supporting documentation.
 
80
No representations are made about the suitability of this software for
 
81
any purpose.  It is provided "as is" without express or implied
 
82
warranty.
 
83
.SH AUTHOR
 
84
Jamie Zawinski, with apologies to the fine folks at Valve Software
 
85
and Aperture Science.