hibernate.conf - configuration file for the hibernate script
The hibernate script hibernate
(8) reads its configuration from the
file when it runs (unless an alternative
configuration file is specified on the command line).
If configuration directives are specified multiple times, typically the last one
will take effect.
- 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.
- LogTimestamp <boolean>
- If logging to file, will place timestamps on each log
entry. This is only recommended if you are trying to optimise
suspend/resume time, otherwise it will just slow the process down.
- LogVerbosity N
- Same as Verbosity, but controls what is written to the
- AlwaysForce <boolean>
- If set to yes, the script will always run as if --force had
- AlwaysKill <boolean>
- If set to yes, the script will always run as if --kill had
- If specified, tweaks some scriptlets to be more integrated
with the given distribution.
- Include <filename>
- Immediately include configuration directives from the given
- 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 TuxOnIce.
- BackLight <boolean>
- This will enable fancy backlight fading using the
- Bootsplash <boolean>
- Showing script progress on an bootsplash enabled kernel.
This will automatically enable SwitchToTextMode too.
- BootsplashConfig <configfile>
- Bootsplash config file (default is
- 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
- 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 taken from
- 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.
- LogoutGaim <boolean>
- Changes all locally running Gaim's status to offline before
suspending, and (optionally) change it back to the original status after
- GaimRestoreStatus <boolean>
- Changes back Gaim's status to the original status after
- GaimLogoutMessage <string>
- Status message to set when logging out Gaim.
- GaimLoginMessage <string>
- Status message to set when logging in Gaim.
- GaleonOffline <boolean>
- Changes all locally running Galeon's status to offline
before suspending, and (optionally) change it back to the original state
- GaleonRestoreStatus <boolean>
- Change status of Galeon back to the original state after
- RestoreGFXBrightness <boolean>
- This will save and restore LCD brightness(GFX cards) using
- 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
- 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.cfg.hibernate.
- IbmAcpi <boolean>
- Use the ibm_acpi kernel module to signal suspend
- RadeonTool <boolean>
- Use radeontool to turn off LCD backlight.
- Runi915resolution <boolean>
- Set to run 915resolution before switching back to X.
- FullSpeedCPU <boolean>
- Sets the CPU to full speed whilst suspending.
- AcpiVideoS3Bios <boolean>
- Sets s3_bios mode, replaces acpi_sleep=s3_bios kernel
- AcpiVideoS3Mode <boolean>
- Sets s3_mode mode, replaces acpi_sleep=s3_mode kernel
- 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.
- LockFreedesktop <boolean>
- Lock all local sessions compatible with freedesktop.org
screensaver interface before suspending.
- LockXScreenSaver <boolean>
- Lock all local X11 sessions with xscreensaver running
- LockGnomeScreenSaver <boolean>
- Lock all local X11 sessions with gnome-screensaver running
- 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
- LockXtrLock <boolean>
- Lock active X11 session using xtrlock.
- LockEnlightenment17 <boolean>
- Lock enlightenment17 session before suspending.
- OnSuspend NN <program to execute> [parameters
- 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
- 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 resuming. 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 its own line, and lines starting with #
are ignored. (eg, Debian's /etc/modules, Gentoo's
- GentooModulesAutoload <boolean>
- Try to load default modules after resuming (from
- 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
stopped before suspending will be started in reverse order.
- EnableNMReconnect <boolean>
- Disconnect and reconnect NM before and after
- MuteAudio <boolean>
- This will mute your speakers on suspend to avoid
compromising situations on resume.
- PauseAudio <boolean>
- This will pause your audio player before suspending. Audio
is not unpaused on resume.
- EjectCards <boolean>
- Eject all PCMCIA cards before suspending, and insert them
again after resuming
- LogoutPidgin <boolean>
- Changes all locally running Pidgin's status to offline
before suspending, and (optionally) change it back to the original status
- PidginRestoreStatus <boolean>
- Changes back Pidgin's status to the original status after
- PidginLogoutMessage <string>
- Status message to set when logging out Pidgin.
- PidginLoginMessage <string>
- Status message to set when logging in Pidgin.
- 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
- RemountXFSBoot <boolean>
- Remount the /boot partition read-only when suspending to
prevent against an XFS bug.
- 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
- 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.
- AgentsClearGPG <boolean>
- Clear private data (passphrase) from gpg-agent
- AgentsClearSSH <boolean>
- Clear private data (passphrase) from ssh-agent
- SylpheedClawsOffline <boolean>
- Changes status of all locally running Sylpheed Claws to
offline before suspending, and (optionally) change it to online after
- SylpheedClawsOnline <boolean>
- Changes status of all locally running Sylpheed Claws to
online after resuming.
- 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>
- 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
- UseTuxOnIce <boolean>
- Enable/disable the use of TuxOnIce to hibernate.
- Reboot <boolean> (requires UseTuxOnIce
- Controls whether or not TuxOnIce should reboot after
hibernating. Setting this to yes will force a reboot. Setting this to no
will force shutting down. Omitting this option will leave rebooting
- EnableEscape <boolean> (requires UseTuxOnIce
- If specified, allows (or disallows) the use of the escape
key to abort a hibernation cycle. If this line is not specified, the
Escape key's behaviour is unchanged.
- DefaultConsoleLevel <N> (requires UseTuxOnIce
- 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
- If specified, sets an upper limit on the size of the
hibernation image written (in megabytes). If set to "nocache",
caches and buffers will not be saved - resulting in a faster hibernation
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 UseTuxOnIce
- Deprecated since 184.108.40.206 (hence won't do anything if set).
Limit the number of I/O operations that TuxOnIce 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.
- SuspendDevice <device> (requires UseTuxOnIce
- If specified, sets the hibernation device by writing to the
resume entry in . This does not automatically set the resuming device -
you will need to make sure your bootloader or initrd script does
- FilewriterLocation <filename> <size in
MB> (requires UseTuxOnIce on)
- This option sets up the given filename to act as a
destination file for writing the hibernation 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 TuxOnIce.
- VerifyFilewriterResume2 <boolean> (requires
- When this option is on, you will be prompted if your
current kernel command-line does not match the correct resume for the
filewriter. This option is on by default.
- LoadSuspendModules <module name> [...]
(requires UseTuxOnIce on)
- Loads the given modules before even detecting TuxOnIce.
This may be required when TuxOnIce is compiled as modules that need to be
loaded prior to hibernating.
- UnloadSuspendModulesAfterResume <boolean>
(requires UseTuxOnIce on)
- If yes, will unload the TuxOnIce modules mentioned above
- PowerdownMethod <0|3|4|5> (requires
- Allows you to choose what TuxOnIce should do after writing
its image to disk. 3/4/5 will only work if you have ACPI enabled in your
kernel. 3/4/5 correspond to the ACPI states S3 (suspend-to-RAM), S4
(hibernate-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
hibernating (traditional method) but might still cause your machine to
resume when you open the lid. 0 bypasses ACPI and shuts off the machine
- Compressor none|<compressor name> (requires
- 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 TuxOnIce.1.9.5 or newer).
- Encryptor none|<encryptor name> (requires
- 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
TuxOnIce.1.9.5 or newer).
- ProcSetting <entry name> <value>
(requires UseTuxOnIce on)
- Sets the value of /<entry_name> to <value> upon
hibernating. 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.
- USuspendMethod <disk|ram|both>
- Enables use of the uswsusp suspend method of newer kernels
- USuspendRamForce <boolean>
- Passes the -f flag to s2ram to force suspending even if the
machine is not recognised
- USuspendRamUnsureOk <boolean>
- Instructs s2ram to continue when it's unsure about the
system type, thus not requiring -f to be passed
- USuspendRamVbeSave <boolean>
- Passes the -s flag to s2ram to save VBE state before
suspending and restore after resume
- USuspendRamVbePost <boolean>
- Passes the -p flag to s2ram to VBE POST the graphics card
- USuspendRamVbeMode <boolean>
- Passes the -m flag to s2ram to get VBE mode before suspend
and set it after resume
- USuspendRamRadeontool <boolean>
- Passes the -r flag to s2ram to let radeontool turn of the
backlight before suspending.
- USuspendRamAcpiSleep <number>
- Passes the -a flag to s2ram to set the acpi_sleep parameter
before suspend: 1=s3_bios, 2=s3_mode, 3=both
- USuspendRamPciSave <boolean>
- Passes the -v flag to s2ram to have the PCI config space of
the VGA card before suspend, and restore it on resume
- EnableVbetool <boolean>
- Save and restore video state using vbetool before and after
- 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.
- EnableVideoDump <boolean>
- Dump and load video card memory before and after
- SuspendVirtualbox <boolean>
- This will run "VBoxManage controlvm <VM>
savestate" for each running VM and restore state on resume.
- EnableWICDReconnect <boolean>
- Disconnect and reconnect WICD before and after
- 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.
- SwitchToTextModeOnResume <boolean>
- Use this to, on resume, switch to a text console and back.
Some X drivers need this to properly resume.
- 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.
- DummyXServerConfig <filename>
- When using a dummy X server, use /etc/X11/<filename>
as its configuration.
- XStatus <gnome|kde|x>
- Enables progress display and error reporting for the given
- XmessageDisable <boolean>
- Disable display of xmessage dialogs if XStatus is set to
- 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:
--colour=Green --shadow 1 --pos bottom --align center --offset
- Contains options which influence the hibernate script's
This manual page was written by Cameron Patrick
The information about various options was automatically generated from the
hibernate script itself.