NAME
hibernate.conf - configuration file for the hibernate script
SYNOPSIS
/etc/hibernate/hibernate.conf
DESCRIPTION
The hibernate script
hibernate(8)
reads its configuration from the
/etc/hibernate/hibernate.conf
file when it runs (unless an alternative configuration file is
specified on the command line.
USAGE
FILES
- /etc/hibernate/hibernate.conf
- Contains options which influence the hibernate script's behaviour.
AUTHOR
This manual page was written by Cameron Patrick <cameron@patrick.wattle.id.au>.
The information about various options was automatically generated from
the hibernate script itself.
SEE ALSO
HibernateVT N
If specified, output from the suspend script is redirected to the
given VT instead of stdout.
Verbosity N
Determines how verbose the output from the suspend script should be:
0: silent except for errors 1: print steps 2: print steps in detail 3:
print steps in lots of detail 4: print out every command executed
(uses -x)
LogFile <filename>
If specified, output from the suspend script will also be redirected
to this file - useful for debugging purposes.
LogVerbosity N
Same as Verbosity, but controls what is written to the logfile.
AlwaysForce <boolean>
If set to yes, the script will always run as if --force had been
passed.
AlwaysKill <boolean>
If set to yes, the script will always run as if --kill had been
passed.
Distribution <debian|fedora|mandrake|redhat|gentoo|suse|slackware>
If specified, tweaks some scriptlets to be more integrated with the
given distribution.
Include <filename>
Read configuration directives from the given file.
XDisplay <display location>
Specifies where scriptlets that use the X server should find one.
(Default: :0)
UseACPISleep <state>
Enables the use of /proc/acpi/sleep for suspending the machine. Be
aware that this method is deprecated in favour of using
/sys/power/state (with the sysfs_power_state scriptlet). This requires
a kernel with ACPI support built in. <state> should generally be 3
(for suspend-to-RAM), or 4 (for suspend-to-disk). Note: You should not
use this if you want to use Software Suspend 2.
Bootsplash <boolean>
Showing script progress on an bootsplash enabled kernel. This will
automatically enable SwitchToTextMode too.
BootsplashConfig <configfile>
Bootsplash config file (default is
/etc/bootsplash/default/config/bootsplash-1024x768.cfg)
SaveClock restore-only|<boolean>
Set this to yes to save the system clock before suspending and restore
the system clock after resuming. If set to restore-only, the clock
will not be saved, only restored - this means suspending is faster,
but if your hardware clock drifts significantly, your system clock
will drift as well.
IncompatibleDevices <device name> [...]
If there are any processes accessing these devices, then suspending is
aborted. If the --kill option is passed, the offending processes are
terminated and the suspend continues. For example programs accessing
the sound card (/dev/dsp*) or tuner cards (/dev/video*) would deny the
respective modules from being unloaded.
DisableWriteCacheOn <drive> [...]
On some hardware the power is cut off before the disk has flushed its
own hardware cache. List the devices that contain swap partitions (eg,
/dev/hda) to disable the write cache before suspending.
FBSplash <boolean>
Showing script progress using fbsplash. No kernel patches are
required, but you will need the fbsplash splashutils package installed
(distinct from the bootsplash splashutils package). This will
automatically enable SwitchToTextMode too.
FBSplashTheme <themename>
FBSplash theme name (default is "suspend2")
Unmount <mount point or device> [...]
If you have network shares or external devices that should be
unmounted before suspending, list them here.
Mount <mount point or device> [...]
If you have network shares or external devices that should be mounted
after resuming, list them here.
UnmountFSTypes <filesystem type> [...]
Unmounts any filesystems of the given types. This is most useful for
network filesystems such as smbfs and nfs.
UnmountGraceTime <seconds>
Time between sending SIGTERM to processes and SIGKILL to allow them to
cleanup gracefully.. The default is 1 second.
ChangeGrubMenu <boolean>
Change grub's config file to show system is suspended before
suspending and restore after resume.
GrubMenuFile <filename>
Filename of grub's config file. Default is /boot/grub/grub.conf.
AlternateGrubMenuFile <filename>
Filename of the grub config file to put in place when the machine is
suspended. If this is not specified, the script will add a small
header to the existing grub menu.
BackupGrubMenuFile <filename>
Where to keep a backup of your real grub menu file. Defaults to
/var/backups/grub.conf.hibernate.
IbmAcpi <boolean>
Use the ibm_acpi kernel module to signal suspend progress.
RadeonTool <boolean>
Use radeontool to turn off LCD backlight.
EnsureLILOResumes <boolean>
Makes sure that LILO boots the correct kernel image when rebooting to
resume. This is useful when you boot into a non-default kernel or want
to avoid LILO's menu delay when resuming.
LockKDE <boolean>
Lock all local KDE sessions before suspending.
LockXScreenSaver <boolean>
Lock all local X11 sessions with xscreensaver running before
suspending.
LockXLock <boolean>
Lock active X11 session using xlock.
LockXAutoLock <boolean>
Lock all local X11 sessions running xautolock.
LockConsoleAs <username>
Locks the entire system after resuming, requiring you to enter either
<username>'s or root's password to unlock it. (Requires vlock).
OnSuspend NN <program to execute> [parameters for program]
Executes a given program before suspending. NN is a two-digit number
between 00 and 99, inclusive - a higher number means the program will
be executed later in the suspend process. See the ORDERING section in
the SCRIPTLET-API for details.
OnResume NN <program to execute> [parameters for program]
Executes a given program after resuming. NN is a number between 00 and
99, inclusive - a higher number means the program will be executed
earlier in the resume process. See the ORDERING section in the
SCRIPTLET-API for details.
UnloadModules <module name> [...]
Names of modules to unload prior to suspending.
LoadModules auto|<module name> [...]
Names of modules to load after resumimg. If auto is specified, the
modules that were unloaded previously are loaded.
UnloadBlacklistedModules <boolean>
Try to remove any modules that are known to be incompatible with
hibernation prior to suspending.
UnloadAllModules <boolean>
Try to remove all modules loaded prior to suspending.
LoadModulesFromFile <filename>
Load default modules after resuming from a given filename. Each module
name must appear on it's own line, and line starting with # are
ignored. (eg, Debian's /etc/modules, Gentoo's /etc/modules.autoload)
DownInterfaces auto|<ifname> [...]
The names of network interfaces to bring down before suspending. If
the parameter "auto" is given, all interfaces which are not lo are
brought down.
UpInterfaces auto|<ifname> [...]
The names of network interfaces to bring up after suspending. If the
parameter "auto" is given, the interfaces stoped before suspending
will be started in reverse order.
EjectCards <boolean>
Eject all PCMCIA cards before suspending, and insert them again after
resuming
IncompatiblePrograms <process name> [...]
If there are processes running with any of the names listed (as seen
in ps ax), then suspending is aborted. If the --kill option is passed,
the offending processes are terminated, and the suspend continues.
StopServices <service name> [...]
The services listed are stopped prior to suspending. The service name
must correspond to the name of an init.d script that is active in the
current runlevel.
StartServices <service name> [...]
The services listed are started after resuming. The service name must
correspond to the name of an init.d script that is active in the
current runlevel.
RestartServices <service name> [...]
The services listed are stopped before suspending and started after
resuming. The service name must correspond to the name of an init.d
script that is active in the current runlevel.
UseSuspend2 <boolean>
Enable/disable the use of Software Suspend 2 to suspend.
Reboot <boolean> (requires UseSuspend2 on)
Controls whether or not Software Suspend 2 should reboot after
suspending. Setting this to yes will force a reboot. Setting this to
no will force shutting down. Omitting this option will leave rebooting
behaviour unchanged.
EnableEscape <boolean> (requires UseSuspend2 on)
If specified, allows (or disallows) the use of the escape key to abort
a suspend. If this line is not specified, the Escape key's behaviour
is unchanged.
DefaultConsoleLevel <N> (requires UseSuspend2 on)
If specified, sets the default console level. 0 gives a progress bar.
1 gives a progress bar with numbers. 2 or higher give increasing
amounts of debugging. If this line is not specified, the default
console level is unchanged.
ImageSizeLimit nocache|<NN> (requires UseSuspend2 on)
If specified, sets an upper limit on the size of the suspend image
written (in megabytes). If set to "nocache", caches and buffers will
not be saved - resulting in a faster suspend and resume at the
possible expense of system responsiveness immediately after resuming.
If set to 0, no limit is imposed. If this line is not specified, the
existing image size limit is unchanged.
AsyncIOLimit <N> (requires UseSuspend2 on)
Deprecated since 2.1.5.11 (hence won't do anything if set). Limit the
number of I/O operations that Software Suspend 2 will have queued at
once. Lowering this value has resolved hangs when reading or writing
caches for some people. Try values like 64, 32 and 8.
Swsusp2AllSettings <params> (requires UseSuspend2 on)
If specified, sets all of the settings for Software Suspend 2 at once.
The parameter should be the contents of /proc/suspend2/all_settings
after you have set your desired settings manually.
Swsusp2AllSettingsFile <filename> (requires UseSuspend2 on)
If specified, sets all of the settings for Software Suspend 2 and all
its plugins at once, from the given file. The parameter should be the
path to a file containing the result of "cat
/proc/suspend2/all_settings > <filename>"after you have set your
desired settings manually.
SuspendDevice <device> (requires UseSuspend2 on)
If specified, sets the suspend device by writing to the resume2 entry
in /proc/suspend2. This does not automatically set the resuming device
- you will need to make sure your bootloader or initrd script does
this.
FilewriterLocation <filename> <size in MB> (requires UseSuspend2 on)
This option sets up the given filename to act as a destination file
for writing the suspend image to, and verifies that it can act as a
valid destination. If the file does not exist, the file is created.
This option is only relevant if you are using the filewriter plugin
for Software Suspend.
VerifyFilewriterResume2 <boolean> (requires UseSuspend2 on)
When this option is on, you will be prompted if your current kernel
command-line does not match the correct resume2 for the filewriter.
This option is on by default.
LoadSuspendModules <module name> [...] (requires UseSuspend2 on)
Loads the given modules before even detecting Software Suspend. This
may be required when Software Suspend is compiled as modules that need
to be loaded prior to suspending.
UnloadSuspendModulesAfterResume <boolean> (requires UseSuspend2 on)
If yes, will unload the Software Suspend modules mentioned above after
resuming.
PowerdownMethod <3|4|5> (requires UseSuspend2 on)
Allows you to choose what Software Suspend 2 should do after writing
its image to disk. This only works if you have ACPI enabled in your
kernel. 3/4/5 correspond to the ACPI states S3 (suspend-to-RAM), S4
(suspend-to-disk), and S5 (power off). Choosing 3 will request your
machine to enter the S3 Suspend-to-RAM state if it is supported - this
allows you drastically cut the resume time waiting for your BIOS but
still consumes power whilst hibernated (though the image is not lost
should power run out). Choosing 4 will cause your machine to enter an
S4 sleep state which may also reduce the resume time without using any
power whilst hibernated. Choosing 5 will cause your machine to switch
off after suspending (traditional method).
Compressor none|<compressor name> (requires UseSuspend2 on)
Sets the compression algorithm to use for compressing the memory
image. If set to "none", disables compression. Otherwise, the
compressor name must be listed in /proc/crypto. This will also try to
load the module if not available. (Only for Software Suspend 2.1.9.5
or newer).
Encryptor none|<encryptor name> (requires UseSuspend2 on)
Sets the encryption algorithm to use for encrypting the memory image.
If set to "none", disables encryption. Otherwise, the cipher name must
be listed in /proc/crypto. This will also try to load the module if
not available. You will probably require more options than just this
to fully use encryption. These will be introduced in the next version
of hibernate, but for now you can set them using the "ProcSetting"
option if you know what you are doing. (Only for Software Suspend
2.1.9.5 or newer).
ProcSetting <entry name> <value> (requires UseSuspend2 on)
Sets the value of /proc/suspend2/<entry_name> to <value> upon
suspending. You can use this setting to set parameters that can't be
configured anywhere else in this script. This is executed after all
other settings have been set.
UseSysfsPowerState <state>
Enables the use of /sys/power/state for suspending the machine (to RAM
or disk). This requires a kernel supporting this interface. <state>
must be one of the options listed by `cat /sys/power/state`, (eg mem,
disk, or standby).
PowerdownMethod <shutdown|platform|firmware> (requires UseSysfsPowerState)
If using /sys/power/state to suspend your machine to disk, chooses the
method by which to do so. Choosing "shutdown" will save state in
linux, then tell the bios to powerdown (most reliable). Choosing
"platform" will save state in linux, then tell the bios to powerdown
and blink it's "suspended LED". Choosing "firmware" will tell the bios
to save state itself (needs BIOS-specific suspend partition, and has
very little to do with swsusp).
EnableVbetool <boolean>
Save and restore video state using vbetool before and after
suspending.
RestoreVbeStateFrom <filename>
If set, will restore the VBE state with the data stored in <filename>.
Use this if your card requires you to restore it with a state captured
at boot (from single user mode, run "vbetool vbestate save >
/var/lib/vbetool/vbestate"). If this option is not set, the state is
saved just before suspending.
VbetoolPost <boolean>
If yes, will call the video BIOS's POST routine to reinitialise the
video card. Some cards need this to turn on the backlight back and be
useful after resuming. Other video cards will hang if you attempt to
POST them. Try it with yours and see.
RestoreVCSAData <boolean>
If yes, will call save and restore some of the video card's state from
/dev/vcsa. This helps certain drivers such as ATI's fglrx driver to
resume properly.
SwitchToTextMode <boolean>
If your X driver is unable to resume properly, you can try switching
to a text console first by setting this to yes.
UseDummyXServer <boolean>
Some X drivers can be reinitialised by launching a dummy X server
after resuming to restore the state of the graphics card. Set this to
yes to do so.
XStatus <gnome|kde|x>
Enables progress display and error reporting for the given
environment.
XSuspendText <message>
Text to display on screen whilst preparing to suspend. (default:
"Preparing to suspend...")
XResumeText <message>
Text to display on screen whilst coming back from suspend. (default:
"Resuming from suspend...")
XosdSettings <options>
Options to pass to osd_cat, see 'man osd_cat' (default: "--font
--shadow 1 --pos bottom --align center --offset 50")