summaryrefslogtreecommitdiff
path: root/pm/HOWTO.hooks
diff options
context:
space:
mode:
authorVictor Lowther <victor.lowther@gmail.com>2008-03-03 18:28:17 -0600
committerVictor Lowther <victor.lowther@gmail.com>2008-03-03 18:28:17 -0600
commitbf4f3e0cce274f95e76d88fed3e337d87822e363 (patch)
tree273b064abff7a750028733c9dbd284dd6bb6668c /pm/HOWTO.hooks
parent053da7a5efd23b23527d073c0e63785211c4c954 (diff)
Updated the HOWTO.hooks to document the help parameter.
Also added a section dealing with suspend_hybrid.
Diffstat (limited to 'pm/HOWTO.hooks')
-rw-r--r--pm/HOWTO.hooks7
1 files changed, 7 insertions, 0 deletions
diff --git a/pm/HOWTO.hooks b/pm/HOWTO.hooks
index 43fe40d..0ce10de 100644
--- a/pm/HOWTO.hooks
+++ b/pm/HOWTO.hooks
@@ -6,12 +6,19 @@ A pm-utils hook is simply an executable file that accepts a single parameter.
For hooks in sleep.d, the potential values of that parameter are:
suspend -- The hook MUST perform whatever action is appropriate when the
system is preparing for S3 sleep (or its equivalent).
+suspend_hybrid -- The hook MUST perform whatever action is appropriate
+ when entering suspend mode. The hook SHOULD also save
+ any state it may need to bring the system back from
+ hibernate mode.
resume -- The hook MUST perform whatever action is appropriate when the
system is coming out of suspend.
hibernate -- The hook MUST perform whatever action is appropriate when
the system is preparing for suspend-to-disk.
thaw -- The hook MUST perform whatever action is appropriate when the system
is coming out of suspend-to-disk.
+help -- If your hook parses the PM_CMDLINE environment variable for switches,
+ this function SHOULD output text describing the parameters it parses
+ in a format easily understandable by an end-user.
For hooks in power.d, the potential values of that parameter are:
true -- the hook MUST perform whatever action is appropriate when the system