~ubuntu-branches/debian/sid/xscreensaver/sid

« back to all changes in this revision

Viewing changes to driver/xscreensaver-demo.man

  • Committer: Package Import Robot
  • Author(s): Tormod Volden, Tormod Volden, Jose Luis Rivas
  • Date: 2011-10-06 23:12:30 UTC
  • mfrom: (1.1.11)
  • Revision ID: package-import@ubuntu.com-20111006231230-8wtr3x35zhy02xew
Tags: 5.15-1
[ Tormod Volden ]
* New upstream version 5.15
  - New hacks: hilbert, companioncube and tronbit
  - Turned on LC_CTYPE on Linux (LP: #671923)
* debian/rules: Add build-arch and build-indep targets

[ Jose Luis Rivas ]
* postrm: Kill xscreensaver after removal (Closes: #558024)

Show diffs side-by-side

added added

removed removed

Lines of Context:
81
81
preview area, and some fields that let you configure screen saver behavior.
82
82
.TP 4
83
83
.B Mode
84
 
This option menu controls the behavior of the screen saver.  The options are:
85
 
.RS 8
86
 
.TP 8
 
84
This option menu controls the activation behavior of the screen saver.
 
85
The options are:
 
86
.RS 4
 
87
.TP 4
87
88
.B Disable Screen Saver
88
89
Don't ever blank the screen, and don't ever allow the monitor to power down.
89
 
.TP 8
 
90
.TP 4
90
91
.B Blank Screen Only
91
 
When blanking the screen, just go black: don't run any graphics hacks.
92
 
.TP 8
 
92
When blanking the screen, just go black: don't run any graphics.
 
93
.TP 4
93
94
.B Only One Screen Saver
94
95
When blanking the screen, only ever use one particular display mode (the
95
96
one selected in the list.)
96
 
.TP 8
 
97
.TP 4
97
98
.B Random Screen Saver
98
99
When blanking the screen, select a random display mode from among those
99
 
that are enabled and applicable.  This is the default.
100
 
.TP 8
 
100
that are enabled and applicable.  If there are multiple monitors
 
101
connected, run a different display mode on each one.  This is the default.
 
102
.TP 4
101
103
.B Random Same Saver
102
 
This option only appears if you have multiple monitors.
103
104
This is just like \fBRandom Screen Saver\fP, except that the \fIsame\fP
104
 
randomly-chosen display mode will be run on all monitors, instead of a
105
 
different one being run on each.
 
105
randomly-chosen display mode will be run on all monitors, instead of
 
106
different ones on each.
106
107
.RE
107
108
.TP 4
108
109
.B Demo List
109
110
Double-clicking in the list on the left will let you try out the indicated
110
111
demo.  The screen will go black, and the program will run in full-screen
111
112
mode, just as it would if the \fIxscreensaver\fP daemon had launched it.
112
 
Clicking the mouse again will stop the demo and un-blank the screen, making
113
 
the dialog box visible again.
 
113
Clicking the mouse again will stop the demo and un-blank the screen.
114
114
 
115
115
Single-clicking in the list will run it in the small preview pane on the
116
116
right.  (But beware: many of the display modes behave somewhat differently
162
162
.B Settings
163
163
This button will pop up a dialog where you can configure settings specific
164
164
to the display mode selected in the list.
 
165
.SH SETTINGS DIALOG
 
166
When you click on the \fISettings\fP button on the \fIDisplay Modes\fP
 
167
tab, a configuration dialog will pop up that lets you customize settings
 
168
of the selected display mode.  Each display mode has its own custom
 
169
configuration controls on the left side.
 
170
 
 
171
On the right side is a paragraph or two describing the display mode.
 
172
Below that is a \fBDocumentation\fP button that will display the display
 
173
mode's manual page, if it has one, in a new window (since each of the
 
174
display modes is actually a separate program, they each have their
 
175
own manual.)
 
176
 
 
177
The \fBAdvanced\fP button reconfigures the dialog box so that you can
 
178
edit the display mode's command line directly, instead of using the 
 
179
graphical controls.
165
180
.SH ADVANCED TAB
166
181
This tab lets you change various settings used by the xscreensaver daemon
167
 
itself, rather than its sub-programs.
 
182
itself, as well as some global options shared by all of the display modes.
 
183
 
 
184
.B Image Manipulation
 
185
 
 
186
Some of the graphics hacks manipulate images.  These settings control
 
187
where those source images come from.
 
188
(All of these options work by invoking the
 
189
.BR xscreensaver\-getimage (1)
 
190
program, which is what actually does the work.)
 
191
.RS 4
168
192
.TP 4
169
193
.B Grab Desktop Images
170
 
Some of the graphics hacks manipulate images.  If this option is selected,
171
 
then they are allowed to manipulate the desktop image, that is, a display
172
 
mode might draw a picture of your desktop melting, or being distorted in
173
 
some way.  The security-paranoid might want to disable this option, because
174
 
if it is set, it means that the windows on your desktop will occasionally
175
 
be visible while your screen is locked.  Others will not be able 
176
 
to \fIdo\fP anything, but they may be able to \fIsee\fP whatever you
177
 
left on your screen.
 
194
If this option is selected, then they are allowed to manipulate the
 
195
desktop image, that is, a display mode might draw a picture of your
 
196
desktop melting, or being distorted in some way.  The
 
197
security-paranoid might want to disable this option, because if it is
 
198
set, it means that the windows on your desktop will occasionally be
 
199
visible while your screen is locked.  Others will not be able to
 
200
\fIdo\fP anything, but they may be able to \fIsee\fP whatever you left
 
201
on your screen.
178
202
.TP 4
179
203
.B Grab Video Frames
180
204
If your system has a video capture card, selecting this option will allow
182
206
.TP 4
183
207
.B Choose Random Image
184
208
If this option is set, then the image-manipulating modes will select a
185
 
random image file from disk, from the directory you specify in the text
186
 
entry field.  That directory will be recursively searched for files,
187
 
and it is assumed that all the files under that directory are images.
188
 
 
189
 
If more than one of these options are selected, then one will be chosen at
190
 
random.  If none of them are selected, then an image of video colorbars will
191
 
be used instead.  
192
 
 
193
 
(All three of these options work by invoking the
194
 
.BR xscreensaver\-getimage (1)
195
 
program, which is what actually does the work.)
196
 
.TP 4
 
209
random image file to operate on, from the specified source.  That
 
210
source may be a local directory, which will be recursively searched
 
211
for images.  Or, it may be the URL of an RSS or Atom feed (e.g., a
 
212
Flickr gallery), in which case a random image from that feed will be
 
213
selected instead.  The contents of the feed will be cached locally and
 
214
refreshed periodically as needed.
 
215
.PP
 
216
If more than one of the above image-related options are selected, then
 
217
one will be chosen at random.  If none of them are selected, then an
 
218
image of video colorbars will be used instead.
 
219
.RE
 
220
.PP
197
221
.B Text Manipulation
 
222
 
198
223
Some of the display modes display and manipulate text.  The following
199
224
options control how that text is generated.  (These parameters control
200
225
the behavior of the
201
226
.BR xscreensaver\-text (1)
202
227
program, which is what actually does the work.)
 
228
.RS 4
203
229
.TP 4
204
230
.B Host Name and Time
205
231
If this checkbox is selected, then the text used by the screen savers
206
 
will be the local host name, date, time, and system load.
 
232
will be the local host name, OS version, date, time, and system load.
207
233
.TP 4
208
234
.B Text
209
235
If this checkbox is selected, then the literal text typed in the 
217
243
.TP 4
218
244
.B Program
219
245
If this checkbox is selected, then the given program will be run,
220
 
and its output will be displayed.
 
246
repeatedly, and its output will be displayed.
221
247
.TP 4
222
248
.B URL
223
249
If this checkbox is selected, then the given HTTP URL will be downloaded
225
251
it will be converted to plain-text first.
226
252
 
227
253
Note: this re-downloads the document every time the screen saver
228
 
runs out of text!  It might be considered abusive for you to point
229
 
this at a web server that you do not control, as it will probably
230
 
be hitting that server multiple times a minute.
 
254
runs out of text, so it will probably be hitting that web server multiple
 
255
times a minute.  Be careful that the owner of that server doesn't
 
256
consider that to be abusive.
 
257
.RE
 
258
.PP
 
259
.B Power Management Settings
 
260
 
 
261
These settings control whether, and when, your monitor powers down.
 
262
.RS 4
231
263
.TP 4
232
264
.B Power Management Enabled
233
265
Whether the monitor should be powered down after a period of inactivity.
263
295
way, the power management idle-timers can be completely disabled, but
264
296
the screen will be powered off when black.  (This might be preferable
265
297
on laptops.)
 
298
.RE
 
299
.PP
 
300
.B Fading and Colormaps
 
301
 
 
302
These options control how the screen fades to or from black when
 
303
a screen saver begins or ends.
 
304
.RS 4
266
305
.TP 4
267
306
.B Fade To Black When Blanking
268
307
If selected, then when the screensaver activates, the current contents
286
325
colors as possible.  This does nothing if you are running in 16-bit
287
326
or better.
288
327
.PP
 
328
.RE
289
329
There are more settings than these available, but these are the most 
290
330
commonly used ones; see the manual for
291
331
.BR xscreensaver (1)
292
332
for other parameters that can be set by editing the \fI~/.xscreensaver\fP
293
333
file, or the X resource database.
294
 
.SH SETTINGS DIALOG
295
 
When you click on the \fISettings\fP button on the \fIDisplay Modes\fP
296
 
tab, a configuration dialog will pop up that lets you customize settings
297
 
of the selected display mode.  Each display mode has its own custom
298
 
configuration controls on the left side.
299
 
 
300
 
On the right side is a paragraph or two describing the display mode.
301
 
Below that is a \fBDocumentation\fP button that will display the display
302
 
mode's manual page, if it has one, in a new window (since each of the
303
 
display modes is actually a separate program, they each may have their
304
 
own manual.)
305
 
 
306
 
The \fBAdvanced\fP button reconfigures the dialog box so that you can
307
 
edit the display mode's command line directly, instead of using the 
308
 
graphical controls.  It also lets you configure the X visual type that
309
 
this mode will require.  If you specify one (other than \fIAny\fP) then
310
 
the program will only be run on that kind of visual.  For example, you
311
 
can specify that a particular program should only be run if color is
312
 
available, and another should only be run in monochrome.  See the
313
 
discussion of the \fIprograms\fP parameter in the \fIConfiguration\fP
314
 
section of the
315
 
.BR xscreensaver (1)
316
 
manual.  (OpenGL programs should always have their visual set to "GL".)
317
334
.SH COMMAND-LINE OPTIONS
318
335
.I xscreensaver\-demo
319
336
accepts the following command line options.
346
363
to find the sub-programs to run.  However, note that the sub-programs 
347
364
are actually launched by the \fIxscreensaver\fP daemon, not 
348
365
by \fIxscreensaver-demo\fP itself.  So, what matters is what \fB$PATH\fP
349
 
the \fIxscreensaver\fP program sees.
 
366
that the \fIxscreensaver\fP program sees.
350
367
.TP 8
351
368
.B HOME
352
369
for the directory in which to read and write the \fI.xscreensaver\fP file.
358
375
.B HTTP_PROXY\fR or \fPhttp_proxy
359
376
to get the default HTTP proxy host and port.
360
377
.SH UPGRADES
361
 
The latest version can always be found at 
362
 
http://www.jwz.org/xscreensaver/
 
378
The latest version of xscreensaver, an online version of this manual,
 
379
and a FAQ can always be found at http://www.jwz.org/xscreensaver/
363
380
.SH SEE ALSO
364
381
.BR X (1),
365
382
.BR xscreensaver (1),
367
384
.BR xscreensaver\-getimage (1),
368
385
.BR xscreensaver\-text (1)
369
386
.SH COPYRIGHT
370
 
Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
371
 
by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
372
 
this software and its documentation for any purpose is hereby granted without
373
 
fee, provided that the above copyright notice appear in all copies and that
374
 
both that copyright notice and this permission notice appear in supporting
375
 
documentation.  No representations are made about the suitability of this
376
 
software for any purpose.  It is provided "as is" without express or implied
377
 
warranty.
 
387
Copyright \(co 1992-2011 by Jamie Zawinski.
 
388
Permission to use, copy, modify, distribute, and sell this software
 
389
and its documentation for any purpose is hereby granted without fee,
 
390
provided that the above copyright notice appear in all copies and that
 
391
both that copyright notice and this permission notice appear in
 
392
supporting documentation.  No representations are made about the
 
393
suitability of this software for any purpose.  It is provided "as is"
 
394
without express or implied warranty.
378
395
.SH AUTHOR
379
396
Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
380
397