ftp://ftp.uni-heidelberg.de/pub/X11/contrib/applications/xscreensaver-1.27.tar.Z
[xscreensaver] / 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, MIT-SCREEN-SAVER, and/or SGI SCREEN_SAVER server extensions
30 will be used if you have them.
31
32 Unfortunately, locking doesn't work if you don't have Motif.
33
34 Also included are several graphics hacks for use as screensavers.  There's
35 nothing magic about these: they're just programs that draw on the root
36 window, which are pointed at by the screensaver's default resource settings.
37
38    qix          - My own implementation of this, with many more options
39                   than you would have thought qix could have.
40    helix        - Generates spirally "stringart" patterns.
41    pedal        - Draws a different kind of spirally pattern.
42    rorschach    - Random inkblot patterns.
43    attraction   - A bouncing ball demo, or a qix-like demo, or a wild
44                   color-cycling thing, with some odd rules.
45    greynetic    - Random colored/stippled rectangles.
46    rocks        - Flying through an asteroid field.
47    blitspin     - Rotate a bitmap using bitblts.
48    imsmap       - Generates random maps or cloud formations.
49    hypercube    - 2d projection of a hypercube rotating on all four axes.
50    slidescreen  - Divides the screen into a grid and plays a 16-puzzle on it.
51    decayscreen  - A melting effect.
52    halo         - Random circular patterns.
53    pyro         - Fireworks.  Looks a lot like the version in xlock.
54    hopalong     - Fractals.  I snarfed this code from xlock.
55    flame        - Fractals.  Also from xlock.
56    noseguy      - A guy with a big nose wanders around the screen saying
57                   things.  I snarfed this code from xnlock.
58    maze         - This is the X maze demo modified to take a -root option
59                   so that it works with xscreensaver.
60    lmorph       - morphing line drawings.
61    bubbles      - condensation forms on your monitor, then pops.
62
63 All of these will pop up their own window unless given that -root option.
64 See their man pages for more details.
65
66 Other reasonable things to use as screensavers, if you have them, are
67
68   xdaliclock -root -builtin2    - melting digital clock
69   xswarm -r 2>&-                - swimming sperm
70   xwave -root                   - random 3d graphs
71   xbouncebits                   - bounce arbitrary bitmaps around
72   ico -r -p8 -faces -sleep 1    - it's dull, but it's there
73   xv -root file.gif -quit       - they don't all have to animate!
74   xsplinefun                    - bouncing splines
75   kaleid -root                  - qix-like kaleidescope patterns
76   xfishtank -c black -d -r 1    - fish (use version 2.0 or later)
77   xtacy -root                   - various eye candy
78
79 You can get all of these from the contrib directory on ftp.x.org.  If you
80 know of (or write) any other interesting programs that can be used as
81 screensavers, please let me know!
82
83 The latest version of xscreensaver is always ftpable from ftp.x.org.  You can
84 also get it from my web page at http://www.netscape.com/people/jwz/.
85
86         -- Jamie Zawinski <jwz@netscape.com>
87
88 \f
89 Changes since 1.26:     Added support for SGI SCREEN_SAVER extension.
90                         Made `fade' and `unfade' work on 8-bit SGIs.
91                         Made the dialog boxes more Motify.
92                         Added `bubbles' hack.
93 Changes since 1.25:     Added `lmorph' hack.
94                         Added viscosity and mouse-control to attraction.
95                         Fixed possible bad color choices in qix and attraction.
96                         Added ramp-mode to halo.
97                         Added a new RNG, which is faster and more portable
98                         than using the RNG in libc.
99                         Made locking work on SCO.
100                         Various other minor tweaks that I don't remember.
101 Changes since 1.24:     Made it capture the stdout/stderr of its subprocesses
102                         and present them on the screensaver window itself.
103                         Made demo mode work correctly with non-default visuals
104                         and color maps, instead of always using the defaults.
105                         Added -visual argument to all included screenhacks.
106                         Support for the R6 MIT-SCREEN-SAVER server extension.
107                         Made the demo mode list scroll properly.
108                         Added `pedal' hack.
109 Changes since 1.23:     Fixed some private-colormap oddities in slidescreen,
110                         decayscreen, and xroger.  Fixed apparent conservation-
111                         of-mass problem in pyro; made the shrapnel round.
112 Changes since 1.22:     Minor tweaks for IRIX5; fixed locking race condition.
113 Changes since 1.21:     Minor tweaks for X11R6.
114                         Fixes for non-default visuals.
115 Changes since 1.20:     Fixed bug in color blitspin; added default image.
116                         Added diagnostics to noseguy.  Fixed off-by-one
117                         error in flame.  Added some missing casts.
118 Changes since 1.18:     Added `flame' hack.
119                         Fixed a minor Motif dialog text field bug.
120                         Fixed yet another XPointer-not-defined-in-R4 bug.
121 Changes since 1.17:     Added support for shadow password files.
122                         Fixed some Motif-related locking bugs.
123                         Added diagnostics when locking is disabled.
124                         Made blitspin able to use the XPM library.
125                         Added `decayscreen' hack.
126 Changes since 1.16:     Added `halo' hack.
127 Changes since 1.15:     Portability fixes.
128 Changes since 1.14:     Broke the driver up into more source files.
129                         Moved the hacks into their own directory.
130                         Made all `time' parameters accept the 00:00:00 syntax,
131                         so that even the parameters which are normally read as
132                         minutes can be specified in seconds.
133                         Added colormap cycling to `imsmap'.
134                         Made hyper work with K&R compilers.
135 Changes since 1.13:     Added `orbit' option to `attraction' hack.
136                         Added `lock-timeout' option.
137                         Cleaned up options of `maze' hack.
138 Changes since 1.8:      Added demo mode, and locking.
139                         Added `maze' hack.
140                         Added `norotate' option to `rocks' hack.