git.hungrycats.org Git - xscreensaver/blob - README

   1
   2 See config.h for configuration parameters.  To build, do the usual:
   3
   4         xmkmf ; make ; make install ; make install.man
   5
   6 The xscreensaver program waits until the keyboard and mouse have been idle
   7 for a period, and then runs a graphics demo chosen at random.  It turns off
   8 as soon as there is any mouse or keyboard activity.
   9
  10 The purpose of xscreensaver is to display pretty pictures on your screen
  11 when it is not in use, in keeping with the philosophy that unattended
  12 monitors should always be doing something interesting, just like they do
  13 in the movies.
  14
  15 However, xscreensaver can also be used as a screen locker, to prevent
  16 others from using your terminal while your are away.
  17
  18 The benefit that this program has over the combination of the xlock and
  19 xautolock programs is the ease with which new graphics hacks can be
  20 installed: you don't need to recompile this program to add a new display
  21 mode, you just change some resource settings.  Any program which can be
  22 invoked in such a way that it draws on the root window of the screen can
  23 now be used as a screensaver without modification [*].  The programs that
  24 are being run as screensavers don't need to have any special knowledge
  25 about what it means to be a screensaver.
  26
  27 The XIdle extension will be used if you have it (win win.)
  28
  29 Unfortunately, locking doesn't work if you don't have Motif.
  30
  31 Also included are several graphics hacks for use as screensavers.  There's
  32 nothing magic about these: they're just programs that draw on the root
  33 window, which are pointed at by the screensaver's default resource settings.
  34
  35    qix          - My own implementation of this, with many more options
  36                   than you would have thought qix could have.
  37    helix        - Generates spirally "stringart" patterns.
  38    rorschach    - Random inkblot patterns.
  39    attraction   - A bouncing ball demo, or a qix-like demo, or a wild
  40                   color-cycling thing, with some odd rules.
  41    greynetic    - Random colored/stippled rectangles.
  42    rocks        - Flying through an asteroid field.
  43    blitspin     - Rotate a bitmap using bitblts.
  44    imsmap       - Generates random maps or cloud formations.
  45    hypercube    - 2d projection of a hypercube rotating on all four axes.
  46    slidescreen  - Divides the screen into a grid and plays a 16-puzzle on it.
  47    decayscreen  - A melting effect.
  48    halo         - Random circular patterns.
  49    pyro         - Fireworks.  Looks a lot like the version in xlock.
  50    hopalong     - Fractals.  I snarfed this code from xlock.
  51    noseguy      - A guy with a big nose wanders around the screen saying
  52                   things.  I snarfed this code from xnlock.
  53    maze         - This is the X maze demo modified to take a -root option
  54                   so that it works with xscreensaver.
  55
  56 All of these will pop up their own window unless given that -root option.
  57 See their man pages for more details.
  58
  59 Other reasonable things to use as screensavers, if you have them, are
  60
  61   xdaliclock -root -builtin2    - melting digital clock
  62   xswarm -r 2>&-                - swimming sperm
  63   xwave -root                   - random 3d graphs
  64   xbouncebits                   - bounce arbitrary bitmaps around
  65   ico -r                        - it's dull, but it's there
  66   xv -root file.gif -quit       - they don't all have to animate!
  67   xsplinefun                    - bouncing splines
  68   kaleid -root                  - qix-like kaleidescope patterns
  69   xfishtank -c black -d -r 1    - fish (use version 2.0 or later)
  70
  71 You can get all of these from export.lcs.mit.edu.  If you know of (or write)
  72 any other interesting programs that can be used as screensavers, please let
  73 me know!
  74
  75         -- Jamie Zawinski <jwz@lucid.com>
  76
  77 [*] It may be necessary to include "vroot.h" in the program, but that would
  78 be necessary for it to work with virtual-root window managers anyway.
  79
  80
  81 \f
  82 Changes since 1.17:     Added support for shadow password files.
  83                         Fixed some Motif-related locking bugs.
  84                         Added diagnostics when locking is disabled.
  85                         Made blitspin able to use the XPM library.
  86                         Added `decayscreen' hack.
  87 Changes since 1.16:     Added `halo' hack.
  88 Changes since 1.15:     Portability fixes.
  89 Changes since 1.14:     Broke the driver up into more source files.
  90                         Moved the hacks into their own directory.
  91                         Made all `time' parameters accept the 00:00:00 syntax,
  92                         so that even the parameters which are normally read as
  93                         `minutes' can be specified in seconds.
  94                         Added colormap cycling to `imsmap'.
  95                         Made hyper work with K&R compilers.
  96 Changes since 1.13:     Added `orbit' option to `attraction' hack.
  97                         Added `lock-timeout' option.
  98                         Cleaned up options of `maze' hack.
  99 Changes since 1.8:      Added demo mode, and locking.
 100                         Added `maze' hack.
 101                         Added `norotate' option to `rocks' hack.