uswsusp for Debian
------------------

For suspend/resume to work at all you need a kernel version 2.6.17-rc1 or 
above. Proper support for s2both on powerpc appeared in version 2.6.22. You 
will also need a swap partition or file. For swap file support you need kernel 
version 2.6.20 or above, swapfile in a LVM partition has a bug and is currently
not working. Finally, you need an initramfs to start the resume process. If
you are using initramfs-tools to generate your initramfs you're in luck; this 
package provides the necessary hooks and scripts to make it happen. 

During install a suitable configuration will be written to /etc/uswsusp.conf;
if you're not happy with it you can choose to alter it by hand or by running
    dpkg-reconfigure uswsusp
If you change it by hand you should run
    update-initramfs -u 
(and maybe run lilo) to update your ramdisk.

NOTE, by default update-initramfs -u only updates the ramdisk of the `latest' 
kernel. This can lead to incompatibilities between s2disk and resume if
you boot an older kernel. You can set update_initramfs=all in 
/etc/initramfs-tools/update-initramfs.conf to let it update all initramfses.

NOTE 2, if you have both update-initramfs and yaird installed there is a 
possibility that running dpkg-reconfigure won't create an initrd for you.
You should run update-initramfs by hand (possibly with -t).

This package installs the following binaries in root's path: s2disk, s2ram, 
s2both, suspend-keygen and swap-offset.

s2disk will always poweroff after making a snapshot of the system, if
your initramfs and uswsusp.conf are correct, this should just work.

s2both will try to suspend to ram (S3) after making the snapshot. 
This is a bit more tricky. Usually there are some issues with the graphics
card, which most of the time can be worked around.
It will only try suspend to ram if a workaround for your system is known 
(or known not to be necessary). You can check if your system is known by
running 
    s2ram -n
If it is, you can use s2both. If not you can try and experiment with
s2ram to find a workaround for your system. Read README.s2ram-whitelist
for instructions. If you find a workaround, please send a report to either
the debian BTS or directly to the upstream authors.

The uswsusp system supports encrypting the image written to disk. The
easiest way to enable this is by answering the questions you get by 
running 'dpkg-reconfigure -pmedium uswsusp'. Alternatively you can read 
the HOWTO. 
When using a non-us keyboard layout and encryption one should be aware 
of the fact that due to a bug in initramfs-tools the passphrase on resume
should be typed as if one has a non-us keymap. This will hopefully be
fixed soon.

It also supports two splash systems, the one from bootsplash.org and
splashy. The latter is an userspace implementation. For it to work
you need to install splashy and a splashy theme. Be carefull not to use
splashy-from-initramfs (not the default) and uswsusp's splash support
at the same time.

Userspace suspend is designed to be very flexible; if the custom setup 
doesn't suit you it can be extended to your needs. 
This sofware is very much in its alpha stages and can cause severe 
data corruption when used wrongly. Please read the README and HOWTO
if you want to know more about how it all works.


Tim Dijkstra <tim@famdijkstra.org>, Mon, 13 sep 2007 00:50:16 +0200

 -- Rodolfo García Peñas (kix) <kix@kix.es>  Sun, 05 Sep 2010 12:15:47 +0200