Difference between revisions of "TuxOnIce"

From ArchWiki
Jump to: navigation, search
m (TuxOnIce is not laptop specific.)
(29 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Power management]]
#REDIRECT: [[ArchWiki:Archive]]
{{Article summary start}}
{{Article summary text|Describes installing, configuring and using TuxOnIce, an advanced suspend/hibernate framework.}}
{{Article summary heading|Related}}
{{Article summary wiki|Suspending to RAM with hibernate-script}}
{{Article summary wiki|Suspending to Disk with hibernate-script}}
{{Article summary wiki|Pm-utils}}
{{Article summary wiki|Uswsusp}}
{{Article summary end}}
This is a quick start guide for installing [http://www.tuxonice.net TuxOnIce] (formerly suspend2), an advanced suspend/hibernate framework which supports suspending to a swap-disk or a regular file with fast LZO-compression. Visit the TuxOnIce website for a full list of [http://www.tuxonice.net/features features].
==Preparing the kernel==
TuxOnIce consists of a kernel patch, plus an optional user interface. Only the kernel patch is necessary, the user interface merely provides a graphical interface displayed during the hibernation/resume cycle.
You can use the {{AUR|linux-ice}} or the [[linux-pf]] packages available in the [[Arch User Repository]]. They automate all the patch routines, the compilation and installation of the kernel, and the regeneration of the initramfs with an appropriate hook. You maintain control over the install process, and its easy to make changes if you want to repeat the process. More detailed information at installing [[linux-pf]] and configuring it with TuxOnIce can be found at its wiki page.
Otherwise, you need to patch, configure and compile your own kernel, visit [[Kernel Compilation From Source]] and [[Kernel Compilation with ABS]] for instructions. The required patch can be obtained from the TuxOnIce website mentioned above.
Next, install the {{AUR|hibernate-script}} package from the [[AUR]] which we will use to call TuxOnIce. Hibernate-script is the default script developed by the TuxOnIce development team.
The configuration files for hibernate-script are in {{Ic|/etc/hibernate}}, we will get back to them shortly.
==Recreating the initramfs==
If you use an initramfs (default Arch systems do), you must add the resume hook in the HOOKS in the configuration of [[mkinitcpio]]. Additionally, if you want to speed things up by using LZO compression, add the lzo module to the MODULES array in the same file.
{{Ic|/etc/mkinitcpio.conf}} example:
HOOKS="base udev autodetect pata scsi sata resume filesystems"
(for [[linux-pf]] you also need tuxonice_compress, tuxonice_swap and optionally tuxonice_userui in MODULES)
Rebuild the initramfs:
# mkinitcpio -p linux-ice
# mkinitcpio -p linux-pf
==Setting up the bootloader==
Before your can use the suspend function, you need to add the {{Ic|resume}} parameter in your bootloader (unless you have hard-coded your swap partition during the kernel configuration). The resume parameter points to the swap partition or swap file, below are the steps involved for both methods.
===Suspend to swap partition===
{{Note|As of the latest version of TuxOnIce (, adding the kernel resume parameter is no longer necessary, it will auto-detect if your swap drive contains a bootable image. You only need to set the swap method appropriately. For more details, check out [http://www.tuxonice.net/].}}
Set the swap method (make sure the right partition is indicated) in {{Ic|/etc/hibernate/tuxonice.conf}}:
SuspendDevice swap:/dev/sda3
===Suspend to swap file===
{{Note|Auto-detection as mentioned previously doesn't seem to work with swap files, you will still need to manually set the kernel resume parameter.}}
{{Note|The BTRFS filesystem does not currently support swapfiles.}}
If you use a swap file instead of a swap partition, you will need to pass the location of its header to TuxOnIce. TuxOnIce can list all available swap headers.
cat /sys/power/tuxonice/swap/headerlocations
Use the given string as-is in both {{Ic|/etc/hibernate/tuxonice.conf}} and passed to your kernel as a resume parameter.
SuspendDevice swap:/dev/sda7:0x1087070
Append the following to your kernel parameters in your bootloader's configuration file:
{{Note|Specifying the resume device by UUID is supposed to work, but I was not able to get it to work. This may be a TuxOnIce or a mkinitcpio issue, YMMV. Specifying {{Ic|/dev/sd'''xx'''}} should work in all cases though.}}
===Suspend to file===
For the file allocator, you will have to prepare a hibernation file. This is different from the standard swap file in that this file is ONLY used for hibernation and not as a general system swap file. The previous method is recommended as being more efficient in terms of disk space. First configure the {{Ic|/etc/hibernate/tuxonice.conf}} file, uncomment the "FilewriterLocation" option:
FilewriterLocation /suspend_file 1000
1000 is the amount of disk space reserved for the hibernation file, in this case 1000 megabytes. Usually an amount of 50% - 75% of your total amount of RAM will suffice.
Next, we need to create the file, something like [http://en.gentoo-wiki.com/wiki/TuxOnIce#Alternative:_Using_a_Dedicated_File]:
# echo TuxOnIce > /suspend_file
# dd if=/dev/zero bs=1M count=1000 >> /suspend_file
# echo /suspend_file > /sys/power/tuxonice/file/target
# cat /sys/power/tuxonice/resume
The output of {{Ic|/sys/power/tuxonice/resume}} is what you need to pass to your kernel. You should see something like {{Ic|file:/dev/sda2:0xdc008}}, in which case you should append {{Ic|1=resume=file:/dev/sda2:0xdc008}} as a kernel parameter in your {{Ic|/etc/[[lilo]].conf}} file (for [[LILO]]), {{Ic|/boot/syslinux/syslinux.cfg}} (for syslinux) or {{Ic|/boot/grub/grub.cfg}} (for [[Grub2]]).
==Suspending and resuming==
With hibernate-script, your preferred hibernation method can be set in the file {{Ic|/etc/hibernate/hibernate.conf}}. If you list several methods, the first one will be used. Note that ''hibernate'' can also be used with [[Suspend to RAM]] or vanilla swsusp, but this is not part of this guide.
For TuxOnIce use:
TryMethod tuxonice.conf
Specific settings for TuxOnIce are in {{Ic|/etc/hibernate/tuxonice.conf}}. Make sure that the following lines are uncommented and appropriately configured:
UseTuxOnIce  yes
Compressor    lzo
There are a number of additional settings and tweaks which you can set in {{Ic|/etc/hibernate/tuxonice.conf}} and {{Ic|/etc/hibernate/common.conf}}, more information about these can be found on the [http://www.tuxonice.net/HOWTO-4.html TuxOnIce] website and on the [[Suspend to Disk]] page of this wiki.
Now try TuxOnIce hibernation with the following method:
# hibernate -F /etc/hibernate/tuxonice.conf
You can abort a suspend cycle if you press the escape key. If you press a capital R, you will force the system to reboot after hibernation.
If all goes well, you should be able to resume using the same GRUB menu selection.  If you make that option the default for GRUB, you will always default to resuming if a resume image is available. It is recommended that you test the suspend/hibernate from a text console first and then once you have confirmed that it works try it from within X.
{{Warning|Never use a different kernel to resume than you used to suspend! If pacman updates your kernel, do not suspend before you have rebooted properly.}}
You can make this practice safer adding the hibernate-cleanup daemon to your DAEMONS array in {{Ic|/etc/rc.conf}}. This script will make sure that any stale image is deleted from your swap partition at boot time. This should make your system safe also in the case that you have chosen the mistaken kernel at the GRUB prompt. The hibernate-cleanup service is included in the hibernate-script package.
==Additional pm-utils setup==
If using [[GNOME]] as your DE, or using any other environment that uses [[pm-utils]] to shutdown and suspend the system, some additional setup is required for TuxOnIce.
Configuration made in {{Ic|/etc/hibernate/hibernate.conf}} is still useful, but some options don't seem to be used by pm-utils. Compression, for example, will default to lzo unless more action is taken.
Editing files under {{Ic|/etc/pm/sleep.d/}} is a good way to make sure wanted settings are used.
To change the compressor used by TuxOnIce, for example, edit {{Ic|/etc/pm/sleep.d/00doit}} and add a line like so:
  case $1 in
  #Possible compressors include lzo, lzf, and none
  ''echo none > /sys/power/tuxonice/compression/algorithm''
Additional lines can be used to change other options, such as the default logging level (found in {{Ic|/sys/power/tuxonice/user_interface/default_console_level}}).
==userui - user interface for TuxOnIce (optional)==
Optionally, you can use a text or graphical ([[Fbsplash]]) interface with a progress bar with TuxOnIce. To do this, install the {{AUR|tuxonice-userui}} package from the AUR.
In {{Ic|/etc/hibernate/tuxonice.conf}}, set the desired user interface:
ProcSetting userui_program "/usr/sbin/tuxoniceui"      # Text interface
ProcSetting userui_program "/usr/sbin/tuxoniceui -f"  # Graphical fbsplash interface
The fbsplash interface also needs a symlink to the fbsplash theme, like so:
# ln -s /etc/splash/arch-banner-noicons/ /etc/splash/tuxonice
Without this symlink, there will be no progress indicators during suspend/resume.
It is probably necessary to regenerate the initramfs after changing the symlink above.
The text interface may be good for debugging TuxOnIce, as it displays some messages.
You won't see a user interface for the first few seconds of the resume process unless you add the '''userui''' hook to your mkinitcpio (before the '''resume''' hook) configuration and regenerate your initramfs, but this is also optional.
Generate initramfs:
# mkinitcpio -p linux-ice
To test if userui works, switch to a text console and run:
# tuxoniceui --test
For the graphical interface run:
# tuxoniceui -f --test
*The [http://www.tuxonice.net TuxOnIce website] and [http://wiki.tuxonice.net/ TuxOnIce wiki] are excellent sources of documentation.
*More general information about suspend/hibernate with hibernate-script can be found on the [[Suspend to Disk]] page of this wiki. This also covers some advanced topics like problems with specific hardware and configurations.
*Another good source of information is the [http://en.gentoo-wiki.com/wiki/TuxOnIce Gentoo wiki]

Latest revision as of 19:27, 15 November 2017

Redirect to: