From http://www.jwz.org/xscreensaver/xscreensaver-5.34.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 "09-Nov-2013 (5.23)" "X Version 11"
15 .SH NAME
16 xscreensaver - extensible screen saver and screen locking framework
17 .SH SYNOPSIS
18 .B xscreensaver
19 [\-display \fIhost:display.screen\fP] \
20 [\-verbose] \
21 [\-no\-splash] \
22 [\-no\-capture\-stderr] \
23 [\-log \fIfilename\fP]
24 .SH DESCRIPTION
25 The \fIxscreensaver\fP program waits until the keyboard and mouse have been 
26 idle for a period, and then runs a graphics demo chosen at random.  It 
27 turns off as soon as there is any mouse or keyboard activity.
28
29 This program can lock your terminal in order to prevent others from using it,
30 though its default mode of operation is merely to display pretty pictures on
31 your screen when it is not in use.
32
33 It also provides configuration and control of your monitor's power-saving
34 features.
35 .SH GETTING STARTED
36 For the impatient, try this:
37 .EX
38 xscreensaver &
39 xscreensaver-demo
40 .EE
41 The
42 .BR xscreensaver-demo (1)
43 program pops up a dialog box that lets you configure the screen saver,
44 and experiment with the various display modes.
45
46 .B Note that xscreensaver has a client-server model:
47 the \fIxscreensaver\fP program is a daemon that runs in the background;
48 it is controlled by the foreground
49 .BR xscreensaver-demo (1)
50 and
51 .BR xscreensaver-command (1)
52 programs.
53 .SH CONFIGURATION
54 The easiest way to configure \fIxscreensaver\fP is to simply run the
55 .BR xscreensaver-demo (1)
56 program, and change the settings through the GUI.  The rest of this
57 manual page describes lower level ways of changing settings.
58
59 I'll repeat that because it's important:
60
61 .RS 4
62 The easy way to configure xscreensaver is to run the 
63 .BR xscreensaver-demo (1)
64 program.  You shouldn't need to know any of the stuff described 
65 in \fIthis\fP manual unless you are trying to do something tricky,
66 like customize xscreensaver for site-wide use or something.
67 .RE
68
69 Options to \fIxscreensaver\fP are stored in one of two places: in 
70 a \fI.xscreensaver\fP file in your home directory; or in the X resource
71 database.  If the \fI.xscreensaver\fP file exists, it overrides any settings
72 in the resource database.  
73
74 The syntax of the \fI.xscreensaver\fP file is similar to that of
75 the \fI.Xdefaults\fP file; for example, to set the \fItimeout\fP parameter
76 in the \fI.xscreensaver\fP file, you would write the following:
77 .EX
78 timeout: 5
79 .EE
80 whereas, in the \fI.Xdefaults\fP file, you would write
81 .EX
82 xscreensaver.timeout: 5
83 .EE
84 If you change a setting in the \fI.xscreensaver\fP file while xscreensaver
85 is already running, it will notice this, and reload the file.  (The file will
86 be reloaded the next time the screen saver needs to take some action, such as
87 blanking or unblanking the screen, or picking a new graphics mode.)
88
89 If you change a setting in your X resource database, or if you want
90 xscreensaver to notice your changes immediately instead of the next time
91 it wakes up, then you will need to reload your \fI.Xdefaults\fP file,
92 and then tell the running xscreensaver process to restart itself, like so:
93 .EX
94 xrdb < ~/.Xdefaults
95 xscreensaver-command -restart
96 .EE
97 If you want to set the system-wide defaults, then make your edits to
98 the xscreensaver app-defaults file, which should have been installed
99 when xscreensaver itself was installed.  The app-defaults file will
100 usually be named /usr/lib/X11/app-defaults/XScreenSaver, but different
101 systems might keep it in a different place (for example,
102 /usr/openwin/lib/app-defaults/XScreenSaver on Solaris.)
103
104 When settings are changed in the Preferences dialog box (see above)
105 the current settings will be written to the \fI.xscreensaver\fP file.
106 (The \fI.Xdefaults\fP file and the app-defaults file will never be
107 written by xscreensaver itself.)
108 .SH COMMAND-LINE OPTIONS
109 .I xscreensaver
110 also accepts a few command-line options, mostly for use when debugging:
111 for normal operation, you should configure things via the \fI~/.xscreensaver\fP
112 file.
113 .TP 8
114 .B \-display \fIhost:display.screen\fP
115 The X display to use.  For displays with multiple screens, XScreenSaver
116 will manage all screens on the display simultaniously.
117 .TP 8
118 .B \-verbose
119 Same as setting the \fIverbose\fP resource to \fItrue\fP: print diagnostics
120 on stderr and on the xscreensaver window.
121 .TP 8
122 .B \-no-capture-stderr
123 Do not redirect the stdout and stderr streams to the xscreensaver window
124 itself.  If xscreensaver is crashing, you might need to do this in order
125 to see the error message.
126 .TP 8
127 .B \-log \fIfilename\fP
128 This is exactly the same as redirecting stdout and stderr to the given
129 file (for append).  This is useful when reporting bugs.
130 .SH HOW IT WORKS
131 When it is time to activate the screensaver, a full-screen black window is
132 created on each screen of the display.  Each window is created in such a way
133 that, to any subsequently-created programs, it will appear to be a "virtual
134 root" window.  Because of this, any program which draws on the root 
135 window (and which understands virtual roots) can be used as a screensaver.
136 The various graphics demos are, in fact, just standalone programs that
137 know how to draw on the provided window.
138
139 When the user becomes active again, the screensaver windows are unmapped, and
140 the running subprocesses are killed by sending them \fBSIGTERM\fP.  This is 
141 also how the subprocesses are killed when the screensaver decides that it's
142 time to run a different demo: the old one is killed and a new one is launched.
143
144 You can control a running screensaver process by using the
145 .BR xscreensaver\-command (1)
146 program (which see.)
147 .SH POWER MANAGEMENT
148 Modern X servers contain support to power down the monitor after an idle
149 period.  If the monitor has powered down, then \fIxscreensaver\fP will
150 notice this (after a few minutes), and will not waste CPU by drawing 
151 graphics demos on a black screen.  An attempt will also be made to
152 explicitly power the monitor back up as soon as user activity is detected.
153
154 The \fI~/.xscreensaver\fP file controls the configuration of your
155 display's power management settings: if you have used
156 .BR xset (1)
157 to change your power management settings, then xscreensaver will
158 override those changes with the values specified 
159 in \fI~/.xscreensaver\fP (or with its built-in defaults, if there
160 is no \fI~/.xscreensaver\fP file yet.)
161
162 To change your power management settings, run
163 .BR xscreensaver\-demo (1)
164 and change the various timeouts through the user interface.
165 Alternately, you can edit the \fI~/.xscreensaver\fP file directly.
166
167 If the power management section is grayed out in the
168 .BR xscreensaver\-demo (1)
169 window,  then that means that your X server does not support
170 the XDPMS extension, and so control over the monitor's power state
171 is not available.
172
173 If you're using a laptop, don't be surprised if changing the DPMS
174 settings has no effect: many laptops have monitor power-saving behavior
175 built in at a very low level that is invisible to Unix and X.  On such
176 systems, you can typically adjust the power-saving delays only by
177 changing settings in the BIOS in some hardware-specific way.
178
179 If DPMS seems not to be working with XFree86, make sure the "DPMS"
180 option is set in your \fI/etc/X11/XF86Config\fP file.  See the
181 .BR XF86Config (5)
182 manual for details.
183 .SH USING GNOME OR UNITY
184 For the better part of a decade, GNOME shipped xscreensaver as-is,
185 and everything just worked out of the box.  In 2005, however, they
186 decided to re-invent the wheel and ship their own replacement for
187 the \fIxscreensaver\fP daemon called "\fIgnome-screensaver\fP",
188 rather than improving xscreensaver and contributing their changes
189 back.  As a result, the "\fIgnome-screensaver\fP" program is insecure,
190 bug-ridden, and missing many features of xscreensaver.  You shouldn't
191 use it.
192
193 To replace gnome-screensaver with xscreensaver:
194 .RS 4
195 .TP 3
196 \fB1: Fully uninstall the gnome-screensaver package.\fP
197 .EX
198 sudo apt-get remove gnome-screensaver
199 .EE
200 .TP 3
201 \fB2: Launch xscreensaver at login.\fP
202 Select "\fIStartup Applications\fP" from the menu (or manually
203 launch "\fIgnome-session-properties\fP") and add "\fIxscreensaver\fP".
204 .TP 3
205 \fB3: Make GNOME's "Lock Screen" use xscreensaver.\fP
206 .EX
207 sudo ln -sf /usr/bin/xscreensaver-command \\
208             /usr/bin/gnome-screensaver-command
209 .EE
210 That doesn't work under Unity, though.  Apparently it has its own
211 built-in screen locker which is not gnome-screensaver, and cannot be
212 removed, and yet still manages to be bug-addled and insecure. 
213 Keep reinventing that wheel, guys!  (If you have figured out how to
214 replace Unity's locking "feature" with xscreensaver, let me know.)
215 .TP 3
216 \fB4: Turn off Unity's built-in blanking.\fP
217 Open "\fISystem Settings / Brightness & Lock\fP";
218 .br
219 Un-check "\fIStart Automatically\fP";
220 .br
221 Set \fI"Turn screen off when inactive for"\fP to \fI"Never."\fP
222 .SH USING KDE
223 Like GNOME, KDE also decided to invent their own screen saver framework
224 from scratch instead of simply using xscreensaver.  To replace the KDE
225 screen saver with xscreensaver, do the following:
226 .RS 4
227 .TP 3
228 \fB1: Turn off KDE's screen saver.\fP
229 Open the "\fIControl Center\fP" and
230 select the "\fIAppearance & Themes / Screensaver\fP" page.
231 Un-check "\fIStart Automatically\fP".
232 .TP 3
233 \fB2: Find your Autostart directory.\fP
234 Open the "\fISystem Administration / Paths\fP" page,
235 and see what your "Autostart path" is set to: it will
236 probably be \fI~/.kde/Autostart/\fP or something similar.
237 .TP 3
238 \fB3: Make xscreensaver be an Autostart program.\fP
239 Create a .desktop file in your autostart directory 
240 called \fIxscreensaver.desktop\fP that contains the following five lines:
241 .EX
242
243 [Desktop Entry]
244 Exec=xscreensaver
245 Name=XScreenSaver
246 Type=Application
247 X-KDE-StartupNotify=false
248 .EE
249 .TP 3
250 \fB4: Make the various "lock session" buttons call xscreensaver.\fP
251 The file you want to replace next has moved around over the years. It
252 might be called \fI/usr/libexec/kde4/kscreenlocker\fP,
253 or it might be called "\fIkdesktop_lock\fP" or "\fIkrunner_lock\fP"
254 or "\fIkscreenlocker_greet\fP", and
255 it might be in \fI/usr/lib/kde4/libexec/\fP
256 or in \fI/usr/kde/3.5/bin/\fP or even in \fI/usr/bin/\fP,
257 depending on the distro and phase of the moon.  Replace the contents
258 of that file with these two lines:
259 .EX
260
261 #!/bin/sh
262 xscreensaver-command -lock
263
264 .EE
265 Make sure the file is executable (chmod a+x).
266 .RE
267 .PP
268 Now use xscreensaver normally, controlling it via the usual
269 .BR xscreensaver-demo (1)
270 and
271 .BR xscreensaver-command (1)
272 mechanisms.
273 .SH USING SYSTEMD
274 If the above didn't do it, and your system has
275 .BR systemd (1),
276 then give this a try:
277
278 .TP 3
279 \fB1: Create a service.\fP
280 Create the file \fI~/.config/systemd/user/xscreensaver.service\fP
281 containing:
282 .EX
283 [Unit]
284 Description=XScreenSaver
285 [Service]
286 ExecStart=xscreensaver
287 [Install]
288 WantedBy=default.target
289 .EE
290 \fB2. Enable it.\fP
291 .EX
292 systemctl --user enable xscreensaver
293 .EE
294 Then restart X11.
295 .SH USING UPSTART
296 Still not working, but on your distro, that newfangled
297 .BR systemd (1)
298 nonsense has already fallen out of favor?  Then maybe this will work:
299 launch the \fIStartup Applications\fP applet, click \fI"Add"\fP, and
300 enter these lines, then restart X11:
301 .EX
302 Name: XScreenSaver
303 Command: xscreensaver
304 Comment: xscreensaver
305 .EE
306 .SH USING GDM
307 You can run \fIxscreensaver\fP from your 
308 .BR gdm (1)
309 session, so that the screensaver will run even when nobody is logged 
310 in on the console.  To do this, run
311 .BR gdmconfig (1)
312 and on the \fIBackground\fP page, type the 
313 command \fB"xscreensaver -nosplash"\fP into the \fIBackground Program\fP
314 field.  That will cause gdm to run xscreensaver while nobody is logged
315 in, and kill it as soon as someone does log in.  (The user will then
316 be responsible for starting xscreensaver on their own, if they want.)
317
318 Another way to accomplish the same thing is to edit the
319 file \fI/etc/X11/gdm/gdm.conf\fP to include:
320 .EX
321 BackgroundProgram=xscreensaver -nosplash
322 RunBackgroundProgramAlways=true
323 .EE
324 In this situation, the \fIxscreensaver\fP process will probably be running
325 as user \fIgdm\fP instead of \fIroot\fP.  You can configure the settings
326 for this nobody-logged-in state (timeouts, DPMS, etc.) by editing
327 the \fI~gdm/.xscreensaver\fP file.
328
329 To get gdm to run the BackgroundProgram, you may need to switch it from
330 the "Graphical Greeter" to the "Standard Greeter".
331
332 It is safe to run \fIxscreensaver\fP as root (as \fIxdm\fP or \fIgdm\fP may do.)
333 If run as root, \fIxscreensaver\fP changes its effective user and group ids 
334 to something safe (like \fI"nobody"\fP) before connecting to the X server
335 or launching user-specified programs.
336
337 An unfortunate side effect of this (important) security precaution is that
338 it may conflict with cookie-based authentication.
339
340 If you get "connection refused" errors when running \fIxscreensaver\fP
341 from \fIgdm\fP, then this probably means that you have
342 .BR xauth (1)
343 or some other security mechanism turned on.  For information on the
344 X server's access control mechanisms, see the man pages for
345 .BR X (1),
346 .BR Xsecurity (1),
347 .BR xauth (1),
348 and
349 .BR xhost (1).
350 .SH BUGS
351 Bugs?  There are no bugs.  Ok, well, maybe.  If you find one, please let
352 me know.  http://www.jwz.org/xscreensaver/bugs.html explains how to
353 construct the most useful bug reports.
354 .PP
355 .TP 4
356 .B Locking and root logins
357 In order for it to be safe for xscreensaver to be launched by \fIxdm\fP,
358 certain precautions had to be taken, among them that xscreensaver never
359 runs as \fIroot\fP.  In particular, if it is launched as root (as \fIxdm\fP
360 is likely to do), xscreensaver will disavow its privileges, and switch 
361 itself to a safe user id (such as \fInobody\fP.)
362
363 An implication of this is that if you log in as \fIroot\fP on the console, 
364 xscreensaver will refuse to lock the screen (because it can't tell
365 the difference between \fIroot\fP being logged in on the console, and a
366 normal user being logged in on the console but xscreensaver having been 
367 launched by the
368 .BR xdm (1)
369 .I Xsetup
370 file.)
371
372 The solution to this is simple: you shouldn't be logging in on the console
373 as \fIroot\fP in the first place!  (What, are you crazy or something?)  
374
375 Proper Unix hygiene dictates that you should log in as yourself, and
376 .BR su (1)
377 to \fIroot\fP as necessary.  People who spend their day logged in
378 as \fIroot\fP are just begging for disaster.
379 .TP 4
380 .B XAUTH and XDM
381 For xscreensaver to work when launched by
382 .BR xdm (1)
383 or
384 .BR gdm (1),
385 programs running on the local machine as user \fI"nobody"\fP must be
386 able to connect to the X server.  This means that if you want to run
387 xscreensaver on the console while nobody is logged in, you may need
388 to disable cookie-based access control (and allow all users who can log
389 in to the local machine to connect to the display.)  
390
391 You should be sure that this is an acceptable thing to do in your
392 environment before doing it.  See the "\fIUsing GDM\fP" section, 
393 above, for more details.
394 .TP 4
395 .B Passwords
396 If you get an error message at startup like "couldn't get password
397 of \fIuser\fP" then this probably means that you're on a system in which 
398 the
399 .BR getpwent (3)
400 library routine can only be effectively used by root.  If this is the case, 
401 then \fIxscreensaver\fP must be installed as setuid to root in order for
402 locking to work.  Care has been taken to make this a safe thing to do.  
403
404 It also may mean that your system uses shadow passwords instead of the standard
405 .BR getpwent (3)
406 interface; in that case, you may need to change some options 
407 with \fIconfigure\fP and recompile.
408
409 If you change your password after xscreensaver has been launched, it will
410 continue using your old password to unlock the screen until xscreensaver
411 is restarted.  On some systems, it may accept \fIboth\fP your old and new
412 passwords.  So, after you change your password, you'll have to do
413 .EX
414 xscreensaver-command -restart
415 .EE
416 to make \fIxscreensaver\fP notice.
417 .TP 4
418 .B PAM Passwords
419 If your system uses PAM (Pluggable Authentication Modules), then in order
420 for xscreensaver to use PAM properly, PAM must be told about xscreensaver.
421 The xscreensaver installation process should update the PAM data (on Linux,
422 by creating the file \fI/etc/pam.d/xscreensaver\fP for you, and on Solaris, 
423 by telling you what lines to add to the \fI/etc/pam.conf\fP file.)  
424
425 If the PAM configuration files do not know about xscreensaver, then 
426 you \fImight\fP be in a situation where xscreensaver will refuse to ever
427 unlock the screen.
428
429 This is a design flaw in PAM (there is no way for a client to tell the
430 difference between PAM responding "I have never heard of your module",
431 and responding, "you typed the wrong password".)  As far as I can tell,
432 there is no way for xscreensaver to automatically work around this, or
433 detect the problem in advance, so if you have PAM, make sure it is
434 configured correctly!
435 .TP 4
436 .B Machine Load
437 Although this program "nices" the subprocesses that it starts, 
438 graphics-intensive subprograms can still overload the machine by causing
439 the X server process itself (which is not "niced") to consume many
440 cycles.  Care has been taken in all the modules shipped with xscreensaver
441 to sleep periodically, and not run full tilt, so as not to cause
442 appreciable load.
443
444 However, if you are running the OpenGL-based screen savers on a machine
445 that does not have a video card with 3D acceleration, they \fIwill\fP
446 make your machine slow, despite
447 .BR nice (1).
448
449 Your options are: don't use the OpenGL display modes; or, collect the
450 spare change hidden under the cushions of your couch, and use it to
451 buy a video card manufactured after 1998.  (It doesn't even need to be
452 \fIfast\fP 3D hardware: the problem will be fixed if there is any
453 3D hardware \fIat all.\fP)
454 .TP 4
455 .B XFree86's Magic Keystrokes
456 The XFree86 X server traps certain magic keystrokes before client programs ever
457 see them.  Two that are of note are Ctrl+Alt+Backspace, which causes 
458 the X server to exit; and Ctrl+Alt+F\fIn\fP, which switches virtual consoles.
459 The X server will respond to these keystrokes even if xscreensaver has the
460 screen locked.  Depending on your setup, you might consider this a problem.
461
462 Unfortunately, there is no way for xscreensaver itself to override the
463 interpretation of these keys.  If you want to disable Ctrl+Alt+Backspace
464 globally, you need to set the \fIDontZap\fP flag in 
465 your \fI/etc/X11/XF86Config\fP file.  To globally disable VT switching,
466 you can set the \fIDontVTSwitch\fP flag.  See the
467 .BR XF86Config (5)
468 manual for details.
469 .SH X RESOURCES
470 These are the X resources use by the \fIxscreensaver\fP program.
471 You probably won't need to change these manually (that's what the
472 .BR xscreensaver\-demo (1)
473 program is for).
474 .TP 8
475 .B timeout\fP (class \fBTime\fP)
476 The screensaver will activate (blank the screen) after the keyboard and
477 mouse have been idle for this many minutes.  Default 10 minutes.
478 .TP 8
479 .B cycle\fP (class \fBTime\fP)
480 After the screensaver has been running for this many minutes, the currently
481 running graphics-hack sub-process will be killed (with \fBSIGTERM\fP), and a
482 new one started.  If this is 0, then the graphics hack will never be changed:
483 only one demo will run until the screensaver is deactivated by user activity.
484 Default 10 minutes.
485
486 The running saver will be restarted every \fIcycle\fP minutes even when
487 \fImode\fP is \fIone\fP, since some savers tend to converge on a steady
488 state.
489 .TP 8
490 .B lock\fP (class \fBBoolean\fP)
491 Enable locking: before the screensaver will turn off, it will require you 
492 to type the password of the logged-in user (really, the person who ran
493 xscreensaver), or the root password.  (\fBNote:\fP this doesn't work if the
494 screensaver is launched by
495 .BR xdm (1)
496 because it can't know the user-id of the logged-in user.  See 
497 the "\fIUsing XDM(1)\fP" section, below.
498 .TP 8
499 .B lockTimeout\fP (class \fBTime\fP)
500 If locking is enabled, this controls the length of the "grace period"
501 between when the screensaver activates, and when the screen becomes locked.
502 For example, if this is 5, and \fI\-timeout\fP is 10, then after 10 minutes,
503 the screen would blank.  If there was user activity at 12 minutes, no password
504 would be required to un-blank the screen.  But, if there was user activity
505 at 15 minutes or later (that is, \fI\-lock\-timeout\fP minutes after 
506 activation) then a password would be required.  The default is 0, meaning
507 that if locking is enabled, then a password will be required as soon as the 
508 screen blanks.
509 .TP 8
510 .B passwdTimeout\fP (class \fBTime\fP)
511 If the screen is locked, then this is how many seconds the password dialog box
512 should be left on the screen before giving up (default 30 seconds.)  This
513 should not be too large: the X server is grabbed for the duration that the
514 password dialog box is up (for security purposes) and leaving the server 
515 grabbed for too long can cause problems.
516 .TP 8
517 .B dpmsEnabled\fP (class \fBBoolean\fP)
518 Whether power management is enabled.
519 .TP 8
520 .B dpmsStandby\fP (class \fBTime\fP)
521 If power management is enabled, how long until the monitor goes solid black.
522 .TP 8
523 .B dpmsSuspend\fP (class \fBTime\fP)
524 If power management is enabled, how long until the monitor goes into
525 power-saving mode.
526 .TP 8
527 .B dpmsOff\fP (class \fBTime\fP)
528 If power management is enabled, how long until the monitor powers down
529 completely.  Note that these settings will have no effect unless both
530 the X server and the display hardware support power management; not 
531 all do.  See the \fIPower Management\fP section, below, for more 
532 information.
533 .TP 8
534 .B dpmsQuickOff\fP (class \fBBoolean\fP)
535 If \fImode\fP is \fIblank\fP and this is true, then the screen will be
536 powered down immediately upon blanking, regardless of other
537 power-management settings.
538 .TP 8
539 .B visualID\fP (class \fBVisualID\fP)
540 Specify which X visual to use by default.  (Note carefully that this resource
541 is called \fBvisualID\fP, not merely \fBvisual\fP; if you set the \fBvisual\fP
542 resource instead, things will malfunction in obscure ways for obscure reasons.)
543
544 Legal values for the \fBVisualID\fP resource are:
545 .RS 8
546 .TP 8
547 .B default
548 Use the screen's default visual (the visual of the root window.)  
549 This is the default.
550 .TP 8
551 .B best
552 Use the visual which supports the most colors.  Note, however, that the
553 visual with the most colors might be a TrueColor visual, which does not
554 support colormap animation.  Some programs have more interesting behavior
555 when run on PseudoColor visuals than on TrueColor.
556 .TP 8
557 .B mono
558 Use a monochrome visual, if there is one.
559 .TP 8
560 .B gray
561 Use a grayscale or staticgray visual, if there is one and it has more than
562 one plane (that is, it's not monochrome.)
563 .TP 8
564 .B color
565 Use the best of the color visuals, if there are any.
566 .TP 8
567 .B GL
568 Use the visual that is best for OpenGL programs.  (OpenGL programs have
569 somewhat different requirements than other X programs.)
570 .TP 8
571 .I class
572 where \fIclass\fP is one of \fBStaticGray\fP, \fBStaticColor\fP, 
573 \fBTrueColor\fP, \fBGrayScale\fP, \fBPseudoColor\fP, or \fBDirectColor\fP.
574 Selects the deepest visual of the given class.
575 .TP 8
576 .I number
577 where \fInumber\fP (decimal or hex) is interpreted as a visual id number, 
578 as reported by the
579 .BR xdpyinfo (1)
580 program; in this way you can have finer control over exactly which visual
581 gets used, for example, to select a shallower one than would otherwise
582 have been chosen.
583
584 .RE
585 .RS 8
586 Note that this option specifies only the \fIdefault\fP visual that will
587 be used: the visual used may be overridden on a program-by-program basis.
588 See the description of the \fBprograms\fP resource, below.
589 .RE
590 .TP 8
591 .B installColormap\fP (class \fBBoolean\fP)
592 On PseudoColor (8-bit) displays, install a private colormap while the
593 screensaver is active, so that the graphics hacks can get as many
594 colors as possible.  This is the default.  (This only applies when the
595 screen's default visual is being used, since non-default visuals get
596 their own colormaps automatically.)  This can also be overridden on a
597 per-hack basis: see the discussion of the \fBdefault\-n\fP name in the
598 section about the \fBprograms\fP resource.
599
600 This does nothing if you have a TrueColor (16-bit or deeper) display.
601 .TP 8
602 .B verbose\fP (class \fBBoolean\fP)
603 Whether to print diagnostics.  Default false.
604 .TP 8
605 .B timestamp\fP (class \fBBoolean\fP)
606 Whether to print the time of day along with any other diagnostic messages.
607 Default true.
608 .TP 8
609 .B splash\fP (class \fBBoolean\fP)
610 Whether to display a splash screen at startup.  Default true.
611 .TP 8
612 .B splashDuration\fP (class \fBTime\fP)
613 How long the splash screen should remain visible; default 5 seconds.
614 .TP 8
615 .B helpURL\fP (class \fBURL\fP)
616 The splash screen has a \fIHelp\fP button on it.  When you press it, it will
617 display the web page indicated here in your web browser.
618 .TP 8
619 .B loadURL\fP (class \fBLoadURL\fP)
620 This is the shell command used to load a URL into your web browser.
621 The default setting will load it into Mozilla/Netscape if it is already
622 running, otherwise, will launch a new browser looking at the \fIhelpURL\fP.
623 .TP 8
624 .B demoCommand\fP (class \fBDemoCommand\fP)
625 This is the shell command run when the \fIDemo\fP button on the splash window
626 is pressed.  It defaults to
627 .BR xscreensaver\-demo (1).
628 .TP 8
629 .B prefsCommand\fP (class \fBPrefsCommand\fP)
630 This is the shell command run when the \fIPrefs\fP button on the splash window
631 is pressed.  It defaults to \fIxscreensaver\-demo\ \-prefs\fP.
632 .TP 8
633 .B newLoginCommand\fP (class \fBNewLoginCommand\fP)
634 If set, this is the shell command that is run when the "New Login" button
635 is pressed on the unlock dialog box, in order to create a new desktop
636 session without logging out the user who has locked the screen.
637 Typically this will be some variant of
638 .BR gdmflexiserver (1)
639 or
640 .BR kdmctl (1).
641 .TP 8
642 .B nice\fP (class \fBNice\fP)
643 The sub-processes created by \fIxscreensaver\fP will be "niced" to this
644 level, so that they are given lower priority than other processes on the
645 system, and don't increase the load unnecessarily.  The default is 10.  
646 (Higher numbers mean lower priority; see 
647 .BR nice (1)
648 for details.)
649 .TP 8
650 .B fade\fP (class \fBBoolean\fP)
651 If this is true, then when the screensaver activates, the current contents
652 of the screen will fade to black instead of simply winking out.  This only
653 works on certain systems.  A fade will also be done when switching graphics
654 hacks (when the \fIcycle\fP timer expires.)  Default: true.  
655 .TP 8
656 .B unfade\fP (class \fBBoolean\fP)
657 If this is true, then when the screensaver deactivates, the original contents
658 of the screen will fade in from black instead of appearing immediately.  This
659 only works on certain systems, and if \fIfade\fP is true as well.
660 Default false.
661 .TP 8
662 .B fadeSeconds\fP (class \fBTime\fP)
663 If \fIfade\fP is true, this is how long the fade will be in 
664 seconds (default 3 seconds.)
665 .TP 8
666 .B fadeTicks\fP (class \fBInteger\fP)
667 If \fIfade\fP is true, this is how many times a second the colormap will
668 be changed to effect a fade.  Higher numbers yield smoother fades, but
669 may make the fades take longer than the specified \fIfadeSeconds\fP if
670 your server isn't fast enough to keep up.  Default 20.
671 .TP 8
672 .B captureStderr\fP (class \fBBoolean\fP)
673 Whether \fIxscreensaver\fP should redirect its stdout and stderr streams to
674 the window itself.  Since its nature is to take over the screen, you would not
675 normally see error messages generated by xscreensaver or the sub-programs it
676 runs; this resource will cause the output of all relevant programs to be
677 drawn on the screensaver window itself, as well as being written to the
678 controlling terminal of the screensaver driver process.  Default true.
679 .TP 8
680 .B ignoreUninstalledPrograms\fP (class \fBBoolean\fP)
681 There may be programs in the list that are not installed on the system,
682 yet are marked as "enabled."  If this preference is true, then such 
683 programs will simply be ignored.  If false, then a warning will be printed
684 if an attempt is made to run the nonexistent program.  Also, the
685 .BR xscreensaver-demo (1)
686 program will suppress the non-existent programs from the list if this
687 is true.  Default: false.
688 .TP 8
689 .B authWarningSlack\fP (class \fBInteger\fP)
690 If \fIall\fP failed unlock attempts (incorrect password entered) were
691 made within this period of time, the usual dialog that warns about such
692 attempts after a successful login will be suppressed. The assumption
693 is that incorrect passwords entered within a few seconds of a correct
694 one are user error, rather than hostile action.  Default 20 seconds.
695 .TP 8
696 .B GetViewPortIsFullOfLies\fP (class \fBBoolean\fP)
697 Set this to true if the xscreensaver window doesn't cover the whole screen.
698 This works around a longstanding XFree86 bug #421.  See the 
699 xscreensaver FAQ for details.
700 .TP 8
701 .B font\fP (class \fBFont\fP)
702 The font used for the stdout/stderr text, if \fBcaptureStderr\fP is true.
703 Default \fB*\-medium\-r\-*\-140\-*\-m\-*\fP (a 14 point fixed-width font.)
704 .TP 8
705 .B mode\fP (class \fBMode\fP)
706 Controls the behavior of xscreensaver.  Legal values are:
707 .RS 8
708 .TP 8
709 .B random
710 When blanking the screen, select a random display mode from among those
711 that are enabled and applicable.  This is the default.
712 .TP 8
713 .B random-same
714 Like \fIrandom\fP, but if there are multiple screens, each screen
715 will run the \fIsame\fP random display mode, instead of each screen
716 running a different one.
717 .TP 8
718 .B one
719 When blanking the screen, only ever use one particular display mode (the
720 one indicated by the \fIselected\fP setting.)
721 .TP 8
722 .B blank
723 When blanking the screen, just go black: don't run any graphics hacks.
724 .TP 8
725 .B off
726 Don't ever blank the screen, and don't ever allow the monitor to power down.
727
728 .RE
729 .TP 8
730 .B selected\fP (class \fBInteger\fP)
731 When \fImode\fP is set to \fIone\fP, this is the one, indicated by its
732 index in the \fIprograms\fP list.  You're crazy if you count them and
733 set this number by hand: let
734 .BR xscreensaver\-demo (1)
735 do it for you!
736 .TP 8
737 .B programs\fP (class \fBPrograms\fP)
738 The graphics hacks which \fIxscreensaver\fP runs when the user is idle.
739 The value of this resource is a multi-line string, one \fIsh\fP-syntax
740 command per line.  Each line must contain exactly one command: no
741 semicolons, no ampersands.
742
743 When the screensaver starts up, one of these is selected (according to
744 the \fBmode\fP setting), and run.  After the \fIcycle\fP period
745 expires, it is killed, and another is selected and run.
746
747 If a line begins with a dash (-) then that particular program is
748 disabled: it won't be selected at random (though you can still select
749 it explicitly using the
750 .BR xscreensaver\-demo (1)
751 program.)
752
753 If all programs are disabled, then the screen will just be made blank,
754 as when \fImode\fP is set to \fIblank\fP.
755
756 To disable a program, you must mark it as disabled with a dash instead
757 of removing it from the list.  This is because the system-wide (app-defaults)
758 and per-user (.xscreensaver) settings are merged together, and if a user
759 just \fIdeletes\fP an entry from their programs list, but that entry still
760 exists in the system-wide list, then it will come back.  However, if the
761 user \fIdisables\fP it, then their setting takes precedence.
762
763 If the display has multiple screens, then a different program will be run
764 for each screen.  (All screens are blanked and unblanked simultaneously.)
765
766 Note that you must escape the newlines; here is an example of how you
767 might set this in your \fI~/.xscreensaver\fP file:
768
769 .RS 8
770 .EX
771 programs:  \\
772        qix -root                          \\n\\
773        ico -r -faces -sleep 1 -obj ico    \\n\\
774        xdaliclock -builtin2 -root         \\n\\
775        xv -root -rmode 5 image.gif -quit  \\n
776 .EE
777 .RE
778 .RS 8
779 Make sure your \fB$PATH\fP environment variable is set up correctly
780 \fIbefore\fP xscreensaver is launched, or it won't be able to find the
781 programs listed in the \fIprograms\fP resource.
782
783 To use a program as a screensaver, two things are required: that that
784 program draw on the root window (or be able to be configured to draw on
785 the root window); and that that program understand "virtual root"
786 windows, as used by virtual window managers such as
787 .BR tvtwm (1).
788 (Generally, this is accomplished by just including the \fI"vroot.h"\fP 
789 header file in the program's source.)
790
791 .B Visuals:
792
793 Because xscreensaver was created back when dinosaurs roamed the earth,
794 it still contains support for some things you've probably never seen,
795 such as 1-bit monochrome monitors, grayscale monitors, and monitors
796 capable of displaying only 8-bit colormapped images.
797
798 If there are some programs that you want to run only when using a color
799 display, and others that you want to run only when using a monochrome
800 display, you can specify that like this:
801 .EX
802        mono:   mono-program  -root        \\n\\
803        color:  color-program -root        \\n\\
804 .EE
805 .RE
806 .RS 8
807 More generally, you can specify the kind of visual that should be used for
808 the window on which the program will be drawing.  For example, if one 
809 program works best if it has a colormap, but another works best if it has
810 a 24-bit visual, both can be accommodated:
811 .EX
812        PseudoColor: cmap-program  -root   \\n\\
813        TrueColor:   24bit-program -root   \\n\\
814 .EE
815 .RE
816 .RS 8
817 In addition to the symbolic visual names described above (in the discussion
818 of the \fIvisualID\fP resource) one other visual name is supported in
819 the \fIprograms\fP list:
820 .RS 1
821 .TP 4
822 .B default-n
823 This is like \fBdefault\fP, but also requests the use of the default colormap,
824 instead of a private colormap.  (That is, it behaves as if 
825 the \fI\-no\-install\fP command-line option was specified, but only for
826 this particular hack.)  This is provided because some third-party programs
827 that draw on the root window (notably: 
828 .BR xv (1),
829 and
830 .BR xearth (1))
831 make assumptions about the visual and colormap of the root window: 
832 assumptions which xscreensaver can violate.
833
834 .RE
835 If you specify a particular visual for a program, and that visual does not
836 exist on the screen, then that program will not be chosen to run.  This
837 means that on displays with multiple screens of different depths, you can
838 arrange for appropriate hacks to be run on each.  For example, if one screen
839 is color and the other is monochrome, hacks that look good in mono can be 
840 run on one, and hacks that only look good in color will show up on the other.
841 .RE
842 .PP
843 .PP
844 You shouldn't ever need to change the following resources:
845 .PP
846 .TP 8
847 .B pointerPollTime\fP (class \fBTime\fP)
848 When server extensions are not in use, this controls how 
849 frequently \fIxscreensaver\fP checks to see if the mouse position or buttons
850 have changed.  Default 5 seconds.
851 .TP 8
852 .B pointerHysteresis\fP (class \fBInteger\fP)
853 If the mouse moves less than this-many pixels in a second, ignore it
854 (do not consider that to be "activity.")  This is so that the screen
855 doesn't un-blank (or fail to blank) just because you bumped the desk.
856 Default: 10 pixels.
857 .TP 8
858 .B windowCreationTimeout\fP (class \fBTime\fP)
859 When server extensions are not in use, this controls the delay between when 
860 windows are created and when \fIxscreensaver\fP selects events on them.
861 Default 30 seconds.
862 .TP 8
863 .B initialDelay\fP (class \fBTime\fP)
864 When server extensions are not in use, \fIxscreensaver\fP will wait this many
865 seconds before selecting events on existing windows, under the assumption that 
866 \fIxscreensaver\fP is started during your login procedure, and the window 
867 state may be in flux.  Default 0.  (This used to default to 30, but that was
868 back in the days when slow machines and X terminals were more common...)
869 .TP 8
870 .B procInterrupts\fP (class \fBBoolean\fP)
871 This resource controls whether the \fB/proc/interrupts\fP file should be
872 consulted to decide whether the user is idle.  This is the default
873 if \fIxscreensaver\fP has been compiled on a system which supports this
874 mechanism (i.e., Linux systems.)  
875
876 The benefit to doing this is that \fIxscreensaver\fP can note that the user
877 is active even when the X console is not the active one: if the user is 
878 typing in another virtual console, xscreensaver will notice that and will
879 fail to activate.  For example, if you're playing Quake in VGA-mode, 
880 xscreensaver won't wake up in the middle of your game and start competing 
881 for CPU.
882
883 The drawback to doing this is that perhaps you \fIreally do\fP want idleness
884 on the X console to cause the X display to lock, even if there is activity
885 on other virtual consoles.  If you want that, then set this option to False.
886 (Or just lock the X console manually.)
887
888 The default value for this resource is True, on systems where it works.
889 .TP 8
890 .B overlayStderr\fP (class \fBBoolean\fP)
891 If \fBcaptureStderr\fP is True, and your server supports "overlay" visuals,
892 then the text will be written into one of the higher layers instead of into
893 the same layer as the running screenhack.  Set this to False to disable 
894 that (though you shouldn't need to.)
895 .TP 8
896 .B overlayTextForeground\fP (class \fBForeground\fP)
897 The foreground color used for the stdout/stderr text, if \fBcaptureStderr\fP
898 is true.  Default: Yellow.
899 .TP 8
900 .B overlayTextBackground\fP (class \fBBackground\fP)
901 The background color used for the stdout/stderr text, if \fBcaptureStderr\fP
902 is true.  Default: Black.
903 .TP 8
904 .B bourneShell\fP (class \fBBourneShell\fP)
905 The pathname of the shell that \fIxscreensaver\fP uses to start subprocesses.
906 This must be whatever your local variant of \fB/bin/sh\fP is: in particular,
907 it must not be \fBcsh\fP.
908 .SH ENVIRONMENT
909 .PP
910 .TP 8
911 .B DISPLAY
912 to get the default host and display number, and to inform the sub-programs
913 of the screen on which to draw.
914 .TP 8
915 .B XSCREENSAVER_WINDOW
916 Passed to sub-programs to indicate the ID of the window on which they
917 should draw.  This is necessary on Xinerama/RANDR systems where
918 multiple physical monitors share a single X11 "Screen".
919 .TP 8
920 .B PATH
921 to find the sub-programs to run.
922 .TP 8
923 .B HOME
924 for the directory in which to read the \fI.xscreensaver\fP file.
925 .TP 8
926 .B XENVIRONMENT
927 to get the name of a resource file that overrides the global resources
928 stored in the RESOURCE_MANAGER property.
929 .SH UPGRADES
930 The latest version of xscreensaver, an online version of this manual,
931 and a FAQ can always be found at http://www.jwz.org/xscreensaver/
932 .SH SEE ALSO
933 .BR X (1),
934 .BR Xsecurity (1),
935 .BR xauth (1),
936 .BR xdm (1),
937 .BR gdm (1),
938 .BR xhost (1),
939 .BR xscreensaver\-demo (1),
940 .BR xscreensaver\-command (1),
941 .BR xscreensaver\-gl\-helper (1),
942 .BR xscreensaver\-getimage (1),
943 .BR xscreensaver\-text (1).
944 .SH COPYRIGHT
945 Copyright \(co 1991-2015 by Jamie Zawinski.
946 Permission to use, copy, modify, distribute, and sell this software
947 and its documentation for any purpose is hereby granted without fee,
948 provided that the above copyright notice appear in all copies and that
949 both that copyright notice and this permission notice appear in
950 supporting documentation.  No representations are made about the
951 suitability of this software for any purpose.  It is provided "as is"
952 without express or implied warranty.
953 .SH AUTHOR
954 Jamie Zawinski <jwz@jwz.org>.  Written in late 1991; version 1.0 posted
955 to comp.sources.x on 17-Aug-1992.
956
957 Please let me know if you find any bugs or make any improvements.
958
959 And a huge thank you to the hundreds of people who have contributed, in
960 large ways and small, to the xscreensaver collection over the past
961 two decades!