This package contains a new hibernate script, designed for Software Suspend 2.

(This README has been slightly altered so that it accurately reflects
the changes made in the Debian-packaged version of the script.)

PREREQUISITES
-------------
You will require a kernel patched with Software Suspend 2 to use this script.
Patches are available from http://softwaresuspend.berlios.de/

INSTALLATION
------------

This Debian package installs the following files and directories:

/usr/sbin/hibernate                    <--- main executable script
/etc/hibernate/
/etc/hibernate/hibernate.conf          <--- main configuration file
/etc/hibernate/scriptlets.d/           <--- for custom scriptlets
/usr/share/hibernate/scriptlets.d/     <--- contains "scriptlets" (or plugins)
  various scriptlets live in /usr/share/hibernate/scriptlets.d/

The Debian version of the suspend script installs the standard
scriptlets in /usr/share/hibernate/scriptlets.d, but also looks in
/etc/hibernate/scriptlets.d and /usr/local/share/hibernate/scriptlets.d
for any custom scriptlets that you may want to write.  Documentation
on writing scriptlets can be found in /usr/share/doc/hibernate/SCRIPTLET-API.gz.

CONFIGURATION
-------------

The default configuration does nothing but save and restore your clock, and
unload some modules that will potentially cause suspending to fail. If you have
other kernel modules that need to be unloaded, filesystems unmounted, network
interfaces brought down, etc, you will want to customise the configuration file
in /etc/hibernate/hibernate.conf. Run hibernate -h for help on the possible
options. There is also a man page for hibernate.conf as well as hibernate
itself.

RUNNING
-------
Simply calling "hibernate" as root will do everything mentioned in the
configuration file to hibernate, and activate Software Suspend. Upon resuming,
any tasks for resuming the machine are run and the script exits.

If you want users other than root to be able to run the script, check out the
sudo package.

You may wish to call this script from acpid to allow you to press a
button on your machine to hibernate.  For example, on a Debian system
you can modify /etc/acpi/events/powerbtn and set the action to
/usr/sbin/hibernate to have hibernate run when you press the power button.

HELP
----
If you have problems with the hibernate script or Software Suspend, the best
place to ask is on the mailing list - softwaresuspend-help@lists.berlios.de.
You will need to subscribe to post. See
http://softwaresuspend.berlios.de/lists.html for details.

If the suspend process itself crashes (while "Writing caches", "Reading
caches", or "Copying original kernel back", etc), then the problem lies with
Software Suspend 2 itself. See the FAQ at http://softwaresuspend.berlios.de/ for
help on debugging.

AUTHOR
------
This script was written by Bernard Blackham, with contributions from:
 - Carsten Rietzschel (modules, devices, bootsplash, lock and grub scriptlets.
   many ideas and bugfixes)
 - Cameron Patrick (sysfs_power_state, xscreensaver support for lock, many
   bugfixes and ideas, man pages and Debian packaging)
 - Kevin Fenzi (rpm packaging, ideas)
 - Fedor Karpelevitch (lilo scriptlet idea)

LICENSE
-------
Copyright (C) 2004 Bernard Blackham <bernard@blackham.com.au>

The hibernate-script package is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA.

$Id: README 606 2004-11-24 14:13:18Z dagobah $
