~ubuntu-branches/ubuntu/trusty/xscreensaver/trusty

« back to all changes in this revision

Viewing changes to hacks/bubbles.man

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-11-30 13:33:13 UTC
  • mfrom: (1.1.8 upstream) (2.1.6 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091130133313-3b5nz2e7hvbb8h3l
Tags: 5.10-3ubuntu1
* Merge with Debian unstable, remaining changes: (LP: #489062)
  - debian/control: add Build-Depends on ubuntu-artwork
  - debian/rules: use /usr/share/backgrounds
  - debian/control: Move xli | xloadimage recommends to suggests
  - debian/split-hacks.config: Use different set of default hacks to Debian
  - debian/source_xscreensaver.py: Add apport hook
  - debian/patches/53_XScreenSaver.ad.in.patch: Use Ubuntu branding

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.de EX          \"Begin example
 
2
.ne 5
 
3
.if n .sp 1
 
4
.if t .sp .5
 
5
.nf
 
6
.in +.5i
 
7
..
 
8
.de EE
 
9
.fi
 
10
.in -.5i
 
11
.if n .sp 1
 
12
.if t .sp .5
 
13
..
 
14
.TH XScreenSaver 1 "14-Dec-95" "X Version 11"
 
15
.SH NAME
 
16
bubbles - frying pan / soft drink simulation
 
17
.SH SYNOPSIS
 
18
.B bubbles
 
19
[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-simple] [\-broken] [\-3D] [\-rise|\-drop] [-trails]
 
20
[\-fps]
 
21
.SH DESCRIPTION
 
22
\fIBubbles\fP sprays lots of little random bubbles all over the window which
 
23
then grow until they reach their maximum size and go pop.  The inspiration
 
24
for this was watching little globules of oil on the bottom of a frying pan
 
25
and it also looks a little like bubbles in fizzy soft drink.  The default
 
26
mode uses fancy ray-traced bubbles but there is also a mode which just draws 
 
27
circles in case the default mode is too taxing on your hardware.
 
28
.SH OPTIONS
 
29
Depending on how your
 
30
.I bubbles
 
31
was compiled, it accepts the following options:
 
32
.TP 8
 
33
.B \-foreground
 
34
Colour of circles if \fI\-simple\fP mode is selected.
 
35
.TP 8
 
36
.B \-background
 
37
Colour of window background.
 
38
.TP 8
 
39
.B \-window
 
40
Draw on a newly-created window.  This is the default.
 
41
.TP 8
 
42
.B \-root
 
43
Draw on the root window.
 
44
.TP 8
 
45
.B \-mono 
 
46
If on a color display, pretend we're on a monochrome display.
 
47
.TP 8
 
48
.B \-install
 
49
Install a private colormap for the window.
 
50
.TP 8
 
51
.B \-visual \fIvisual\fP
 
52
Specify which visual to use.  Legal values are the name of a visual class,
 
53
or the id number (decimal or hex) of a specific visual.
 
54
.TP 8
 
55
.B \-delay microseconds
 
56
How much of a delay should be introduced between steps of the animation.
 
57
Default 800, or about 800 microsecond.  Actually, this is the delay between each
 
58
group of 15 new bubbles since such a delay between each step results in a
 
59
very slow animation rate.
 
60
.TP 8
 
61
.B \-nodelay
 
62
Same as \fI\-delay 0\fP.
 
63
.TP 8
 
64
.B \-simple
 
65
Don't use the default fancy pixmap bubbles.  Just draw circles instead.
 
66
This may give more bearable performance if your hardware wasn't made for
 
67
this sort of thing.
 
68
.TP 8
 
69
.B \-broken
 
70
Don't hide bubbles when they pop.  This was a bug during development
 
71
but the results were actually quite attractive.
 
72
.TP 8
 
73
.B \-3D
 
74
Normally, the simulation is done completely in two dimensions.  When a
 
75
bubble swallows up another bubble, the areas of each are added to get
 
76
the area of the resulting bubble.  This option changes the algorithm
 
77
to instead add volume (imagining each to be a sphere in 3D space).  The
 
78
whole thing looks more realistic but I find it attracts attention to
 
79
the flickering of each bubble as they are move and are redrawn.  Your
 
80
mileage may vary.
 
81
.TP 8
 
82
.B \-quiet
 
83
Don't print messages explaining why one or several command line options
 
84
were ignored.  This is disabled by default.
 
85
.TP 8
 
86
.B \-rise | \-drop 
 
87
.TP 8
 
88
.B \-trails
 
89
.TP 8
 
90
.B \-fps
 
91
Display the current frame rate and CPU load.
 
92
.SH NOTES
 
93
If you find the pace of things too slow, remember that there is a delay
 
94
even though you specify no \fI\-delay\fP option.  Try using \fI\-nodelay\fP
 
95
although beware of the effects of irritation of other users if you're on a 
 
96
shared system as you bleed their CPU time away.
 
97
 
 
98
Some tools to assist in creation of new bubbles are included in the source
 
99
distribution.  These can either be loaded with the \fI\-file\fP or
 
100
\fI\-directory\fP options (if available) or they can be used in place
 
101
of the distributed default bubble (bubble_default.c).
 
102
You might like to copy these scripts to a permanent location and
 
103
use them.  Read bubbles.README.
 
104
 
 
105
Rendered bubbles are not supported on monochrome displays.  I'm not
 
106
convinced that small bubbles, even dithered properly are going to look
 
107
like anything more than a jumble of random dots.
 
108
.SH BUGS
 
109
There is a delay before something appears on the screen when using
 
110
rendered bubbles.  The XPM library seems to take a \fBlong\fP time to make
 
111
pixmaps out of raw data.  This can be irritating on slower systems.
 
112
 
 
113
The movement of the bubbles looks jerky if an incomplete set of bubbles
 
114
is used.  
 
115
 
 
116
The hide/display algorithm could do with some work to avoid flickering
 
117
when \fI\-nodelay\fP is set.
 
118
.SH ENVIRONMENT
 
119
.PP
 
120
.TP 8
 
121
.B DISPLAY
 
122
to get the default host and display number.
 
123
.TP 8
 
124
.B XENVIRONMENT
 
125
to get the name of a resource file that overrides the global resources
 
126
stored in the RESOURCE_MANAGER property.
 
127
.SH SEE ALSO
 
128
.BR X (1),
 
129
.BR xscreensaver (1)
 
130
.SH DISTRIBUTION POLICY
 
131
This work is Copyright \(co 1995, 1996 by James Macnicol.  Permission
 
132
to use, copy, modify, distribute, and sell this software and its
 
133
documentation for any purpose is hereby granted without fee, provided
 
134
that the above copyright notice appear in all copies and that both that
 
135
copyright notice and this permission notice appear in supporting
 
136
documentation.  No representations are made about the suitability of
 
137
this software for any purpose.  It is provided "as is" without express
 
138
or implied warranty.
 
139
.SH AUTHOR
 
140
James Macnicol <james.macnicol@mailexcite.com>