summaryrefslogtreecommitdiff
path: root/README
blob: e6b6aee9e55b39368ae68058e4fb050aaa10b808 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
=== pm-utils ===

What is pm-utils?

* Provides simple shell command line tools to suspend and hibernate computer
that can be used to run vendor or distro supplied scripts on suspend and resume.

Why do we need it?

* As all the main distros are re-implimenting the same thing, over and over, to
do something that's really quite trivial.
Having the common locations for stuff means that software and hardware vendors
can just install one file to do the clever stuff.

* Distros can easily add/remove functionality by installing/removing one
file into the hooks directory, for example:

- enabling and disabling standby LED's on laptop hardware 
- enabling suspend GUI's like suspend2 
- re-enabling video
- starting and stopping services that can't cope with suspending 
- re-syncing the time with ntp 
- removing and modprobing modules when needed 
- setting grub to be the default target for a hibernate-resume 
- other wacky things that need doing on specific systems

How do "hooks" work?

* You put an executable file in /etc/pm/sleep.d.  When suspend or
  hibernate is called, several things happen:
  
  1) /etc/pm/config.d/* are evaluated in C sort order.  These files can be
     provided by individual packages outside of pm-utils.  If a global config
     variable is set, the value set to will overwrite the previous value.
     If any other variable is set, it will be ignored.
  2) each of /etc/pm/sleep.d/* are executed in C sort order.  The first command
     line argument is "suspend" or "hibernate".  These files may source
     configuration files from /etc/pm/config.d/ on their own in order to pick
     up variables set there that aren't part of the global list.  Note that
     hooks should take care to preserve any global configuration variable
     which _that_ hook will later need to use, as sourcing this config file
     will clobber any such variables.
  3) the system suspends or hibernates.
  4) some event happens to wake the machine up
  5) each of /etc/pm/sleep.d/* are executed in reverse C sort order.  The first
     command line argument is "resume" or "thaw".

End-user customization:

* If a particular hook is causing problems on your system, you can disable it
  using the HOOK_BLACKLIST environment variable.by creating a file in 
  /etc/pm/config.d and adding the line:
  HOOK_BLACKLIST="hookname 99another-hook"
* To find out what parameters can be passed to pm-suspend and friends, run them
  with '--help' as the first parameter as root.  This will print out the 
  options that it supports and which hooks or modules handle those options.
* If a parameter (or lack thereof) passed to pm-suspend and friends is causing
  problems, or you need to debug the suspend/resume process to work out what 
  quirks are causing problems, you can use the ADD_PARAMETERS and 
  DROP_PARAMETERS environment variables.  To do this, create a file in 
  /etc/pm/config.d, and add the following lines to it:
  ADD_PARAMETERS="--parameter-to-add --another-paramater"
  DROP_PARAMETERS="--parameter-to-drop --another-parameter-to-drop"


  That's it!