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