Package: uswsusp
Version: 0.8-1.2+b1
Severity: minor
Tags: patch
Here are a few spelling fixes and other minor fixes for the README.Debian
file and for the uswsusp.conf man page (fixes bugs #518636 and #520705).
Also removed end-of-line spaces from README.Debian.
I'm also attaching a word-by-word diff (git-diff --word-diff=color) to show
exactly where the important changes are.
diff --git a/debian/README.Debian b/debian/README.Debian
index f883348..7080466 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,42 +1,42 @@
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
+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 and 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.
+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 your not happy with it you can choose to alter it by hand or by running
+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
+ update-initramfs -u
(and maybe run lilo) to update your ramdisk.
-NOTE, by default update-initramfs -u only updates the ramdisk of the `latest'
+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
+you boot an older kernel. You can set update_initramfs=all in
/etc/initramfs-tools/update-initramfs.conf to let it update all initramfses.
-NOTE2, if you have both update-initramfs and yaird installed there is a
+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,
+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.
+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 work around for your system is known
+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
+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
@@ -44,23 +44,23 @@ for instructions. If you find a work around, 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
+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
+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 set up
-doesn't suit you it can be extended to your needs.
-This sofware is very much in its alpha stages and can cause severe
+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.
diff --git a/debian/README.Debian-source b/debian/README.Debian-source
index 8349304..1f3528b 100644
--- a/debian/README.Debian-source
+++ b/debian/README.Debian-source
@@ -1,5 +1,5 @@
This source package consists of the merger of a tarball coming
from the uswsusp (or suspend) project and one from liblzf.
-I chose two not seperately package liblzf, because it is so small
+I chose to not separately package liblzf, because it is so small
and there are alternatives in the archive already.
Also see the copyright file.
diff --git a/debian/uswsusp.conf.xml b/debian/uswsusp.conf.xml
index ac3942e..1c6945a 100644
--- a/debian/uswsusp.conf.xml
+++ b/debian/uswsusp.conf.xml
@@ -33,7 +33,7 @@ and docbook-xsl in your Build-Depends control field.
<!ENTITY dhdate "<date>juni 24, 2006</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
- <!ENTITY dhsection "<manvolnum>8</manvolnum>">
+ <!ENTITY dhsection "<manvolnum>5</manvolnum>">
<!ENTITY dhemail "<email>t...@famdijkstra.org</email>">
<!ENTITY dhusername "Tim Dijkstra">
<!ENTITY dhucpackage "<refentrytitle>uswsusp.conf</refentrytitle>">
@@ -224,7 +224,7 @@ If set to "shutdown" the machine will be powered off.
</term>
<listitem>
<para>
- If this this options points a valid RSA key, which can be created
+ If this option points to a valid RSA key, which can be created
with <command>&dhkeygen;</command>,
the <command>&dhsuspend;</command> tool will generate a random
key for the Blowfish encryption that will be passed to the
@@ -241,7 +241,7 @@ If set to "shutdown" the machine will be powered off.
<listitem>
<para>
- If the "early writeout" parameter is set to 'y' is specified, the <command>&dhsuspend;</command>
+ If the "early writeout" parameter is set to 'y', the <command>&dhsuspend;</command>
utility will start syncing the resume device early in the process of writing
the image to it. [This has been reported to speed up the <command>&dhsuspend;</command> on some
boxes and eliminates the "fast progress meter and long fsync wait" effect.]
@@ -254,7 +254,11 @@ If set to "shutdown" the machine will be powered off.
</term>
<listitem>
<para>
- The "splash" parameter is used to make <command>&dhsuspend;</command> and/or <command>&dhresume;</command> use a splash system (when set to 'y'). Currently the bootsplash.org and splashy systems are supported. For the former you need a kernel patch, the later is a userspace solution, but you'll need to install a splashy theme.
+ The "splash" parameter is used to make <command>&dhsuspend;</command>
+ and/or <command>&dhresume;</command> use a splash system (when set to 'y').
+ Currently the bootsplash.org and splashy systems are supported.
+ For the former you need a kernel patch, the latter is a userspace solution,
+ but you'll need to install a splashy theme.
</para>
<para>
If you use initramfs-tools on &debian; to generate your initramfs
[1mdiff --git a/debian/README.Debian b/debian/README.Debian[m
[1mindex f883348..7080466 100644[m
[1m--- a/debian/README.Debian[m
[1m+++ b/debian/README.Debian[m
[36m@@ -1,42 +1,42 @@[m
uswsusp for Debian[m
------------------[m
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[m
not working. Finally, you need[31mand[m 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
[31m/etc/uswsusp.conf[m
[31mIf your[m[32m/etc/uswsusp.conf;[m
[32mif you're[m not happy with it you can choose to alter it by hand or by
running
dpkg-reconfigure uswsusp[m
If you change it by hand you should run[m
update-initramfs -u
(and maybe run lilo) to update your ramdisk.[m
NOTE, by default update-initramfs -u only updates the ramdisk of the `latest'
kernel. This can lead to incompatibilities between s2disk and resume if[m
you boot an older kernel. You can set update_initramfs=all in
/etc/initramfs-tools/update-initramfs.conf to let it update all initramfses.[m
[31mNOTE2,[m[32mNOTE 2,[m if you have both update-initramfs and yaird
installed there is a
possibility that running dpkg-reconfigure won't create an initrd for you.[m
You should run update-initramfs by hand (possibly with -t).[m
This package installs the following binaries in root's path: s2disk, s2ram,
s2both, suspend-keygen and swap-offset.[m
s2disk will always poweroff after making a snapshot of the system, if[m
your initramfs and uswsusp.conf are correct, this should just work.[m
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[m
card, which most of the time can be worked around.[m
It will only try suspend to ram if a [31mwork around[m[32mworkaround[m for
your system is known
(or known not to be necessary). You can check if your system is known by[m
running
s2ram -n[m
If it is, you can use s2both. If not you can try and experiment with[m
s2ram to find a workaround for your system. Read README.s2ram-whitelist[m
[36m@@ -44,23 +44,23 @@[m [mfor instructions. If you find a work around,
please send a report to either[m
the debian BTS or directly to the upstream authors.[m
The uswsusp system supports encrypting the image written to disk. The[m
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[m
should be typed as if one has a non-us keymap. This will hopefully be[m
fixed soon.[m
It also supports two splash [31msystems. The[m[32msystems, the[m one from
bootsplash.org and
splashy. The latter is an userspace implementation. For it to work[m
you need to install splashy and a splashy theme. Be carefull not to use[m
splashy-from-initramfs (not the default) and uswsusp's splash support[m
at the same time.[m
Userspace suspend is designed to be very flexible; [31mIf[m[32mif[m the
custom [31mset up[m[32msetup[m
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[m
if you want to know more about how it all works.[m
[1mdiff --git a/debian/README.Debian-source b/debian/README.Debian-source[m
[1mindex 8349304..1f3528b 100644[m
[1m--- a/debian/README.Debian-source[m
[1m+++ b/debian/README.Debian-source[m
[36m@@ -1,5 +1,5 @@[m
This source package consists of the merger of a tarball coming[m
from the uswsusp (or suspend) project and one from liblzf.[m
I chose [31mtwo[m[32mto[m not [31mseperately[m[32mseparately[m package
liblzf, because it is so small
and there are alternatives in the archive already.[m
Also see the copyright file.[m
[1mdiff --git a/debian/uswsusp.conf.xml b/debian/uswsusp.conf.xml[m
[1mindex ac3942e..1c6945a 100644[m
[1m--- a/debian/uswsusp.conf.xml[m
[1m+++ b/debian/uswsusp.conf.xml[m
[36m@@ -33,7 +33,7 @@[m [mand docbook-xsl in your Build-Depends control
field.[m
<!ENTITY dhdate "<date>juni 24, 2006</date>">[m
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are[m
allowed: see man(7), man(1). -->[m
<!ENTITY dhsection
[31m"<manvolnum>8</manvolnum>">[m[32m"<manvolnum>5</manvolnum>">[m
<!ENTITY dhemail "<email>t...@famdijkstra.org</email>">[m
<!ENTITY dhusername "Tim Dijkstra">[m
<!ENTITY dhucpackage "<refentrytitle>uswsusp.conf</refentrytitle>">[m
[36m@@ -224,7 +224,7 @@[m [mIf set to "shutdown" the machine will be powered
off.[m
</term>[m
<listitem>[m
<para>[m
If this [31mthis options[m[32moption[m points [32mto[m a valid
RSA key, which can be created
with <command>&dhkeygen;</command>, [m
the <command>&dhsuspend;</command> tool will generate a random[m
key for the Blowfish encryption that will be passed to the [m
[36m@@ -241,7 +241,7 @@[m [mIf set to "shutdown" the machine will be powered
off.[m
<listitem>[m
<para>[m
[m
If the "early writeout" parameter is set to [31m'y' is
specified,[m[32m'y',[m the <command>&dhsuspend;</command>
utility will start syncing the resume device early in the process of
writing[m
the image to it. [This has been reported to speed up the
<command>&dhsuspend;</command> on some[m
boxes and eliminates the "fast progress meter and long fsync wait"
effect.][m
[36m@@ -254,7 +254,11 @@[m [mIf set to "shutdown" the machine will be
powered off.[m
</term>[m
<listitem>[m
<para>[m
The "splash" parameter is used to make <command>&dhsuspend;</command>
and/or <command>&dhresume;</command> use a splash system (when set to
'y').
Currently the bootsplash.org and splashy systems are supported.
For the former you need a kernel patch, the
[31mlater[m[32mlatter[m is a userspace solution,
but you'll need to install a splashy theme.
</para>[m
<para>[m
If you use initramfs-tools on &debian; to generate your initramfs [m
