4 a screen saver and locker for the X window system
7 http://www.jwz.org/xscreensaver/
15 The `configure' shell script will attempt to figure out which options are
16 appropriate for your system, and will create config.h and the various
17 Makefiles for you. Run `configure --help' to see how to override these
18 choices, or to specify things like the default installation directory.
19 The file `INSTALL' gives a general overview of use of these sorts of
20 configure scripts (those generated by the GNU autoconf system.)
21 The most important hint is probably this:
23 ./configure --with-motif=/opt/Motif --with-xpm=/usr/local
25 To build on VMS, see README.VMS.
27 If you are upgrading, you might want to delete your ~/.xscreensaver file.
28 If you don't, you might not see the new graphics modes. If you are upgrading
29 from version 2.* to version 3.*, definitely do delete your .xscreensaver file.
31 If you think you've found a bug, please let me know! No bug report is too
32 small. But first, please read the enclosed `README.debugging' file to find
33 out what kind of information would be most helpful to include in your bug
38 You can try out xscreensaver like so:
41 xscreensaver-command -demo
43 After a few seconds, the screen should go black, and a dialog box should
44 appear in the upper right corner. This is "Demo Mode".
46 Note: unlike `xlock', xscreensaver has a client-server model: the
47 `xscreensaver' process is a daemon that runs in the background; it is
48 controlled by the foreground `xscreensaver-command' program.
50 xscreensaver has an extensive manual -- please read it!
54 The xscreensaver daemon waits until the keyboard and mouse have been idle
55 for a period, and then runs a graphics demo chosen at random. The demo is
56 terminated as soon as there is any mouse or keyboard activity (or, in
57 locking mode, when the proper password is typed.)
59 It is trivially easy to add new display modes to xscreensaver: any program
60 which can be invoked in such a way that it draws on the root window of the
61 screen can be used as a screensaver. You just change a resource setting --
62 there's no need to recompile or reinstall anything.
66 Along with the xscreensaver daemon itself, this package also includes
67 numerous graphics hacks for use as screensavers. There is nothing magic
68 about these: they are just programs that draw on the root window.
70 More than 80 such programs are included. For details, see the xscreensaver
71 web page, or the enclosed manual pages. There are also some helpful hints
72 on customization in the xscreensaver app-defaults file (normally installed
73 in /usr/lib/X11/app-defaults/XScreenSaver.)
75 The latest version of xscreensaver is always available on the web at
76 http://www.jwz.org/xscreensaver/.
80 Changes since 3.06: * Configure tweaks (sometimes -lXmu wasn't getting linked
81 in properly; check for _Xsetlocale in -lXintl.)
82 * Portability fixes for sonar.c.
83 * Fixed a compilation problem when you have GL but don't
85 * Made configure notice when MesaGL requires -lpthread.
86 * Made `flame' ignore SIGFPE (not sure if this is the
87 right fix; it seems only to be needed on FreeBSD.)
88 * Kludged `rd-bomb' work on visuals that are of depth 24
89 but that *do not* support pixmaps of depth 32.
90 * Fixed `halo' to work properly in TrueColor.
91 * Changed `xscreensaver.spec' to install the hacks in
92 /usr/X11R6/lib/xscreensaver/ by default, since that's
93 where recent Red Hat distributions put them.
95 * Updated versions of `crystal', `hopalong', and `flow'
97 * Imported `demon' and `loop' modes from xlockmore.
98 Changes since 3.05: * Oops, the "default-n" visual descriptor was broken;
99 it was always installing a colormap if the
100 `installColormap' preference was set, meaning that
101 `xearth', `xv' and friends were using the wrong
102 colors on 8-bit systems.
103 * Turned off HAVE_PING in `sonar', since it compiles
104 on some Linux systems, but not others of similar
106 Changes since 3.04: * Fixed an off-by-1 in `distort'.
107 * Added `sonar' hack.
108 * New version of `glplanet' (with stars.)
109 * Made all hacks exit when you type `q' or `ESC' at them,
110 and made them obey the WM_DELETE_WINDOW ClientMessage.
111 * Fixed a nonfatal buffer overrun in lament (note:
112 lament still doesn't work with MesaGL 3.0: it dies in
113 lambda_textured_triangle1(), which is Mesa's bug, not
115 Changes since 3.03: * Added an `xscreensaver.spec' file, to make it easier
116 for other folks to generate RPMs.
117 * Made the password code work on HPUX in the situation
118 where: ``enhanced security'' is available; but not
119 used; but the user typed a password more than 8
120 characters long anyway. FTSOHPUX.
121 Changes since 3.02: * Made locking work when passwd aging is enabled.
122 * Added support for PAM (Pluggable Authentication
123 Modules.) It is still turned off by default, though,
124 since it doesn't seem to work on Solaris 2.6, and has
125 been behaving erratically on Red Hat 5.1.
126 * Made each possible authentication method be tried in
127 turn until one succeeds; this means that Kerberos is
128 being used, we will first check Kerberos, and if that
129 fails, will then consult the local password file.
131 * Save and restore the bits under the passwd dialog,
132 to avoid leaving a black rectangle behind when
133 unlocking is cancelled.
134 Changes since 3.01: * Not everyone has sys/select.h, sigh...
135 Changes since 3.00: * Some fixes to `reflect'.
137 * Made it log unsuccessful attempts to unlock the screen
139 * Fixed a bug where `xscreensaver-demo' could be seeing
140 a different programs list than `xscreensaver' did.
141 Changes since 2.34: * The xscreensaver daemon no longer links against Motif
142 or Athena: demo-mode and the preferences panel are no
143 longer built in to the daemon, but are now handled by
144 an external program, `xscreensaver-demo'.
145 (I decided that this, along with the recent addition
146 of the `.xscreensaver' config file, justified bumping
147 the version number to 3.00, since this is a fairly
148 major architectural change.)
149 * Lines in the `*programs' resource may now begin with
150 the character "-", meaning "don't run this hack."
151 In this way, it's possible to disable a hack without
152 throwing away the information about it (making it
153 easier to change your mind later.) Eventually the
154 preferences/demo mode GUI should represent this as a
155 checkbox or something.
156 * Fixed a short race condition where it was possible for
157 xscreensaver to die with a BadWindow error if it was
158 blanking the screen just as another window was being
160 * Made it possible to disable specific modes in `bsod'.
161 Changes since 2.33: * Fixed a bug that was making `pipes' generate way too
162 many valves. Made the viewpoint in `pipes' be selected
163 randomly instead of always being -10 degrees.
164 * Fixed a bug in the XSHM code, in the case where the
165 server supports the XSHM extension but is not the same
166 machine as the client.
167 * Made `rd-bomb' default to taking up the whole screen.
168 * Made it not try to do fading/unfading if no PseudoColor
170 * Initial attempt at supporting VT-locking (doesn't work
172 * Eliminated the `captureStdout' resource; now
173 `captureStderr' controls both streams.
174 * Added `-capture-stderr' and `-no-capture-stderr'
175 command-line arguments.
176 * Added `glplanet' hack.
177 * When a hack is selected with `xscreensaver-command
178 -select', that hack will be used until further notice
179 (until the saver turns off, or another activation
181 Changes since 2.32: * Made `xscreensaver-command' print error messages:
182 the xscreensaver daemon now responds to ClientMessage
183 events by writing a response message on a window
184 property, instead of just writing to its stderr.
185 * Made the ~/.xscreensaver file be automatically reloaded
186 when the file date changes.
187 * The password dialog and splash screen no longer depend
188 on Motif or Athena. This should clear up a number of
189 focus problems, and is the first step on the path
190 toward moving all of the Motif/Athena/whatever code
191 out of the xscreensaver daemon, and into external
193 * Don't complain about LessTif 0.86 any more, since the
194 new password dialog makes that problem go away.
195 * Configure tweaks for Irix 6.5, SunOS 5.something.
196 * New `-reflect' option to `distort'.
197 Changes since 2.31: * Added reading and writing of a ~/.xscreensaver file,
198 so that the Preferences panel can save its settings.
199 * New version of `rubik'.
200 * Added `-select N' argument to `xscreensaver-command'.
201 * Oops, left out some of the `bubbles3d' files...
202 Changes since 2.30: * The cursor was invisible in the password dialog. Fixed.
203 * Made configure warn against MesaGL 2.6.
204 * Fixed X error at startup when using non-default visual.
205 * New version of `crystal', `ant', and `atlantis' from
207 * New hack, `bubble3d'.
208 * Added some new modes to `bsod'.
209 Changes since 2.29: * Changed the order in which -lSM and -lICE are linked
210 to be after Motif instead of before (Lesstif on Irix
212 Changes since 2.28: * Work around a bash bug in configure.
213 * Tweaked HPUX paths again. FTSOHPUX.
214 * Made configure recommend against LessTif 0.86, due
215 to a bug in that version that causes a security hole
216 in the screen locking code. LessTif 0.87 will fix it.
217 * Made all of the `--with' options to `configure' accept
218 a directory option as well (so that --with-motif=/FOO
219 will add -I/FOO/include -L/FOO/lib). I believe this is
220 the Configure Party Line of how do to such things.
221 * Fixed a bug where the mouse was left un-grabbed
222 after the first time the graphics hack was changed
223 (simplified all of the mouse-grabbing logic.)
224 * Maybe possibly perhaps made `vidwhacker' really not
225 leave stray xv windows around. This time for sure.
226 * Added a new erase mode (random dots fizzling out.)
227 * Added `-prefs' argument to `xscreensaver-command',
228 that brings up the Preferences dialog directly (it
229 seems that nobody ever noticed the `Preferences' button
230 on the Demo Mode dialog, maybe this will help.)
231 * Added a splash screen. Turn it off with *splash:false.
232 Changes since 2.27: * Better macsbug text in `bsod'.
233 * New version of `distort' with many new modes.
234 * Plugged a leak in `coral'.
235 * Tweaked configure for HPUX.
236 * Removed some compiler warnings.
237 * More consistent usage of stderr versus stdout.
238 * More diagnostics should an X error occur.
239 * Fixed a possible crash in SGI-specific unfading code.
240 Changes since 2.26: * Improved version of `distort'.
241 * Made `lament' compile against OpenGL 1.0 (though it
242 still requires 1.1 to work properly.)
243 * Updated my email address and home page.
244 Changes since 2.24: * Improved motion in `rd-bomb'.
245 * Added XSHM (shared memory extension) support to the
246 `distort', `interference', `moire', `rd-bomb', and
247 `swirl' hacks, which speeds them up a bit.
248 * Added `lament' hack.
249 Changes since 2.23: * Tweaked the order of the -L options again.
250 * Cleaned up configure's `--help' message.
251 * Added `kumppa' hack.
252 * Smarter maze-solving algorithm in `maze'.
253 * Took `xlyap' out of the default list of hacks, since
254 it's just incredibly buggy (and slow.) Maybe someday
255 someone will fix it...
256 * Added `distort' hack, but didn't add it to the default
257 list (yet) because it's still too slow.
258 * Made the Athena demo dialog look more like the Motif
259 version; it has a text-entry field now, too.
260 * Made the Athena password dialog echo asterisks, like
261 Motif does, instead of using a flyspeck font.
262 * Some random configure tweaks.
263 * Added a `timestamp' resource that makes the `-verbose'
264 messages include the time at which they were printed.
265 Changes since 2.22: * The fix for SGI's ``scheme'' nonsense broke things, and
266 let the user's "*background" resource show through.
267 Fixed it in a different way.
268 Changes since 2.21: * Added support for the DPMS server extension (Display
269 Power Management System.)
270 * Made configure advertize the `--enable-subdir' option a
271 little more, since that seemed to cause some people
272 stress. Also, made that directory be built into the
273 xscreensaver executable, as a hardcoded prefix to
274 $PATH. (Might help, shouldn't hurt.)
275 * Made configure prefer the two-arg gettimeofday to the
276 one-arg version, since AIX doesn't have any prototypes.
277 * Made it work with Xaw3d (the 3D Athena library.)
278 * Made `make install' create directories as necessary.
279 * New version of lmorph from Sverre.
280 * Added `crystal' and `discreet' hacks from xlockmore.
281 * Added a new mode to `bsod'.
282 Changes since 2.20: * Made `xscreensaver-command -time' use different words.
283 (It now describes the two states as "screen blanked
284 since..." and "screen non-blanked since..." instead of
285 "active since..." and "inactive since..." which a lot
286 of people interpreted as meaning the opposite of what
288 * Improved some error messages, in the hopes of making
289 the distinction between the xscreensaver and
290 xscreensaver-command programs more obvious.
291 * Rewrote (and reorganized) parts of the xscreensaver and
292 xscreensaver-command manual pages.
293 * Renamed xscreensaver's `-lock' command-line option to
294 be `-lock-mode', to avoid confusion with the `-lock'
295 option to xscreensaver-command, which does a totally
297 * Removed xscreensaver's `-demo' command-line option for
298 a similar reason; use `xscreensaver-command -demo'
300 * Disabled SGI's ``scheme'' nonsense in a better way than
301 fully-qualifying the background colors in every single
303 * Fixed some other minor cosmetic problems when *sgiMode
305 * Fixed an X error in `bsod -root' (how ironic...)
306 Changes since 2.19: * Fixed a bug that caused the mouse to sometimes not be
307 grabbed properly (meaning the window manager menu could
308 pop up over the demo-mode display.)
309 * Fixed a bug that made the stderr output sometimes get
311 * Fixed a bug that made the demo-mode scrollbar move too
313 * Protected against a possible buffer overflow.
314 * Made `vidwhacker' not leave stray xv windows around.
315 * New version of `ant' so that Bagley doesn't calve.
316 * Make configure on AIX get XShm from the right library.
317 Changes since 2.18: * One file was missing from the tar file. Fixed.
318 Changes since 2.17: * Oops, atlantis wasn't being built by default. Fixed.
319 * Added `epicycle' hack.
320 * Added `interference' hack.
321 * Added `truchet' hack.
323 * Added some new modes to `vidwhacker'.
324 Changes since 2.16: * Added a -window-id argument to most hacks, so that they
325 can draw on arbitrary externally-provided windows.
326 * Synched with xlockmore 4.11a01.
328 * Added `atlantis' GL hack.
329 * Renamed `puzzle' hack to `jigsaw', since xlock already
330 had a different mode called `puzzle'.
331 * Made it self-configure properly when Motif 2.1.0 is
332 being used (requires -lXp now, sigh...)
333 Changes since 2.15: * Made `flag' able to do XPM images.
334 * New look for the xscreensaver logo (`xroger').
335 * Fixed compilation error on Suns with adjunct passwords.
336 * Got multi-architecture builds working again.
337 * Some configure tweaks for building on HPUX and Solaris.
338 * Fixed bug in decayscreen.
339 * Fixed typo in passwd.c.
340 * Made `cynosure' not die when colormap is full.
341 Changes since 2.14: * Added `cynosure' hack.
342 * Added `moire2' hack.
343 * Tweaked `erase.c' some more.
344 * Made unfading a bit smoother.
345 * Added `vidwhacker' hack (not installed by default.)
346 * Added `stairs' hack.
347 * Split `escher' into `cage' and `moebius', as per
349 * Changed subprocess handling to use sigaction() instead
350 of signal() if it's available (this is necessary for
351 SCO but should work fine on other systems too.)
352 * Various other tweaks.
353 Changes since 2.13: * Better fix for the Motif drag-and-die lossage.
354 * Put in some kludges to work around a LessTif bug.
355 * XScreenSaver is known to work with LessTif 0.82 now.
356 * Made fading work on high-end SGI video hardware.
357 * Fixed another SGI-specific bug in screen grabbing;
358 will the madness never cease?
359 * Fixed another crash in `xlyap'.
360 Changes since 2.12: * Made `decayscreen' do directions other than down.
362 * Fixed a crash in `xlyap'.
363 * Added CDE info to the man page, removed `cde.txt'.
364 * Configure tweaks for Zippy.
365 * Turned off the signal handling in `bubbles' because
366 it was sometimes failing to die.
367 * Added `hacks/xscreensaver-sgigl.c' to make it possible
368 to run SGI's ElectroPaint hack (/usr/demos/bin/ep)
369 with xscreensaver. Finally!
370 * Fixed a buffer overrun in the locking code that some
371 wily, malicious cracker must have slipped in.
372 * Disabled Motif drag-and-drool in the dialog box
373 buttons, since it's broken in some old versions of
375 Changes since 2.11: * Added `README.debugging'.
376 * Added `puzzle' hack.
377 * Added `xlyap' hack.
378 * Added `default-n' as a visual name, so that one can
379 have -install on by default, but turn it off for
380 certain poorly-behaved hacks (like xv.)
381 * Added support for grabbing frames of external video
382 (on SGI) to the screen-grabbing hacks (decayscreen,
383 slidescreen, slip, blitspin, and puzzle.)
384 * Improved look of tiles in `slidescreen'; fixed its
385 color allocation problem.
386 Changes since 2.10: * Tweaked `blitspin', added it to the default list.
387 * Added `lissie', `mountain', `triangle', `worm',
388 `rotor', and `ant' from xlockmore.
389 * Updated `sierpinski', `galaxy', and `lisa'.
390 * Thickened the lines in `braid' and `lmorph'.
391 * Updated VMS makefiles.
392 * Renamed `fract' to `vines'.
393 * Added `xjack' hack.
394 * Made a few more hacks use erase.c, and added a few
396 * Fixed compilation problem with Sun's version of OpenGL.
397 * Added ability to use sigaction() instead of signal()
398 to work around a SCO kernel bug.
399 Changes since 2.09: * Fixed colormap bugs in `rd-bomb'; sped up `coral'.
400 * Configure tweaks for *BSD.
401 Changes since 2.07: * New hacks `rd-bomb' and `coral'.
402 * New version of `maze' with some new algorithms.
403 * New colorized version of `rocks'.
404 * Fixed a bug in qix on 64-bit machines.
405 * Fixed a bug in the -time option.
406 * Fixed a bug in configure related to LessTif.
407 Changes since 2.06: * Minor header tweaks in windows.c and flag.c.
408 * Made multi-architecture ($VPATH) builds work properly.
409 * Merged new GL stuff from xlockmore (rubik, morph3d.)
410 * Fixed intermittent crashes in `imsmap' and `munch'.
411 * Added `fadeplot' hack from xlockmore.
412 Changes since 2.05: * Merged in VMS support from Patrick Moreau.
413 Changes since 2.04: * Fixed a MIT-SCREEN-SAVER-related crash, and tweaked
414 configure to detect the extra-random -Xss library.
415 Changes since 2.03: * HP configure tweaks. Detect and warn about LessTif.
416 * Fixed low-color behavior of `goop', `pyro', `starfish',
417 `greynetic', `flame', `halo', and `moire'.
418 Changes since 2.02: * Fixed flicker in `pipes'. Fixed 3d in `bouboule'.
419 * Added `munch' hack.
420 * Added basic dependencies to the Makefile.in files.
421 Changes since 2.01: * Fixes for compiling with the MIT saver extension.
422 * Made the yow/fortune program be a configure option.
423 * Various configure tweaks.
424 Changes since 2.00: * Added `goop' and `starfish' hacks.
425 * Added colomap cycling to `halo'.
426 * Made `attraction' use the new colormap allocator.
427 * Added better $PATH diagnostics.
428 * There was a bug in frand! Color selection should be
430 Changes since 1.34: * Converted to use `configure' instead of `imake'.
431 * ANSI C is now required.
432 * Added Kerberos locking support, from Nat Lanza.
433 * Made the stderr text use overlay planes, if possible.
434 * Reworked the xlockmore compatibility stuff again.
435 * Added `gears', `superquadrics', `escher', `pipes',
436 and `sproingies' hacks (depend on OpenGL.)
437 Changes since 1.33: * Fixed some bugs, made fading be a little smoother.
438 Changes since 1.32: * Made it work with multi-headed displays.
439 * Generalized sub-process management (Unix sucks!)
440 * Added interactive mouse frobbing to Julia.
441 * Added (untested) support for HPUX shadow passwords.
442 * Made normal non-shadow passwords be checked if the
443 shadow passwords aren't accessible for some reason.
444 Changes since 1.31: * Removed *colorPrograms and *monoPrograms resources:
445 made it possible to specify the desired visual on a
447 * Cleaned up / restructured the driver: no more globals.
448 * Made the Motif and Athena dialogs share more code.
449 * Probably fixed some Athena colormap-installation bugs.
450 * Fixed screen grabbing (cmap) on SGI 12-bit PseudoColor.
451 * Fixed divide-by-zero in bright random colormaps.
452 * Added an improved version of xlock's `flag' hack.
453 * Made unfading work better, and not flicker on SGIs.
454 * Added `sphere', `forest', `lisa' hacks from xlockmore.
455 * Added (untested) support for SunOS Adjunct passwords.
456 Changes since 1.30: * Improved colors and colormap cycling of many hacks.
457 * Cleaned up xlockmore compatibility layer.
458 * Made `blitspin' able to grab an image off the screen.
459 * Ported `swirl' and `bouboule' hacks from xlockmore.
460 * Made the driver more careful about not leaving bits on
461 the screen, or allowing other windows to raise
462 themselves: it now re-blanks the screen every so often.
463 * Added `-time' option to `xscreensaver-command'.
464 * Improved SGI screen-grabbing some more: now it can grab
465 TrueColor screens into PseudoColor windows and have the
466 colors still come out semi-reasonably.
467 Changes since 1.29: * Made `slidescreen' and `decayscreen' work better on
468 SGIs when windows of different visuals are present, by
469 using the XReadDisplay() extension to get a true 24-bit
470 image out of the frame buffer.
471 * Made `noseguy' be in color, if compiled with XPM.
472 * Ported `braid', `drift', `fract', `galaxy', `grav',
473 `ifs', `julia', `laser', `lightning', `penrose',
474 `sierpinski', `slip', `spiral', and `strange' hacks
476 * Merged `hopalong' hack with a more recent version.
478 Changes since 1.27: * Added `deco', `moire', and `kaleidescope' hacks.
479 * Merged in support for non-Motif locking and demo mode.
480 * Made `blitspin' and `bubbles' work in TrueColor.
481 * Fixed a stupid bug I introduced in `imsmap'.
482 * Added `poly' and `gravity' options to `qix'.
483 Changes since 1.26: * Added support for SGI SCREEN_SAVER extension.
484 * Made `fade' and `unfade' work on 8-bit SGIs.
485 * Made the dialog boxes more Motify.
486 * Added `bubbles' hack.
487 Changes since 1.25: * Added `lmorph' hack.
488 * Added viscosity and mouse-control to attraction.
489 * Fixed possible bad color choices in qix and attraction.
490 * Added ramp-mode to halo.
491 * Added a new RNG, which is faster and more portable
492 than using the RNG in libc.
493 * Made locking work on SCO.
494 * Various other minor tweaks that I don't remember.
495 Changes since 1.24: * Made it capture the stdout/stderr of its subprocesses
496 and present them on the screensaver window itself.
497 * Made demo mode work correctly with non-default visuals
498 and color maps, instead of always using the defaults.
499 * Added -visual argument to all included screenhacks.
500 * Support for the R6 MIT-SCREEN-SAVER server extension.
501 * Made the demo mode list scroll properly.
502 * Added `pedal' hack.
503 Changes since 1.23: * Fixed some private-colormap oddities in slidescreen,
504 decayscreen, and xroger. Fixed apparent conservation-
505 of-mass problem in pyro; made the shrapnel round.
506 Changes since 1.22: * Minor tweaks for IRIX5; fixed locking race condition.
507 Changes since 1.21: * Minor tweaks for X11R6.
508 * Fixes for non-default visuals.
509 Changes since 1.20: * Fixed bug in color blitspin; added default image.
510 * Added diagnostics to noseguy. Fixed off-by-one
511 error in flame. Added some missing casts.
512 Changes since 1.18: * Added `flame' hack.
513 * Fixed a minor Motif dialog text field bug.
514 * Fixed yet another XPointer-not-defined-in-R4 bug.
515 Changes since 1.17: * Added support for shadow password files.
516 * Fixed some Motif-related locking bugs.
517 * Added diagnostics when locking is disabled.
518 * Made blitspin able to use the XPM library.
519 * Added `decayscreen' hack.
520 Changes since 1.16: * Added `halo' hack.
521 Changes since 1.15: * Portability fixes.
522 Changes since 1.14: * Broke the driver up into more source files.
523 * Moved the hacks into their own directory.
524 * Made all `time' parameters accept the 00:00:00 syntax,
525 so that even the parameters which are normally read as
526 minutes can be specified in seconds.
527 * Added colormap cycling to `imsmap'.
528 * Made hyper work with K&R compilers.
529 Changes since 1.13: * Added `orbit' option to `attraction' hack.
530 * Added `lock-timeout' option.
531 * Cleaned up options of `maze' hack.
532 Changes since 1.8: * Added demo mode, and locking.
534 * Added `norotate' option to `rocks' hack.
projects / xscreensaver / blob