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