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

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