1PM-ACTION(8) pm-utils User Manual PM-ACTION(8)
2
6 pm-action - Suspend or Hibernate your computer
7
9 pm-hibernate [--help]
10 pm-suspend [--quirk-*--help]
12 pm-suspend-hybrid [--quirk-*--help]
14
16 This manual page documents briefly the pm-action, pm-hibernate,
17 pm-suspend and pm-suspend-hybrid commands. This manual page was
18 originally written for the Debian(TM) distribution and has been adopted
19 by the pm-utils project.
20 These commands can be used to put the machine in a sleep state. The
22 precise way how this is done can be influenced by installing
23 executables and configuration snippets. For some options external
24 programs are needed.
25 These commands will usually be called by hald when triggered to do so
27 by a program in a desktop session such as gnome-power-manager. Calling
28 them from the command line is also possible, but it is not guaranteed
29 that all programs in your desktop session keep working as expected.
30 pm-suspend
32 During suspend most devices are shutdown, and system state is saved
33 in RAM. The system still requires power in this state. Most modern
34 systems require 3 to 5 seconds to enter and leave suspend, and most
35 laptops can stay in suspend mode for 1 to 3 days before exhausting
36 their battery.
37 pm-hibernate
39 During hibernate the system is fully powered off, and system state
40 is saved to disk. The system does not require power, and can stay
41 in hibernate mode indefinitely. Most modern systems require 15 to
42 45 seconds to enter and leave hibernate, and entering and leaving
43 hibernate takes longer when you have more memory.
44 pm-suspend-hybrid
46 Hybrid-suspend is the process where the system does everything it
47 needs to hibernate, suspends instead of shutting down. This means
48 that your computer can wake up quicker than for normal hibernation
49 if you do not run out of power, and you can resume even if you run
50 out of power. s2both(8) is an hybrid-suspend implementation.
51
53 Om most hardware putting the video card in the suspend state and
54 recovering from it needs some special quirk handling. With the
55 --quirk-* options of the pm-suspend and pm-suspend-hybrid commands you
56 can select which quirks should be used.
57 If pm-suspend, pm-hibernate, or pm-suspend-hybrid is invoked without
59 any commandline parameters, they will try to grab the correct quirks
60 from HAL if it is installed.
61 --auto-quirks
63 This option will try to grab the correct quirks for this system
64 from HAL. If HAL is not present on the system and this parameter is
65 passed, suspending or hibernating the system will fail.
66 --quirk-dpms-on
68 This option forces the video hardware to turn on the screen during
69 resume. Most video adapters turn on the screen themselves, but if
70 you get a blank screen on resume that can be turned back on by
71 moving the mouse or typing then this option may be useful.
72 --quirk-dpms-suspend
74 This option forces the video hardware to turn off the screen when
75 suspending. Most video adapters seem to do this correctly, but some
76 do not, which wastes lits of power. If your screen is still on
77 after successfully suspending you may need to use this option.
78 --quirk-radeon-off
80 This option forces Radeon hardware to turn off the display during
81 suspend and turn it back on during resume. You only need to do this
82 on some old ThinkPads of the ´30 series (T30, X31, R32,... ) with
83 Radeon video hardware.
84 --quirk-s3-bios
86 This option calls the video BIOS during S3 resume. Unfortunately,
87 it is not always allowed to call the video BIOS at this point, so
88 sometimes adding this option can actually break resume on some
89 systems.
90 --quirk-s3-mode
92 This option initializes the video card into a VGA text mode, and
93 then uses the BIOS to set the video mode. On some systems S3 BIOS
94 only initializes the video bios to text mode, and so both S3 BIOS
95 and S3 MODE are needed.
96 --quirk-vbe-post
98 This option will attempt to reinitialize the video card when
99 resuming from suspend, using the same code the system BIOS uses at
100 boot in order to initialize the video hardware. Not all video cards
101 need this, and using this option on systems where it is not needed
102 can cause a system to lock up when resuming.
103 --quirk-vbemode-restore
105 This option will save and restore the current VESA mode which may
106 be necessary to avoid X screen corruption. Using this feature on
107 Intel graphics hardware is probably a bad idea.
108 --quirk-vbestate-restore
110 This option saves and restores some low level hardware state which
111 may be invalid after suspend.
112 --quirk-vga-mode3
114 This option will try to force the video card into a standard text
115 mode on resume.
116 --quirk-save-pci
118 Save the PCI config space for the VGA card.
119 --store-quirks-as-fdi
121 Save the quirks passed to pm-suspend or pm-suspend-hybrid as an
122 .fdi file that is specific to this system. The file will be saved
123 in /etc/hal/fdi/information/99local-pm-utils-quirks.fdi. This
124 parameter will only save the actual quirks that were used to
125 sucessfully suspend/resume a system -- if you are running
126 proprietary video drivers or kernel modesetting video drivers, you
127 will generate a potentially incorrect .fdi file.
128
130 /etc/pm/config.d
131 The files in this directory are evaluated in C sort order. These
132 files can be provided by individual packages outside of pm-utils.
133 If a global configuration variable is set, the value set to will be
134 appended to the previous value. If any other variable is set, it
135 will be ignored. The syntax is simply: VAR_NAME = value. See the
136 CONFIGURATION VARIABLES section for valid variables defined by
137 pm-utils. External packages can define others, see their respective
138 documentation for more information.
139 /etc/pm/sleep.d, /usr/lib/pm-utils/sleep.d
141 Programs in these directories (we call them hooks) are combined and
142 executed in C sort order before suspend and hibernate with as
143 argument ´suspend´ or ´hibernate´. Afterwards they are called in
144 reverse order with argument ´resume´ and ´thaw´ respectively. If
145 both directories contain a similar named file, the one in
146 /etc/pm/sleep.d will get preference. It is possible to disable a
147 hook in the distribution directory by putting a non-executable file
148 in /etc/pm/sleep.d, or by adding it to the HOOK_BLACKLIST
149 configuration variable.
150 /var/log/pm-suspend.log
152 The log file shows what was done on the last suspend/hibernate and
153 resume/thaw.
154
156 00 - 49
157 User and most package supplied hooks. If a hook assumes that all of
158 the usual services and userspace infrastructure is still running,
159 it should be here.
160 50 - 74
162 Service handling hooks. Hooks that start or stop a service belong
163 in this range. At or before 50, hooks can assume that all services
164 are still enabled.
165 75 - 89
167 Module and non-core hardware handling. If a hook needs to
168 load/unload a module, or if it needs to place non-video hardware
169 that would otherwise break suspend or hibernate into a safe state,
170 it belongs in this range. At or before 75, hooks can assume all
171 modules are still loaded.
172 90 - 99
174 Reserved for critical suspend hooks.
175
177 Configuration variables defined by pm-utils. These can be set in any
178 file in /etc/pm/config.d
179 SLEEP_MODULE [=kernel]
181 The default suspend backend to use. Valid values are:
182 kernel
184 The built-in kernel suspend/resume support. Use this if nothing
185 else is supported on your system. The kernel backend is always
186 used if nothing else is available.
187 uswsusp
189 If your system has support for the userspace suspend programs
190 (s2ram/s2disk/s2both), then use this.
191 tuxonice
193 If your system has support for tuxonice/suspend2, use this.
194 HIBERNATE_RESUME_POST_VIDEO [=no]
197 If video should be posted after hibernate, just like after suspend.
198 You should not normally need to set this.
199 SUSPEND_MODULES
201 Space separated list of modules to unload before suspend.
202 HOOK_BLACKLIST
204 Space separated list of hooks that should be disabled.
205 HIBERNATE_MODE
207 Default method to power down the system when hibernating. If not
208 set, the system will use the kernel default as a default value.
209 Check /sys/power/disk for valid values. The default value will be
210 surrounded by [square brackets].
211 NEED_CLOCK_SYNC
213 If your system clock drifts across a suspend/resume or
214 hiberante/thaw cycle, you should set this to true. This will cause
215 pm-utils to synchronize the system clock whenever we go through a
216 sleep/wake cycle at the expense of making suspend/resume take
217 longer.
218
220 The upstream BTS can be found at https://bugs.freedesktop.org/. Select
221 ´pm-utils´ as product.
222
224 s2ram(8), s2disk(8), s2both(8), pm-is-supported(1), pm-powersave(8),
225 vbetool(8), radeontool(8)
226
228 Tim Dijkstra <tim@famdijkstra.org>
229 Manpage author.
230
232 Copyright © 2007 Tim Dijkstra
233 This manual page was originally written for the Debian(TM) system, and
235 has been adopted by the pm-utils project.
236 Permission is granted to copy, distribute and/or modify this document
238 under the terms of the GNU General Public License, Version 2 or (at
239 your option) any later version published by the Free Software
240 Foundation.
241pm-action Apr 25, 2007 PM-ACTION(8)