~ubuntu-branches/ubuntu/quantal/pm-utils/quantal-proposed

« back to all changes in this revision

Viewing changes to README

Tags: upstream-1.1.2.2
ImportĀ upstreamĀ versionĀ 1.1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
* Suspend/resume functionality can be easily modified by installing
19
19
  files into the /etc/pm/sleep.d directory.  These files, known as
20
 
  "hooks" can perform specific tasks on suspend/resume, such as:
 
20
  hooks, can perform specific tasks on suspend/resume, such as:
21
21
   
22
22
   - enabling and disabling standby LED's on laptop hardware 
23
23
   - enabling suspend GUI's like suspend2 
28
28
   - setting grub to be the default target for a hibernate-resume 
29
29
   - other wacky things that need doing on specific systems
30
30
 
31
 
How do "hooks" work?
 
31
How do hooks work?
32
32
 
33
33
* You put an executable file in /etc/pm/sleep.d.  When suspend or
34
34
  hibernate is called, several things happen:
44
44
  5) Each of /etc/pm/sleep.d/* are executed in reverse C sort order,
45
45
     with a command line argument of "resume" or "thaw".
46
46
 
47
 
End-user customization and debugging:
48
 
 
49
 
* If a particular hook is causing problems on your system, you can disable it
50
 
  using the HOOK_BLACKLIST environment variable by creating a file in 
51
 
  /etc/pm/config.d and adding the line:
52
 
  HOOK_BLACKLIST="hookname 99another-hook"
53
 
 
54
 
* If a parameter (or lack thereof) passed to pm-suspend and friends is causing
55
 
  problems, or you need to debug the suspend/resume process to work out what 
56
 
  quirks are causing problems, you can use the ADD_PARAMETERS and 
57
 
  DROP_PARAMETERS environment variables.  To do this, create a file in 
58
 
  /etc/pm/config.d, and add the following lines to it:
59
 
  ADD_PARAMETERS="--parameter-to-add --another-parameter"
60
 
  DROP_PARAMETERS="--parameter-to-drop --another-parameter-to-drop"
61
 
 
62
 
  If you want to drop all parameters (for testing purposes, or to work around 
63
 
  bugs in HAL), you can use DROP_PARAMETERS="all"
64
 
 
65
 
* If you suspect that a kernel module is preventing you from being
66
 
  able to suspend and resume, you can use the SUSPEND_MODULES
67
 
  environment variable to have that module removed when the system
68
 
  suspends and reloaded when the system wakes up.
69
 
 
70
 
* To find out what parameters can be passed to pm-suspend and friends, run them
71
 
  with '--help' as the first parameter as root.  This will print out the 
72
 
  options that it supports and which hooks or modules handle those options.
 
47
* For more detailed information on how hooks work and how to write one,
 
48
  read HOWTO.hooks .
 
49
 
 
50
* For information on how to debug pm-utils, read README.debugging.
73
51
 
74
52
  That's it!
75
53