http://slackware.bholcomb.com/slackware/slackware-11.0/source/xap/xscreensaver/xscree...
[xscreensaver] / README
diff --git a/README b/README
index ea9b4c4aaa0662e4a25948dc02004d3badc13e2f..64011bb30dbabd1b3de020490a7d0cea236f2874 100644 (file)
--- a/README
+++ b/README
@@ -1,81 +1,66 @@
 
                               XScreenSaver
 
-            a screen saver and locker for the X window system
-                            by Jamie Zawinski
+                             a collection of
+                            free screen savers
+                            for X11 and MacOS
 
-                     http://www.jwz.org/xscreensaver/
-
-To build on Unix:
-
-  -  ./configure
-  -  make
-  -  make install
-
-The `configure' shell script will attempt to figure out which options are
-appropriate for your system, and will create config.h and the various
-Makefiles for you.  Run `configure --help' to see how to override these
-choices, or to specify things like the default installation directory.
-The file `INSTALL' gives a general overview of use of these sorts of
-configure scripts (those generated by the GNU autoconf system.)
-
-If you have libraries in non-standard places, you can specify their
-locations with options like this:
-
-     ./configure --with-motif=/opt/Motif --with-xpm=/usr/local
+                            By Jamie Zawinski
+                             and many others
 
-On MacOS X, it is strongly recommended that you install Fink first
-(http://fink.sourceforge.net/).  With Fink installed, you probably want
-to pass --prefix=/sw to configure.
-
-To build on VMS, see README.VMS.
-
-If you think you've found a bug, please let me know!  No bug report is too
-small.  But first, please read the enclosed `README.debugging' file to find
-out what kind of information would be most helpful to include in your bug
-report.
-
-Getting Started:
-
-You can try out xscreensaver like so:
+                     http://www.jwz.org/xscreensaver/
 
-       xscreensaver &
-       xscreensaver-demo
+===============================================================================
 
-The XScreenSaver suite of applications uses a client-server model:
-The `xscreensaver' program is a daemon that runs in the background;
-it is controlled by the foreground `xscreensaver-demo' program.
+This is the XScreenSaver source code distribution.  It is strongly recommended
+that you install a binary release rather than trying to compile it yourself.
+Binaries are available for almost all platforms, including MacOS X.  See the
+XScreenSaver web site for details.
 
-xscreensaver has an extensive manual -- please read it!
+To compile on a Unix system with X11:
 
-                              ============
+    ./configure
+    make
+    make install
 
-The xscreensaver daemon waits until the keyboard and mouse have been idle
-for a period, and then runs a graphics demo chosen at random.  The demo is
-terminated as soon as there is any mouse or keyboard activity (or, in
-locking mode, when the proper password is typed.)
+To compile on MacOS X:
 
-It is trivially easy to add new display modes to xscreensaver: any program
-which can be invoked in such a way that it draws on the root window of the
-screen can be used as a screensaver.  You just change a config file --
-there's no need to recompile or reinstall anything.
+    Use the included XCode project.  Requires XCode 2.2 and MacOS X 10.4.0
+    or newer.
 
-                              ============
+Interested in writing a new screen saver?
 
-Along with the xscreensaver daemon itself, this package also includes
-numerous graphics hacks for use as screensavers.  There is nothing
-magic about these: they are just programs that draw on the root window.
-More than 200 such programs are included.  For details, see the
-xscreensaver web page, or the enclosed manual pages.
+    See the README.hacking file.
 
-The latest version of xscreensaver is always available on the web at
-http://www.jwz.org/xscreensaver/.
+===============================================================================
 
-Looking for tips on writing your own screensavers?  There is an entry in
-the XScreenSaver FAQ about that: http://www.jwz.org/xscreensaver/faq.html
+XScreenSaver has an extensive manual -- please read it!
 
-                              ============
+===============================================================================
 
+Changes since 4.24:   * Ported to MacOS X! (10.4.0 or newer)
+                      * API change: instead of providing a single screenhack()
+                        function that does not return, screen savers using the
+                        screenhack.h framework must now provide "init" and
+                        "draw one frame" functions instead.  All bundled savers
+                        have been updated; third-party patches will need work.
+                      * All image-loading happens asynchronously.
+                      * xscreensaver-getimage-file caches the contents of the
+                        image directory for a few hours, so consecutive runs
+                        won't have to re-list the whole directory tree.
+                      * New hacks, `topblock' and `glschool'.
+                      * Removed `xteevee' (superceded by `xanalogtv').
+                      * Added variable-sized puzzle pieces to `jigsaw'.
+                      * Changes to the defaults and command-line options of
+                        many hacks to make the .xml files more consistent.
+                      * Reap zombies in `glslideshow' and `carousel'.
+                      * `sonar' works without setuid on OSX (dgram icmp).
+                      * `xmatrix -mode pipe' displays the text of a subprocess.
+                      * `endgame' has higher resolution chess-piece models.
+                      * `webcollage' takes a -directory option to get images
+                        from a local directory.
+                      * The RPM spec file no longer auto-restarts xscreensaver
+                        when a new version is installed.  Restart it manually.
 Changes since 4.23:   * New versions of `cube21', `glsnake', `celtic'.
                       * Backed out a DPMS-related patch that cause desktop
                         flickering with some X servers.