http://packetstormsecurity.org/UNIX/admin/xscreensaver-4.14.tar.gz
[xscreensaver] / driver / xscreensaver.man
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 "25-Oct-2003 (4.14)" "X Version 11"
15 .SH NAME
16 xscreensaver - extensible screen saver framework, plus locking
17 .SH SYNOPSIS
18 .B xscreensaver
19 [\-display \fIhost:display.screen\fP] \
20 [\-verbose] \
21 [\-no\-capture\-stderr] \
22 [\-no\-splash]
23 .SH DESCRIPTION
24 The \fIxscreensaver\fP program waits until the keyboard and mouse have been 
25 idle for a period, and then runs a graphics demo chosen at random.  It 
26 turns off as soon as there is any mouse or keyboard activity.
27
28 This program can lock your terminal in order to prevent others from using it,
29 though its default mode of operation is merely to display pretty pictures on
30 your screen when it is not in use.
31
32 It also provides configuration and control of your monitor's power-saving
33 features.
34 .SH GETTING STARTED
35 For the impatient, try this:
36 .EX
37 xscreensaver &
38 xscreensaver-demo
39 .EE
40 The
41 .BR xscreensaver-demo (1)
42 program pops up a dialog box that lets you configure the screen saver,
43 and experiment with the various display modes.
44
45 .B Note:
46 unlike
47 .BR xlock (1),
48 xscreensaver has a client-server model: the \fIxscreensaver\fP program is a
49 daemon that runs in the background; it is controlled by the foreground
50 .BR xscreensaver-demo (1)
51 and
52 .BR xscreensaver-command (1)
53 programs.
54 .SH CONFIGURATION
55 The easiest way to configure \fIxscreensaver\fP is to simply run the
56 .BR xscreensaver-demo (1)
57 program, and change the settings through the GUI.  The rest of this
58 manual page describes lower level ways of changing settings.
59
60 I'll repeat that because it's important:
61
62 .RS 4
63 The easy way to configure xscreensaver is to run the 
64 .BR xscreensaver-demo (1)
65 program.  You shouldn't need to know any of the stuff described 
66 in \fIthis\fP manual unless you are trying to do something tricky,
67 like customize xscreensaver for site-wide use or something.
68 .RE
69
70 Options to \fIxscreensaver\fP are stored in one of two places: in 
71 a \fI.xscreensaver\fP file in your home directory; or in the X resource
72 database.  If the \fI.xscreensaver\fP file exists, it overrides any settings
73 in the resource database.  
74
75 The syntax of the \fI.xscreensaver\fP file is similar to that of
76 the \fI.Xdefaults\fP file; for example, to set the \fItimeout\fP paramter
77 in the \fI.xscreensaver\fP file, you would write the following:
78 .EX
79 timeout: 5
80 .EE
81 whereas, in the \fI.Xdefaults\fP file, you would write
82 .EX
83 xscreensaver.timeout: 5
84 .EE
85 If you change a setting in the \fI.xscreensaver\fP file while xscreensaver
86 is already running, it will notice this, and reload the file.  (The file will
87 be reloaded the next time the screen saver needs to take some action, such as
88 blanking or unblanking the screen, or picking a new graphics mode.)
89
90 If you change a setting in your X resource database, or if you want
91 xscreensaver to notice your changes immediately instead of the next time
92 it wakes up, then you will need to reload your \fI.Xdefaults\fP file,
93 and then tell the running xscreensaver process to restart itself, like so:
94 .EX
95 xrdb < ~/.Xdefaults
96 xscreensaver-command -restart
97 .EE
98 If you want to set the system-wide defaults, then make your edits to
99 the xscreensaver app-defaults file, which should have been installed
100 when xscreensaver itself was installed.  The app-defaults file will
101 usually be named /usr/lib/X11/app-defaults/XScreenSaver, but different
102 systems might keep it in a different place (for example,
103 /usr/openwin/lib/app-defaults/XScreenSaver on Solaris.)
104
105 When settings are changed in the Preferences dialog box (see above)
106 the current settings will be written to the \fI.xscreensaver\fP file.
107 (The \fI.Xdefaults\fP file and the app-defaults file will never be
108 written by xscreensaver itself.)
109 .PP
110 .TP 8
111 .B timeout\fP (class \fBTime\fP)
112 The screensaver will activate (blank the screen) after the keyboard and
113 mouse have been idle for this many minutes.  Default 10 minutes.
114 .TP 8
115 .B cycle\fP (class \fBTime\fP)
116 After the screensaver has been running for this many minutes, the currently
117 running graphics-hack sub-process will be killed (with \fBSIGTERM\fP), and a
118 new one started.  If this is 0, then the graphics hack will never be changed:
119 only one demo will run until the screensaver is deactivated by user activity.
120 Default 10 minutes.
121 .TP 8
122 .B lock\fP (class \fBBoolean\fP)
123 Enable locking: before the screensaver will turn off, it will require you 
124 to type the password of the logged-in user (really, the person who ran
125 xscreensaver), or the root password.  (\fBNote:\fP this doesn't work if the
126 screensaver is launched by
127 .BR xdm (1)
128 because it can't know the user-id of the logged-in user.  See 
129 the ``\fIUsing XDM(1)\fP'' section, below.
130 .TP 8
131 .B lockTimeout\fP (class \fBTime\fP)
132 If locking is enabled, this controls the length of the ``grace period''
133 between when the screensaver activates, and when the screen becomes locked.
134 For example, if this is 5, and \fI\-timeout\fP is 10, then after 10 minutes,
135 the screen would blank.  If there was user activity at 12 minutes, no password
136 would be required to un-blank the screen.  But, if there was user activity
137 at 15 minutes or later (that is, \fI\-lock\-timeout\fP minutes after 
138 activation) then a password would be required.  The default is 0, meaning
139 that if locking is enabled, then a password will be required as soon as the 
140 screen blanks.
141 .TP 8
142 .B passwdTimeout\fP (class \fBTime\fP)
143 If the screen is locked, then this is how many seconds the password dialog box
144 should be left on the screen before giving up (default 30 seconds.)  This
145 should not be too large: the X server is grabbed for the duration that the
146 password dialog box is up (for security purposes) and leaving the server 
147 grabbed for too long can cause problems.
148 .TP 8
149 .B dpmsEnabled\fP (class \fBBoolean\fP)
150 Whether power management is enabled.
151 .TP 8
152 .B dpmsStandby\fP (class \fBTime\fP)
153 If power management is enabled, how long until the monitor goes solid black.
154 .TP 8
155 .B dpmsSuspend\fP (class \fBTime\fP)
156 If power management is enabled, how long until the monitor goes into
157 power-saving mode.
158 .TP 8
159 .B dpmsOff\fP (class \fBTime\fP)
160 If power management is enabled, how long until the monitor powers down
161 completely.  Note that these settings will have no effect unless both
162 the X server and the display hardware support power management; not 
163 all do.  See the \fIPower Management\fP section, below, for more 
164 information.
165 .TP 8
166 .B visualID\fP (class \fBVisualID\fP)
167 Specify which X visual to use by default.  (Note carefully that this resource
168 is called \fBvisualID\fP, not merely \fBvisual\fP; if you set the \fBvisual\fP
169 resource instead, things will malfunction in obscure ways for obscure reasons.)
170
171 Legal values for the \fBVisualID\fP resource are:
172 .RS 8
173 .TP 8
174 .B default
175 Use the screen's default visual (the visual of the root window.)  
176 This is the default.
177 .TP 8
178 .B best
179 Use the visual which supports the most colors.  Note, however, that the
180 visual with the most colors might be a TrueColor visual, which does not
181 support colormap animation.  Some programs have more interesting behavior
182 when run on PseudoColor visuals than on TrueColor.
183 .TP 8
184 .B mono
185 Use a monochrome visual, if there is one.
186 .TP 8
187 .B gray
188 Use a grayscale or staticgray visual, if there is one and it has more than
189 one plane (that is, it's not monochrome.)
190 .TP 8
191 .B color
192 Use the best of the color visuals, if there are any.
193 .TP 8
194 .B GL
195 Use the visual that is best for OpenGL programs.  (OpenGL programs have
196 somewhat different requirements than other X programs.)
197 .TP 8
198 .I class
199 where \fIclass\fP is one of \fBStaticGray\fP, \fBStaticColor\fP, 
200 \fBTrueColor\fP, \fBGrayScale\fP, \fBPseudoColor\fP, or \fBDirectColor\fP.
201 Selects the deepest visual of the given class.
202 .TP 8
203 .I number
204 where \fInumber\fP (decimal or hex) is interpreted as a visual id number, 
205 as reported by the
206 .BR xdpyinfo (1)
207 program; in this way you can have finer control over exactly which visual
208 gets used, for example, to select a shallower one than would otherwise
209 have been chosen.
210
211 .RE
212 .RS 8
213 Note that this option specifies only the \fIdefault\fP visual that will
214 be used: the visual used may be overridden on a program-by-program basis.
215 See the description of the \fBprograms\fP resource, below.
216 .RE
217 .TP 8
218 .B installColormap\fP (class \fBBoolean\fP)
219 On PseudoColor (8-bit) displays, install a private colormap while the
220 screensaver is active, so that the graphics hacks can get as many
221 colors as possible.  This is the default.  (This only applies when the
222 screen's default visual is being used, since non-default visuals get
223 their own colormaps automatically.)  This can also be overridden on a
224 per-hack basis: see the discussion of the \fBdefault\-n\fP name in the
225 section about the \fBprograms\fP resource.
226
227 This does nothing if you have a TrueColor (16-bit or deeper) display.
228 .TP 8
229 .B verbose\fP (class \fBBoolean\fP)
230 Whether to print diagnostics.  Default false.
231 .TP 8
232 .B timestamp\fP (class \fBBoolean\fP)
233 Whether to print the time of day along with any other diagnostic messages.
234 Default false.
235 .TP 8
236 .B splash\fP (class \fBBoolean\fP)
237 Whether to display a splash screen at startup.  Default true.
238 .TP 8
239 .B splashDuration\fP (class \fBTime\fP)
240 How long the splash screen should remain visible; default 5 seconds.
241 .TP 8
242 .B quad\fP (class \fBBoolean\fP)
243 If true, then \fIfour\fP screensavers will be run on each monitor.
244 Use at your own risk!
245 .TP 8
246 .B helpURL\fP (class \fBURL\fP)
247 The splash screen has a \fIHelp\fP button on it.  When you press it, it will
248 display the web page indicated here in your web browser.
249 .TP 8
250 .B loadURL\fP (class \fBLoadURL\fP)
251 This is the shell command used to load a URL into your web browser.
252 The default setting will load it into Mozilla/Netscape if it is already
253 running, otherwise, will launch a new browser looking at the \fIhelpURL\fP.
254 .TP 8
255 .B demoCommand\fP (class \fBDemoCommand\fP)
256 This is the shell command run when the \fIDemo\fP button on the splash window
257 is pressed.  It defaults to
258 .BR xscreensaver\-demo (1).
259 .TP 8
260 .B prefsCommand\fP (class \fBPrefsCommand\fP)
261 This is the shell command run when the \fIPrefs\fP button on the splash window
262 is pressed.  It defaults to \fIxscreensaver\-demo\ \-prefs\fP.
263 .TP 8
264 .B nice\fP (class \fBNice\fP)
265 The sub-processes created by \fIxscreensaver\fP will be ``niced'' to this
266 level, so that they are given lower priority than other processes on the
267 system, and don't increase the load unnecessarily.  The default is 10.  
268
269 (Higher numbers mean lower priority; see 
270 .BR nice (1)
271 for details.)
272 .TP 8
273 .B memoryLimit\fP (class \fBMemoryLimit\fP)
274 The sub-processes created by \fIxscreensaver\fP will not be allowed to
275 allocate more than this much memory (more accurately, this is the maximum
276 size their address space may become.)  If any sub-process tries to allocate
277 more than this,
278 .BR malloc (3)
279 will fail, and the process will likely exit (or safely crash) rather than
280 going forth and hogging memory.  
281
282 The assumption here is that if one of the screenhacks is trying to use
283 a lot of memory, then something has gone wrong, and it's better to kill
284 that program than to overload the machine.
285
286 Default: 0, meaning "no limit."  30M is a good choice on most systems.
287 (But beware that setting this to a small value can cause OpenGL programs
288 to malfunction on certain systems.)
289 .TP 8
290 .B fade\fP (class \fBBoolean\fP)
291 If this is true, then when the screensaver activates, the current contents
292 of the screen will fade to black instead of simply winking out.  This only
293 works on certain systems.  A fade will also be done when switching graphics
294 hacks (when the \fIcycle\fP timer expires.)  Default: true.  
295 .TP 8
296 .B unfade\fP (class \fBBoolean\fP)
297 If this is true, then when the screensaver deactivates, the original contents
298 of the screen will fade in from black instead of appearing immediately.  This
299 only works on certain systems, and if \fIfade\fP is true as well.
300 Default false.
301 .TP 8
302 .B fadeSeconds\fP (class \fBTime\fP)
303 If \fIfade\fP is true, this is how long the fade will be in 
304 seconds (default 3 seconds.)
305 .TP 8
306 .B fadeTicks\fP (class \fBInteger\fP)
307 If \fIfade\fP is true, this is how many times a second the colormap will
308 be changed to effect a fade.  Higher numbers yield smoother fades, but
309 may make the fades take longer than the specified \fIfadeSeconds\fP if
310 your server isn't fast enough to keep up.  Default 20.
311 .TP 8
312 .B captureStderr\fP (class \fBBoolean\fP)
313 Whether \fIxscreensaver\fP should redirect its stdout and stderr streams to
314 the window itself.  Since its nature is to take over the screen, you would not
315 normally see error messages generated by xscreensaver or the sub-programs it
316 runs; this resource will cause the output of all relevant programs to be
317 drawn on the screensaver window itself, as well as being written to the
318 controlling terminal of the screensaver driver process.  Default true.
319 .TP 8
320 .B ignoreUninstalledPrograms\fP (class \fBBoolean\fP)
321 There may be programs in the list that are not installed on the system,
322 yet are marked as "enabled."  If this preference is true, then such 
323 programs will simply be ignored.  If false, then a warning will be printed
324 if an attempt is made to run the nonexistent program.  Also, the
325 .BR xscreensaver-demo (1)
326 program will suppress the non-existent programs from the list if this
327 is true.  Default: false.
328 .TP 8
329 .B font\fP (class \fBFont\fP)
330 The font used for the stdout/stderr text, if \fBcaptureStderr\fP is true.
331 Default \fB*\-medium\-r\-*\-140\-*\-m\-*\fP (a 14 point fixed-width font.)
332 .TP 8
333 .B mode\fP (class \fBMode\fP)
334 Controls the behavior of xscreensaver.  Legal values are:
335 .RS 8
336 .TP 8
337 .B random
338 When blanking the screen, select a random display mode from among those
339 that are enabled and applicable.  This is the default.
340 .TP 8
341 .B one
342 When blanking the screen, only ever use one particular display mode (the
343 one indicated by the \fIselected\fP setting.)
344 .TP 8
345 .B blank
346 When blanking the screen, just go black: don't run any graphics hacks.
347 .TP 8
348 .B off
349 Don't ever blank the screen, and don't ever allow the monitor to power down.
350
351 .RE
352 .TP 8
353 .B selected\fP (class \fBInteger\fP)
354 When \fImode\fP is set to \fIone\fP, this is the one, indicated by its
355 index in the \fIprograms\fP list.  You're crazy if you count them and
356 set this number by hand: let
357 .BR xscreensaver\-demo (1)
358 do it for you!
359 .TP 8
360 .B programs\fP (class \fBPrograms\fP)
361 The graphics hacks which \fIxscreensaver\fP runs when the user is idle.
362 The value of this resource is a multi-line string, one \fIsh\fP-syntax
363 command per line.  Each line must contain exactly one command: no
364 semicolons, no ampersands.
365
366 When the screensaver starts up, one of these is selected (according to
367 the \fBmode\fP setting), and run.  After the \fIcycle\fP period
368 expires, it is killed, and another is selected and run.
369
370 If a line begins with a dash (-) then that particular program is
371 disabled: it won't be selected at random (though you can still select
372 it explicitly using the
373 .BR xscreensaver\-demo (1)
374 program.)
375
376 If all programs are disabled, then the screen will just be made blank,
377 as when \fImode\fP is set to \fIblank\fP.
378
379 To disable a program, you must mark it as disabled with a dash instead
380 of removing it from the list.  This is because the system-wide (app-defaults)
381 and per-user (.xscreensaver) settings are merged together, and if a user
382 just \fIdeletes\fP an entry from their programs list, but that entry still
383 exists in the system-wide list, then it will come back.  However, if the
384 user \fIdisables\fP it, then their setting takes precedence.
385
386 If the display has multiple screens, then a different program will be run
387 for each screen.  (All screens are blanked and unblanked simultaniously.)
388
389 Note that you must escape the newlines; here is an example of how you
390 might set this in your \fI~/.xscreensaver\fP file:
391
392 .RS 8
393 .EX
394 programs:  \\
395        qix -root                          \\n\\
396        ico -r -faces -sleep 1 -obj ico    \\n\\
397        xdaliclock -builtin2 -root         \\n\\
398        xv -root -rmode 5 image.gif -quit  \\n
399 .EE
400 .RE
401 .RS 8
402 Make sure your \fB$PATH\fP environment variable is set up correctly
403 \fIbefore\fP xscreensaver is launched, or it won't be able to find the
404 programs listed in the \fIprograms\fP resource.
405
406 To use a program as a screensaver, two things are required: that that
407 program draw on the root window (or be able to be configured to draw on
408 the root window); and that that program understand ``virtual root''
409 windows, as used by virtual window managers such as
410 .BR tvtwm (1).
411 (Generally, this is accomplished by just including the \fI"vroot.h"\fP 
412 header file in the program's source.)
413
414 If there are some programs that you want to run only when using a color
415 display, and others that you want to run only when using a monochrome
416 display, you can specify that like this:
417 .EX
418        mono:   mono-program  -root        \\n\\
419        color:  color-program -root        \\n\\
420 .EE
421 .RE
422 .RS 8
423 More generally, you can specify the kind of visual that should be used for
424 the window on which the program will be drawing.  For example, if one 
425 program works best if it has a colormap, but another works best if it has
426 a 24-bit visual, both can be accommodated:
427 .EX
428        PseudoColor: cmap-program  -root   \\n\\
429        TrueColor:   24bit-program -root   \\n\\
430 .EE
431 .RE
432 .RS 8
433 In addition to the symbolic visual names described above (in the discussion
434 of the \fIvisualID\fP resource) one other visual name is supported in
435 the \fIprograms\fP list:
436 .RS 1
437 .TP 4
438 .B default-n
439 This is like \fBdefault\fP, but also requests the use of the default colormap,
440 instead of a private colormap.  (That is, it behaves as if 
441 the \fI\-no\-install\fP command-line option was specified, but only for
442 this particular hack.)  This is provided because some third-party programs
443 that draw on the root window (notably: 
444 .BR xv (1),
445 and
446 .BR xearth (1))
447 make assumptions about the visual and colormap of the root window: 
448 assumptions which xscreensaver can violate.
449
450 .RE
451 If you specify a particular visual for a program, and that visual does not
452 exist on the screen, then that program will not be chosen to run.  This
453 means that on displays with multiple screens of different depths, you can
454 arrange for appropriate hacks to be run on each.  For example, if one screen
455 is color and the other is monochrome, hacks that look good in mono can be 
456 run on one, and hacks that only look good in color will show up on the other.
457 .RE
458 .PP
459 .PP
460 You shouldn't ever need to change the following resources:
461 .PP
462 .TP 8
463 .B pointerPollTime\fP (class \fBTime\fP)
464 When server extensions are not in use, this controls how 
465 frequently \fIxscreensaver\fP checks to see if the mouse position or buttons
466 have changed.  Default 5 seconds.
467 .TP 8
468 .B windowCreationTimeout\fP (class \fBTime\fP)
469 When server extensions are not in use, this controls the delay between when 
470 windows are created and when \fIxscreensaver\fP selects events on them.
471 Default 30 seconds.
472 .TP 8
473 .B initialDelay\fP (class \fBTime\fP)
474 When server extensions are not in use, \fIxscreensaver\fP will wait this many
475 seconds before selecting events on existing windows, under the assumption that 
476 \fIxscreensaver\fP is started during your login procedure, and the window 
477 state may be in flux.  Default 0.  (This used to default to 30, but that was
478 back in the days when slow machines and X terminals were more common...)
479 .TP 8
480 .B sgiSaverExtension\fP (class \fBBoolean\fP)
481 There are a number of different X server extensions which can make
482 xscreensaver's job easier.  The next few resources specify whether these
483 extensions should be utilized if they are available.
484
485 This resource controls whether the SGI \fBSCREEN_SAVER\fP server extension
486 will be used to decide whether the user is idle.  This is the default 
487 if \fIxscreensaver\fP has been compiled with support for this 
488 extension (which is the default on SGI systems.).  If it is available, 
489 the \fBSCREEN_SAVER\fP method is faster and more reliable than what will
490 be done otherwise, so use it if you can.  (This extension is only available
491 on Silicon Graphics systems, unfortunately.)
492 .TP 8
493 .B mitSaverExtension\fP (class \fBBoolean\fP)
494 This resource controls whether the \fBMIT\-SCREEN\-SAVER\fP server extension
495 will be used to decide whether the user is idle.  However, the default for
496 this resource is \fIfalse\fP, because even if this extension is available,
497 it is flaky (and it also makes the \fBfade\fP option not work properly.)
498 Use of this extension is not recommended.
499 .TP 8
500 .B xidleExtension\fP (class \fBBoolean\fP)
501 This resource controls whether the \fBXIDLE\fP server extension will be
502 used to decide whether the user is idle.  This is the default 
503 if \fIxscreensaver\fP has been compiled with support for this extension.
504 (This extension is only available for X11R4 and X11R5 systems, unfortunately.)
505 .TP 8
506 .B procInterrupts\fP (class \fBBoolean\fP)
507 This resource controls whether the \fB/proc/interrupts\fP file should be
508 consulted to decide whether the user is idle.  This is the default
509 if \fIxscreensaver\fP has been compiled on a system which supports this
510 mechanism (i.e., Linux systems.)  
511
512 The benefit to doing this is that \fIxscreensaver\fP can note that the user
513 is active even when the X console is not the active one: if the user is 
514 typing in another virtual console, xscreensaver will notice that and will
515 fail to activate.  For example, if you're playing Quake in VGA-mode, 
516 xscreensaver won't wake up in the middle of your game and start competing 
517 for CPU.
518
519 The drawback to doing this is that perhaps you \fIreally do\fP want idleness
520 on the X console to cause the X display to lock, even if there is activity
521 on other virtual consoles.  If you want that, then set this option to False.
522 (Or just lock the X console manually.)
523
524 The default value for this resource is True, on systems where it works.
525 .TP 8
526 .B overlayStderr\fP (class \fBBoolean\fP)
527 If \fBcaptureStderr\fP is True, and your server supports ``overlay'' visuals,
528 then the text will be written into one of the higher layers instead of into
529 the same layer as the running screenhack.  Set this to False to disable 
530 that (though you shouldn't need to.)
531 .TP 8
532 .B overlayTextForeground\fP (class \fBForeground\fP)
533 The foreground color used for the stdout/stderr text, if \fBcaptureStderr\fP
534 is true.  Default: Yellow.
535 .TP 8
536 .B overlayTextBackground\fP (class \fBBackground\fP)
537 The background color used for the stdout/stderr text, if \fBcaptureStderr\fP
538 is true.  Default: Black.
539 .TP 8
540 .B bourneShell\fP (class \fBBourneShell\fP)
541 The pathname of the shell that \fIxscreensaver\fP uses to start subprocesses.
542 This must be whatever your local variant of \fB/bin/sh\fP is: in particular,
543 it must not be \fBcsh\fP.
544 .SH COMMAND-LINE OPTIONS
545 .I xscreensaver
546 also accepts a few command-line options, mostly for use when debugging:
547 for normal operation, you should configure things via the \fI~/.xscreensaver\fP
548 file.
549 .TP 8
550 .B \-display \fIhost:display.screen\fP
551 The X display to use.  For displays with multiple screens, XScreenSaver
552 will manage all screens on the display simultaniously.
553 .TP 8
554 .B \-verbose
555 Same as setting the \fIverbose\fP resource to \fItrue\fP: print diagnostics
556 on stderr and on the xscreensaver window.
557 .TP 8
558 .B \-no-capture-stderr
559 Same as setting the \fIcaptureStderr\fP resource to \fIfalse\fP: do not
560 redirect the stdout and stderr streams to the xscreensaver window itself.
561 If xscreensaver is crashing, you might need to do this in order to see
562 the error message.
563 .SH HOW IT WORKS
564 When it is time to activate the screensaver, a full-screen black window is
565 created on each screen of the display.  Each window is created in such a way
566 that, to any subsequently-created programs, it will appear to be a ``virtual
567 root'' window.  Because of this, any program which draws on the root 
568 window (and which understands virtual roots) can be used as a screensaver.
569
570 When the user becomes active again, the screensaver windows are unmapped, and
571 the running subprocesses are killed by sending them \fBSIGTERM\fP.  This is 
572 also how the subprocesses are killed when the screensaver decides that it's
573 time to run a different demo: the old one is killed and a new one is launched.
574
575 Before launching a subprocess, \fIxscreensaver\fP stores an appropriate value
576 for \fB$DISPLAY\fP in the environment that the child will receive.  (This is
577 so that if you start \fIxscreensaver\fP with a \fI-display\fP argument, the
578 programs which \fIxscreensaver\fP launches will draw on the same display;
579 and so that the child will end up drawing on the appropriate screen of a
580 multi-headed display.)
581
582 When the screensaver turns off, or is killed, care is taken to restore 
583 the ``real'' virtual root window if there is one.  Because of this, it is
584 important that you not kill the screensaver process with \fIkill -9\fP if
585 you are running a virtual-root window manager.  If you kill it with \-9,
586 you may need to restart your window manager to repair the damage.  This
587 isn't an issue if you aren't running a virtual-root window manager.
588
589 For all the gory details, see the commentary at the top of xscreensaver.c.
590
591 You can control a running screensaver process by using the
592 .BR xscreensaver\-command (1)
593 program (which see.)
594 .SH POWER MANAGEMENT
595 Modern X servers contain support to power down the monitor after an idle
596 period.  If the monitor has powered down, then \fIxscreensaver\fP will
597 notice this (after a few minutes), and will not waste CPU by drawing 
598 graphics demos on a black screen.  An attempt will also be made to
599 explicitly power the monitor back up as soon as user activity is detected.
600
601 As of version 3.28 (Feb 2001), the \fI~/.xscreensaver\fP file controls the
602 configuration of your display's power management settings: if you have
603 used
604 .BR xset (1)
605 to change your power management settings, then xscreensaver will
606 override those changes with the values specified 
607 in \fI~/.xscreensaver\fP (or with its built-in defaults, if there
608 is no \fI~/.xscreensaver\fP file yet.)
609
610 To change your power management settings, run
611 .BR xscreensaver\-demo (1)
612 and change the various timeouts through the user interface.
613 Alternately, you can edit the \fI~/.xscreensaver\fP file directly.
614
615 If the power management section is grayed out in the
616 .BR xscreensaver\-demo (1)
617 window,  then that means that your X server does not support
618 the XDPMS extension, and so control over the monitor's power state
619 is not available.
620
621 If you're using a laptop, don't be surprised if changing the DPMS
622 settings has no effect: many laptops have monitor power-saving behavior
623 built in at a very low level that is invisible to Unix and X.  On such
624 systems, you can typically adjust the power-saving delays only by
625 changing settings in the BIOS in some hardware-specific way.
626
627 If DPMS seems not to be working with XFree86, make sure the "DPMS"
628 option is set in your \fI/etc/X11/XF86Config\fP file.  See the
629 .BR XF86Config (5)
630 manual for details.
631 .SH USING XDM(1)
632 You can run \fIxscreensaver\fP from your 
633 .BR xdm (1)
634 session, so that the screensaver will run even when nobody is logged 
635 in on the console.
636
637 The trick to using xscreensaver with \fIxdm\fP is this: keep in mind the 
638 two very different states in which xscreensaver will be running:
639 .RS 4
640 .TP 3
641 .B 1: Nobody logged in.
642
643 If you're thinking of running xscreensaver from XDM at all, then it's 
644 probably because you want graphics demos to be running on the console
645 when nobody is logged in there.  In this case, xscreensaver will function
646 only as a screen saver, not a screen locker: it doesn't make sense
647 for xscreensaver to lock the screen, since nobody is logged in yet!
648 The only thing on the screen is the XDM login prompt.
649 .TP 3
650 .B 2: Somebody logged in.
651
652 Once someone has logged in through the XDM login window, the situation is
653 very different.  For example: now it makes sense to lock the screen (and
654 prompt for the logged in user's password); and now xscreensaver should
655 consult that user's \fI~/.xscreensaver\fP file; and so on.
656 .RE
657
658 The difference between these two states comes down to a question of,
659 which user is the \fIxscreensaver\fP process running as?  For the first
660 state, it doesn't matter.  If you start \fIxscreensaver\fP in the usual
661 XDM way, then xscreensaver will probably end up running as root, which 
662 is fine for the first case (the ``nobody logged in'' case.)
663
664 However, once someone is logged in, running as root is no longer fine:
665 because xscreensaver will be consulting root's \fI.xscreensaver\fP file
666 instead of that of the logged in user, and won't be prompting for the
667 logged in user's password, and so on.  (This is not a security problem,
668 it's just not what you want.)
669
670 So, once someone has logged in, you want xscreensaver to be running as that
671 user.  The way to accomplish this is to kill the old xscreensaver process
672 and start a new one (as the new user.)
673
674 The simplest way to accomplish all of this is as follows:
675 .RS 4
676 .TP 3
677 .B 1: Launch xscreensaver before anyone logs in.
678
679 To the file \fI/usr/lib/X11/xdm/Xsetup\fP, add the lines
680 .EX
681 xhost +localhost
682 xscreensaver-command -exit
683 xscreensaver &
684 .EE
685 This will run xscreensaver as root, over the XDM login window.
686 Moving the mouse will cause the screen to un-blank, and allow the user
687 to type their password at XDM to log in.
688 .TP 3
689 .B 2: Restart xscreensaver when someone logs in.
690
691 Near the top of the file \fI/usr/lib/X11/xdm/Xsession\fP, add those same lines:
692 .EX
693 xscreensaver-command -exit
694 xscreensaver &
695 .EE
696 When someone logs in, this will kill off the existing (root) xscreensaver
697 process, and start a new one, running as the user who has just logged in.
698 If the user's .xscreensaver file requests locking, they'll get it.  They
699 will also get their own choice of timeouts, and graphics demos, and so on.
700
701 Alternately, each user could just put those lines in their 
702 personal \fI~/.xsession\fP files.
703 .RE
704
705 Make sure you have \fB$PATH\fP set up correctly in the \fIXsetup\fP 
706 and \fIXsession\fP scripts, or \fIxdm\fP won't be able to 
707 find \fIxscreensaver\fP, and/or \fIxscreensaver\fP won't be able to 
708 find its graphics demos.
709
710 (If your system does not seem to be executing the \fIXsetup\fP file, you
711 may need to configure it to do so: the traditional way to do this is
712 to make that file the value of the \fIDisplayManager*setup\fP resource
713 in the \fI/usr/lib/X11/xdm/xdm-config\fP file.  See the man page for
714 .BR xdm (1)
715 for more details.)
716
717 It is safe to run \fIxscreensaver\fP as root (as \fIxdm\fP is likely to do.)  
718 If run as root, \fIxscreensaver\fP changes its effective user and group ids 
719 to something safe (like \fI"nobody"\fP) before connecting to the X server
720 or launching user-specified programs.
721
722 An unfortunate side effect of this (important) security precaution is that
723 it may conflict with cookie-based authentication.
724
725 If you get "connection refused" errors when running \fIxscreensaver\fP
726 from \fIxdm\fP, then this probably means that you have
727 .BR xauth (1)
728 or some other security mechanism turned on.  One way around this is to
729 add \fB"xhost\ +localhost"\fP to \fIXsetup\fP, just before \fIxscreensaver\fP
730 is launched.  
731
732 Note that this will give access to the X server to anyone capable of logging
733 in to the local machine, so in some environments, this might not be 
734 appropriate.  If turning off file-system-based access control is not
735 acceptable, then running \fIxscreensaver\fP from the \fIXsetup\fP file
736 might not be possible, and xscreensaver will only work when running as
737 a normal, unprivileged user.
738
739 For more information on the X server's access control mechanisms, see the
740 man pages for
741 .BR X (1),
742 .BR Xsecurity (1),
743 .BR xauth (1),
744 and
745 .BR xhost (1).
746 .SH USING GDM(1)
747 Using xscreensaver with
748 .BR gdm (1)
749 is easy, because gdm has a configuration tool.  Just fire up
750 .BR gdmconfig (1)
751 and on the \fIBackground\fP page, type \fB"xscreensaver -nosplash"\fP into
752 the \fIBackground Program\fP field.  That will cause gdm to run xscreensaver
753 while nobody is logged in, and kill it as soon as someone does log in.
754 (The user will then be responsible for starting xscreensaver on their
755 own, if they want.)
756
757 Another way to accomplish the same thing is to edit the
758 file \fI/etc/X11/gdm/gdm.conf\fP to include:
759 .EX
760 BackgroundProgram=xscreensaver -nosplash
761 RunBackgroundProgramAlways=true
762 .EE
763 In this situation, the \fIxscreensaver\fP process will probably be running
764 as user \fIgdm\fP instead of \fIroot\fP.  You can configure the settings
765 for this nobody-logged-in state (timeouts, DPMS, etc.) by editing
766 the \fI~gdm/.xscreensaver\fP file.
767 .SH USING KDE (K DESKTOP ENVIRONMENT)
768 I understand that KDE has invented their own wrapper around xscreensaver,
769 that is inferior to 
770 .BR xscreensaver-demo (1)
771 in any number of ways.  I've never actually seen it, but I'm told that
772 this is the way you disable it:
773 .RS 4
774 .TP 3
775 \fB1: Switch off KDE's screen saver.\fP
776 Open the ``\fIControl Center\fP'' and
777 select the ``\fILook and Feel / Screensaver\fP'' page.
778 Turn off the ``\fIEnable Screensaver\fP'' checkbox.
779 .TP 3
780 \fB2: Find your Autostart directory.\fP
781 Open the ``\fILook and Feel / Desktop / Paths\fP'' page,
782 and see what your ``Autostart'' directory is set to: it will
783 probably be \fI~/.kde3/Autostart/\fP or something similar.
784 .TP 3
785 \fB3: Make xscreensaver be an Autostart program.\fP
786 Create a file in your autostart directory 
787 called \fIxscreensaver.desktop\fP that contains the following five lines:
788 .EX
789 [Desktop Entry]
790 Exec=xscreensaver
791 Name=XScreensaver
792 Type=Application
793 X-KDE-StartupNotify=false
794 .EE
795 .RE
796 .PP
797 Now use xscreensaver normally, controlling it via the usual
798 .BR xscreensaver-demo (1)
799 and
800 .BR xscreensaver-command (1)
801 mechanisms.
802 .SH USING CDE (COMMON DESKTOP ENVIRONMENT)
803 The easiest way to use \fIxscreensaver\fP on a system with CDE is to simply
804 switch off the built-in CDE screensaver, and use \fIxscreensaver\fP instead;
805 and second, to tell the front panel to run 
806 .BR xscreensaver\-command (1)
807 with the \fI\-lock\fP option when the \fILock\fP icon is clicked.
808
809 To accomplish this involves five steps:
810 .RS 4
811 .TP 3
812 \fB1: Switch off CDE's locker\fP
813 Do this by turning off ``\fIScreen Saver and Screen Lock\fP'' in the
814 Screen section of the Style Manager.
815 .TP 3
816 \fB2: Edit sessionetc\fP
817 Edit the file \fI~/.dt/sessions/sessionetc\fP and add to it the line
818 .EX
819 xscreensaver &
820 .EE
821 And make sure the sessionetc file is executable.
822 This will cause \fIxscreensaver\fP to be launched when you log in.
823 (As always, make sure that xscreensaver and the graphics demos are on
824 your \fB$PATH\fP; the path needs to be set in \fI.cshrc\fP 
825 and/or \fI.dtprofile\fP, not \fI.login\fP.)
826 .TP 3
827 \fB3: Create XScreenSaver.dt\fP
828 Create a file called \fI~/.dt/types/XScreenSaver.dt\fP with the following
829 contents:
830 .EX
831 ACTION XScreenSaver
832 {
833   LABEL         XScreenSaver
834   TYPE          COMMAND
835   EXEC_STRING   xscreensaver-command -lock
836   ICON          Dtkey
837   WINDOW_TYPE   NO_STDIO
838 }
839 .EE
840 This defines a ``lock'' command for the CDE front panel, that knows how
841 to talk to \fIxscreensaver\fP.
842 .TP 3
843 \fB4: Create Lock.fp\fP
844 Create a file called \fI~/.dt/types/Lock.fp\fP with the following
845 contents:
846 .EX
847 CONTROL Lock
848 {
849   TYPE             icon
850   CONTAINER_NAME   Switch
851   CONTAINER_TYPE   SWITCH
852   POSITION_HINTS   1
853   ICON             Fplock
854   LABEL            Lock
855   PUSH_ACTION      XScreenSaver
856   HELP_TOPIC       FPOnItemLock
857   HELP_VOLUME      FPanel
858 }
859 .EE
860 This associates the CDE front panel ``Lock'' icon with the lock command
861 we just defined in step 3.
862 .TP 3
863 \fB5: Restart\fP
864 Select ``\fIRestart Workspace Manager\fP'' from the popup menu to make
865 your changes take effect.  If things seem not to be working, check the
866 file \fI~/.dt/errorlog\fP for error messages.
867 .RE
868 .SH USING HP VUE (VISUAL USER ENVIRONMENT)
869 Since CDE is a descendant of VUE, the instructions for using xscreensaver
870 under VUE are similar to the above:
871 .RS 4
872 .TP 3
873 \fB1: Switch off VUE's locker\fP
874 Open the ``\fIStyle Manager\fP'' and select ``\fIScreen\fP.''
875 Turn off ``\fIScreen Saver and Screen Lock\fP'' option.
876 .TP 3
877 \fB2: Make sure you have a Session\fP
878 Next, go to the Style Manager's, ``\fIStartup\fP'' page.
879 Click on ``\fISet Home Session\fP'' to create a session, then 
880 on ``\fIReturn to Home Session\fP'' to select this session each
881 time you log in.
882 .TP 3
883 \fB3: Edit vue.session\fP
884 Edit the file \fI~/.vue/sessions/home/vue.session\fP and add to it
885 the line
886 .EX
887 vuesmcmd -screen 0 -cmd "xscreensaver"
888 .EE
889 This will cause \fIxscreensaver\fP to be launched when you log in.
890 (As always, make sure that xscreensaver and the graphics demos are on
891 your \fB$PATH\fP; the path needs to be set in \fI.cshrc\fP
892 and/or \fI.profile\fP, not \fI.login\fP.)
893 .TP 3
894 \fB3: Edit vuewmrc\fP
895 Edit the file \fI~/.vue/vuewmrc\fP and add (or change) the Lock control:
896 .EX
897 CONTROL Lock
898 {
899   TYPE         button
900   IMAGE        lock
901   PUSH_ACTION  f.exec "xscreensaver-command -lock"
902   HELP_TOPIC   FPLock
903 }
904 .EE
905 This associates the VUE front panel ``Lock'' icon with the xscreensaver 
906 lock command.
907 .RE
908 .PP
909 .SH BUGS
910 Bugs?  There are no bugs.  Ok, well, maybe.  If you find one, please let
911 me know.  http://www.jwz.org/xscreensaver/bugs.html explains how to
912 construct the most useful bug reports.
913 .TP 8
914 .B Locking and XDM
915 If xscreensaver has been launched from 
916 .BR xdm (1)
917 before anyone has logged in, you will need to kill and then restart the
918 xscreensaver daemon after you have logged in, or you will be confused by
919 the results.  (For example, locking won't work, and your \fI~/.xscreensaver\fP
920 file will be ignored.)
921
922 When you are logged in, you want the \fIxscreensaver\fP daemon to be 
923 running under \fIyour\fP user id, not as root or some other user.
924
925 If it has already been started by \fIxdm\fP, you can kill it by sending
926 it the \fBexit\fP command, and then re-launching it as you, by putting
927 something like the following in your personal X startup script:
928 .EX
929 xscreensaver-command -exit
930 xscreensaver &
931 .EE
932 The ``\fIUsing XDM(1)\fP'' section, above, goes into more detail, and explains
933 how to configure the system to do this for all users automatically.
934 .TP 8
935 .B Locking and root logins
936 In order for it to be safe for xscreensaver to be launched by \fIxdm\fP,
937 certain precautions had to be taken, among them that xscreensaver never
938 runs as \fIroot\fP.  In particular, if it is launched as root (as \fIxdm\fP
939 is likely to do), xscreensaver will disavow its privileges, and switch 
940 itself to a safe user id (such as \fInobody\fP.)
941
942 An implication of this is that if you log in as \fIroot\fP on the console, 
943 xscreensaver will refuse to lock the screen (because it can't tell
944 the difference between \fIroot\fP being logged in on the console, and a
945 normal user being logged in on the console but xscreensaver having been 
946 launched by the
947 .BR xdm (1)
948 .I Xsetup
949 file.)
950
951 The solution to this is simple: you shouldn't be logging in on the console
952 as \fIroot\fP in the first place!  (What, are you crazy or something?)  
953
954 Proper Unix hygiene dictates that you should log in as yourself, and
955 .BR su (1)
956 to \fIroot\fP as necessary.  People who spend their day logged in
957 as \fIroot\fP are just begging for disaster.
958 .TP 8
959 .B XAUTH and XDM
960 For xscreensaver to work when launched by
961 .BR xdm (1),
962 programs running on the local machine as user \fI"nobody"\fP must be
963 able to connect to the X server.  This means that if you want to run
964 xscreensaver on the console while nobody is logged in, you may need
965 to disable cookie-based access control (and allow all users who can log
966 in to the local machine to connect to the display.)  
967
968 You should be sure that this is an acceptable thing to do in your
969 environment before doing it.  See the ``\fIUsing XDM(1)\fP'' section, 
970 above, for more details.
971 .TP 8
972 .B Passwords
973 If you get an error message at startup like ``couldn't get password
974 of \fIuser\fP'' then this probably means that you're on a system in which 
975 the
976 .BR getpwent (3)
977 library routine can only be effectively used by root.  If this is the case, 
978 then \fIxscreensaver\fP must be installed as setuid to root in order for
979 locking to work.  Care has been taken to make this a safe thing to do.  
980
981 It also may mean that your system uses shadow passwords instead of the standard
982 .BR getpwent (3)
983 interface; in that case, you may need to change some options 
984 with \fIconfigure\fP and recompile.
985
986 If you change your password after xscreensaver has been launched, it will
987 continue using your old password to unlock the screen until xscreensaver
988 is restarted.  On some systems, it may accept \fIboth\fP your old and new
989 passwords.  So, after you change your password, you'll have to do
990 .EX
991 xscreensaver-command -restart
992 .EE
993 to make \fIxscreensaver\fP notice.
994 .TP 8
995 .B PAM Passwords
996 If your system uses PAM (Pluggable Authentication Modules), then in order
997 for xscreensaver to use PAM properly, PAM must be told about xscreensaver.
998 The xscreensaver installation process should update the PAM data (on Linux,
999 by creating the file \fI/etc/pam.d/xscreensaver\fP for you, and on Solaris, 
1000 by telling you what lines to add to the \fI/etc/pam.conf\fP file.)  
1001
1002 If the PAM configuration files do not know about xscreensaver, then 
1003 you \fImight\fP be in a situation where xscreensaver will refuse to ever
1004 unlock the screen.
1005
1006 This is a design flaw in PAM (there is no way for a client to tell the
1007 difference between PAM responding ``I have never heard of your module,''
1008 and responding, ``you typed the wrong password.'')  As far as I can tell,
1009 there is no way for xscreensaver to automatically work around this, or
1010 detect the problem in advance, so if you have PAM, make sure it is
1011 configured correctly!
1012 .TP 8
1013 .B Colormap lossage: TWM
1014 The \fBinstallColormap\fP option doesn't work very well with the
1015 .BR twm (1)
1016 window manager and its descendants, on 8-bit screens.
1017
1018 There is a race condition between the screensaver and this window manager,
1019 which can result in the screensaver's colormap not getting installed
1020 properly, meaning the graphics hacks will appear in essentially random
1021 colors.  (If the screen goes white instead of black, this is probably why.)
1022
1023 The
1024 .BR mwm (1)
1025 and
1026 .BR olwm (1)
1027 window managers don't have this problem.  The race condition exists
1028 because X (really, ICCCM) does not provide a way for an OverrideRedirect 
1029 window to have its own colormap, short of grabbing the server (which is 
1030 neither a good idea, nor really possible with the current design.)  What 
1031 happens is that, as soon as xscreensaver installs its colormap, \fBtwm\fP 
1032 responds to the resultant \fBColormapNotify\fP event by re-instaling the 
1033 default colormap.  Apparently, \fBtwm\fP doesn't \fIalways\fP do this; it 
1034 seems to do it regularly if the screensaver is activated from a menu item, 
1035 but seems to not do it if the screensaver comes on of its own volition, or 
1036 is activated from another console.  
1037 .RS 8
1038 .TP 4
1039 .B Attention, window manager authors!
1040 You should only call
1041 .BR XInstallColormap (3)
1042 in response to user events.  That is, it is appropriate to install a colormap
1043 in response to \fBFocusIn\fP, \fBFocusOut\fP, \fBEnterNotify\fP, 
1044 and \fBLeaveNotify\fP events; but it is not appropriate to call it in
1045 response to \fBColormapNotify\fP events.  If you install colormaps in
1046 response to \fIapplication\fP actions as well as in response to \fIuser\fP
1047 actions, then you create the situation where it is impossible for 
1048 override-redirect applications (such as xscreensaver) to display their
1049 windows in the proper colors.
1050 .RE
1051 .TP 8
1052 .B Colormap lossage: XV, XAnim, XEarth
1053 Some programs don't operate properly on visuals other than the default one,
1054 or with colormaps other than the default one.  See the discussion of the
1055 magic "default-n" visual name in the description of the \fBprograms\fP 
1056 resource in the \fIConfiguration\fP section.  When programs only work with
1057 the default colormap, you need to use a syntax like this:
1058 .EX
1059    default-n: xv -root image-1.gif -quit  \\n\\
1060    default-n: xearth -nostars -wait 0     \\n\\
1061 .EE
1062 It would also work to turn off the \fBinstallColormap\fP option altogether,
1063 but that would deny extra colors to those programs that \fIcan\fP take
1064 advantage of them.
1065 .TP 8
1066 .B Machine Load
1067 Although this program ``nices'' the subprocesses that it starts, 
1068 graphics-intensive subprograms can still overload the machine by causing
1069 the X server process itself (which is not ``niced'') to consume many
1070 cycles.  Care has been taken in all the modules shipped with xscreensaver
1071 to sleep periodically, and not run full tilt, so as not to cause
1072 appreciable load.
1073
1074 However, if you are running the OpenGL-based screen savers on a machine
1075 that does not have a video card with 3D acceleration, they \fIwill\fP
1076 make your machine slow, despite
1077 .BR nice (1).
1078
1079 Your options are: don't use the OpenGL display modes; or, collect the
1080 spare change hidden under the cushions of your couch, and use it to
1081 buy a video card manufactured after 1998.  (It doesn't even need to be
1082 \fIfast\fP 3D hardware: the problem will be fixed if there is any
1083 3D hardware \fIat all.\fP)
1084 .TP 8
1085 .B XFree86's Magic Keystrokes
1086 The XFree86 X server traps certain magic keystrokes before client programs ever
1087 see them.  Two that are of note are Ctrl+Alt+Backspace, which causes 
1088 the X server to exit; and Ctrl+Alt+F\fIn\fP, which switches virtual consoles.
1089 The X server will respond to these keystrokes even if xscreensaver has the
1090 screen locked.  Depending on your setup, you might consider this a problem.
1091
1092 Unfortunately, there is no way for xscreensaver itself to override the
1093 interpretation of these keys.  If you want to disable Ctrl+Alt+Backspace
1094 globally, you need to set the \fIDontZap\fP flag in 
1095 your \fI/etc/X11/XF86Config\fP file.  To globally disable VT switching,
1096 you can set the \fIDontVTSwitch\fP flag.  See the
1097 .BR XF86Config (5)
1098 manual for details.
1099 .TP 8
1100 .B MIT Extension and Fading
1101 The \fBMIT-SCREEN-SAVER\fP extension is junk.  Don't use it.
1102
1103 When using the \fBMIT-SCREEN-SAVER\fP extension in conjunction with 
1104 the \fBfade\fP option, you'll notice an unattractive flicker just before 
1105 the fade begins.  This is because the server maps a black window just before 
1106 it tells the \fIxscreensaver\fP process to activate.  The \fIxscreensaver\fP 
1107 process immediately unmaps that window, but this results in a flicker.  I 
1108 haven't figured a way  to get around this; it seems to be a fundamental
1109 property of the (mis-) design of this server extension.
1110
1111 It sure would be nice if someone would implement the \fBSGI SCREEN_SAVER\fP
1112 extension in XFree86; it's dead simple, and works far better than the
1113 overengineered and broken \fBMIT-SCREEN-SAVER\fP extension.
1114 .TP 8
1115 .B Keyboard LEDs
1116 If \fIprocInterrupts\fP is on (which is the default on Linux systems) and
1117 you're using some program that toggles the state of your keyboard LEDs,
1118 xscreensaver won't work right: turning those LEDs on or off causes a 
1119 keyboard interrupt, which xscreensaver will interpret as user activity.
1120 So if you're using such a program, set the \fIprocInterrupts\fP resource
1121 to False.
1122 .TP 8
1123 .B Extensions
1124 If you are not making use of one of the server extensions (\fBXIDLE\fP,
1125 \fBSGI SCREEN_SAVER\fP, or \fBMIT-SCREEN-SAVER\fP), then it is possible, in 
1126 rare situations, for \fIxscreensaver\fP to interfere with event propagation 
1127 and make another X program malfunction.  For this to occur, that other
1128 application would need to \fInot\fP select \fBKeyPress\fP events on its 
1129 non-leaf windows within the first 30 seconds of their existence, but then 
1130 select for them later.  In this case, that client \fImight\fP fail to receive 
1131 those events.  This isn't very likely, since programs generally select a
1132 constant set of events immediately after creating their windows and then 
1133 don't change them, but this is the reason that it's a good idea to install 
1134 and use one of the server extensions instead, to work around this shortcoming
1135 in the X protocol.
1136
1137 In all these years, I've not heard of even a single case of this happening,
1138 but it is theoretically possible, so I'm mentioning it for completeness...
1139 .SH ENVIRONMENT
1140 .PP
1141 .TP 8
1142 .B DISPLAY
1143 to get the default host and display number, and to inform the sub-programs
1144 of the screen on which to draw.
1145 .TP 8
1146 .B PATH
1147 to find the sub-programs to run.
1148 .TP 8
1149 .B HOME
1150 for the directory in which to read the \fI.xscreensaver\fP file.
1151 .TP 8
1152 .B XENVIRONMENT
1153 to get the name of a resource file that overrides the global resources
1154 stored in the RESOURCE_MANAGER property.
1155 .SH UPGRADES
1156 The latest version of xscreensaver, an online version of this manual,
1157 and a FAQ can always be found at http://www.jwz.org/xscreensaver/
1158 .SH SEE ALSO
1159 .BR X (1),
1160 .BR Xsecurity (1),
1161 .BR xauth (1),
1162 .BR xscreensaver\-demo (1),
1163 .BR xscreensaver\-command (1),
1164 .BR xscreensaver\-gl\-helper (1),
1165 .BR xscreensaver\-getimage (1),
1166 .BR xdm (1),
1167 .BR gdm (1),
1168 .BR xset (1),
1169 .BR xhost (1).
1170 .BR anemone (1),
1171 .BR ant (1),
1172 .BR apollonian (1),
1173 .BR atlantis (1),
1174 .BR attraction (1),
1175 .BR barcode (1),
1176 .BR blaster (1),
1177 .BR blitspin (1),
1178 .BR bouboule (1),
1179 .BR boxed (1),
1180 .BR braid (1),
1181 .BR bsod (1),
1182 .BR bubble3d (1),
1183 .BR bubbles (1),
1184 .BR bumps (1),
1185 .BR cage (1),
1186 .BR ccurve (1),
1187 .BR circuit (1),
1188 .BR compass (1),
1189 .BR coral (1),
1190 .BR cosmos (1),
1191 .BR critical (1),
1192 .BR crystal (1),
1193 .BR cubenetic (1),
1194 .BR cynosure (1),
1195 .BR dangerball (1),
1196 .BR decayscreen (1),
1197 .BR deco (1),
1198 .BR deluxe (1),
1199 .BR demon (1),
1200 .BR discrete (1),
1201 .BR distort (1),
1202 .BR drift (1),
1203 .BR electricsheep (1),
1204 .BR endgame (1),
1205 .BR engine (1),
1206 .BR epicycle (1),
1207 .BR eruption (1),*
1208 .BR euler2d (1),
1209 .BR extrusion (1),
1210 .BR fadeplot (1),
1211 .BR flag (1),
1212 .BR flame (1),
1213 .BR flipscreen3d (1),
1214 .BR flow (1),
1215 .BR fluidballs (1),
1216 .BR flurry (1),
1217 .BR forest (1),
1218 .BR galaxy (1),
1219 .BR gears (1),
1220 .BR gflux (1),
1221 .BR glblur (1),
1222 .BR glforestfire (1),
1223 .BR glplanet (1),
1224 .BR glsnake (1),
1225 .BR gltext (1),
1226 .BR goban (1),
1227 .BR goop (1),
1228 .BR grav (1),
1229 .BR greynetic (1),
1230 .BR halftone (1),
1231 .BR halo (1),
1232 .BR helix (1),
1233 .BR hopalong (1),
1234 .BR hyperball (1),
1235 .BR hypercube (1),
1236 .BR ifs (1),
1237 .BR imsmap (1),
1238 .BR interference (1),
1239 .BR jigsaw (1),
1240 .BR juggle (1),
1241 .BR julia (1),
1242 .BR kaleidescope (1),
1243 .BR kumppa (1),
1244 .BR lament (1),
1245 .BR laser (1),
1246 .BR lavalite (1),
1247 .BR lightning (1),
1248 .BR lisa (1),
1249 .BR lissie (1),
1250 .BR lmorph (1),
1251 .BR loop (1),
1252 .BR maze (1),
1253 .BR menger (1),
1254 .BR metaballs (1),
1255 .BR moebius (1),
1256 .BR moire (1),
1257 .BR moire2 (1),
1258 .BR molecule (1),
1259 .BR morph3d (1),
1260 .BR mountain (1),
1261 .BR munch (1),
1262 .BR nerverot (1),
1263 .BR noseguy (1),
1264 .BR pedal (1),
1265 .BR penetrate (1),
1266 .BR penrose (1),
1267 .BR petri (1),
1268 .BR phosphor (1),
1269 .BR pipes (1),
1270 .BR polyominoes (1),
1271 .BR popsquares (1),
1272 .BR pulsar (1),
1273 .BR pyro (1),
1274 .BR qix (1),
1275 .BR queens (1),
1276 .BR rd-bomb (1),
1277 .BR ripples (1),
1278 .BR rocks (1),
1279 .BR rorschach (1),
1280 .BR rotor (1),
1281 .BR rotzoomer (1),
1282 .BR rubik (1),
1283 .BR sballs (1),
1284 .BR shadebobs (1),
1285 .BR sierpinski (1),
1286 .BR sierpinski3d (1),
1287 .BR slidescreen (1),
1288 .BR slip (1),
1289 .BR sonar (1),
1290 .BR speedmine (1),
1291 .BR sphere (1),
1292 .BR sphereEversion (1),
1293 .BR spheremonics (1),
1294 .BR spiral (1),
1295 .BR spotlight (1),
1296 .BR sproingies (1),
1297 .BR squiral (1),
1298 .BR ssystem (1),
1299 .BR stairs (1),
1300 .BR starfish (1),
1301 .BR starwars (1),
1302 .BR stonerview (1),
1303 .BR strange (1),
1304 .BR superquadrics (1),
1305 .BR swirl (1),
1306 .BR t3d (1),
1307 .BR thornbird (1),
1308 .BR triangle (1),
1309 .BR truchet (1),
1310 .BR twang (1),
1311 .BR vermiculate (1),
1312 .BR vidwhacker (1),
1313 .BR vines (1),
1314 .BR wander (1),
1315 .BR webcollage (1),
1316 .BR whirlwindwarp (1),
1317 .BR whirlygig (1),
1318 .BR worm (1),
1319 .BR xaos (1),
1320 .BR xdaliclock (1),
1321 .BR xearth (1),
1322 .BR xfishtank (1),
1323 .BR xflame (1),
1324 .BR xjack (1),
1325 .BR xlyap (1),
1326 .BR xmatrix (1),
1327 .BR xmountains (1),
1328 .BR xrayswarm (1),
1329 .BR xsnow (1),
1330 .BR xspirograph (1),
1331 .BR xteevee (1),
1332 .BR zoom (1)
1333 .SH COPYRIGHT
1334 Copyright \(co 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
1335 2000, 2001, 2002, 2003 by Jamie Zawinski.  Permission to use, copy,
1336 modify, distribute, and sell this software and its documentation for
1337 any purpose is hereby granted without fee, provided that the above
1338 copyright notice appear in all copies and that both that copyright
1339 notice and this permission notice appear in supporting documentation.
1340 No representations are made about the suitability of this software for
1341 any purpose.  It is provided "as is" without express or implied
1342 warranty.
1343 .SH AUTHOR
1344 Jamie Zawinski <jwz@jwz.org>.  Written in late 1991; version 1.0 posted
1345 to comp.sources.x on 17-Aug-1992.
1346
1347 Please let me know if you find any bugs or make any improvements.
1348 .SH ACKNOWLEDGEMENTS
1349 Thanks to Angela Goodman for the XScreenSaver logo.
1350
1351 Thanks to the many people who have contributed graphics demos to the package.
1352
1353 Thanks to David Wojtowicz for implementing \fIlockTimeout\fP.
1354
1355 Thanks to Martin Kraemer for adding support for shadow passwords and
1356 locking-disabled diagnostics.
1357
1358 Thanks to Patrick Moreau for the VMS port.
1359
1360 Thanks to Nat Lanza for the Kerberos support.
1361
1362 Thanks to Bill Nottingham for the initial PAM support.
1363
1364 And thanks to Jon A. Christopher for implementing the Athena dialog
1365 support, back in the days before Lesstif or Gtk were viable alternatives
1366 to Motif.