From 226914884fba883682fa60a40bebb3873ecde927 Mon Sep 17 00:00:00 2001
From: Victor Lowther <victor.lowther@gmail.com>
Date: Sun, 5 Oct 2008 17:41:35 -0500
Subject: Document --auto-quirks and --save-quirks-as-fdi in the pm-action man
 page.

---
 man/pm-action.xml | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

(limited to 'man/pm-action.xml')

diff --git a/man/pm-action.xml b/man/pm-action.xml
index 2d5bcd5..f1ec7a5 100644
--- a/man/pm-action.xml
+++ b/man/pm-action.xml
@@ -170,11 +170,26 @@
       <command>pm-suspend-hybrid</command> commands you can select which
       quirks should be used.
     </para>
-
+    <para>
+	    If <command>pm-suspend</command>, <command>pm-hibernate</command>,
+	    or <command>pm-suspend-hybrid</command> is invoked without any
+	    commandline parameters, they will try to grab the correct quirks
+	    from HAL if it is installed.
+    </para>
     <variablelist>
       <!-- Use the variablelist.term.separator and the
 	   variablelist.term.break.after parameters to
 	   control the term elements. -->
+      <varlistentry>
+	<term><option>--auto-quirks</option></term>
+	<listitem>
+          <para>
+            This option will try to grab the correct quirks for this system
+	    from HAL.  If HAL is not present on the system and this parameter
+	    is passed, suspending or hibernating the system will fail.
+          </para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
 	<term><option>--quirk-dpms-on</option></term>
 	<listitem>
@@ -278,6 +293,23 @@
           </para>
         </listitem>
       </varlistentry>
+       <varlistentry>
+        <term><option>--save-quirks-as-fdi</option></term>
+        <listitem>
+          <para>
+		  Save the quirks passed to <command>pm-suspend</command> or 
+		  <command>pm-suspend-hybrid</command> as an .fdi file that 
+		  is specific to this system.  The file will be saved in 
+		  <filename>/etc/hal/fdi/information/99local-pm-utils-quirks.fdi</filename>.
+		  This parameter will only save the actual quirks that were 
+		  used to sucessfully suspend/resume a system -- if you are 
+		  running proprietary video drivers or kernel modesetting 
+		  video drivers, you will generate a potentially incorrect 
+		  .fdi file.
+          </para>
+        </listitem>
+      </varlistentry>
+
     </variablelist>
   </refsect1>
 
-- 
cgit v1.2.3


From 1fe13fe144d26cf827cc06b2ba164541cd4e29e9 Mon Sep 17 00:00:00 2001
From: Victor Lowther <victor.lowther@gmail.com>
Date: Sun, 5 Oct 2008 18:39:13 -0500
Subject: Document hook ordering convention in the pm-action man page.

---
 man/pm-action.xml | 47 ++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 44 insertions(+), 3 deletions(-)

(limited to 'man/pm-action.xml')

diff --git a/man/pm-action.xml b/man/pm-action.xml
index f1ec7a5..e1fa4bf 100644
--- a/man/pm-action.xml
+++ b/man/pm-action.xml
@@ -349,9 +349,9 @@
 	    directory by putting a non-executable file in 
 	    /etc/pm/sleep.d, or by adding it to the HOOK_BLACKLIST 
 	    configuration variable.
-	  </para>
-	</listitem>
-      </varlistentry>
+         </para>
+       </listitem>
+     </varlistentry>
       <varlistentry>
 	<term><filename>/var/log/pm-suspend.log</filename></term>
 	<listitem>
@@ -362,6 +362,47 @@
 	</listitem>
       </varlistentry>
     </variablelist>
+    </refsect1>
+    <refsect1 id="sleep_hook_ordering_convention">
+       <title>SLEEP HOOK ORDERING CONVENTION</title>
+       <variablelist>
+         <varlistentry>
+	   <term>00 - 49</term>
+	   <listitem>
+	     <para>User and most package supplied hooks.  If a hook assumes 
+		     that all of the usual services and userspace 
+		      infrastructure is still running, it should be here.
+	     </para>
+	   </listitem>
+	 </varlistentry>
+	 <varlistentry>
+	   <term>50 - 74</term>
+	   <listitem>
+	     <para> Service handling hooks.  Hooks that start or stop a 
+			 service belong in this range. At or before 50, hooks 
+			 can assume that all services are still enabled.
+             </para>
+            </listitem>
+	   </varlistentry>
+	       <varlistentry>
+	         <term>75 - 89</term>
+		 <listitem>
+		   <para> Module and non-core hardware handling.  If a hook 
+			 needs to load/unload a module, or if it needs to 
+			 place non-video hardware that would otherwise break 
+			 suspend or hibernate into a safe state, it belongs in 
+			 this range. At or before 75, hooks can assume all 
+			 modules are still loaded.
+ 	           </para>
+                 </listitem>
+	       </varlistentry>
+	       <varlistentry>
+	         <term>90 - 99</term>
+		 <listitem>
+		   <para> Reserved for critical suspend hooks. </para>
+	         </listitem>
+               </varlistentry>
+             </variablelist>
   </refsect1>
 
   <refsect1 id="config_vars">
-- 
cgit v1.2.3


From 78a6575ae849858eb822655dd363887cfd8a8162 Mon Sep 17 00:00:00 2001
From: Victor Lowther <victor.lowther@gmail.com>
Date: Sun, 5 Oct 2008 18:42:00 -0500
Subject: Document sleep module fallback behaviour in pm-action man page.

---
 man/pm-action.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'man/pm-action.xml')

diff --git a/man/pm-action.xml b/man/pm-action.xml
index e1fa4bf..40e3376 100644
--- a/man/pm-action.xml
+++ b/man/pm-action.xml
@@ -424,7 +424,8 @@
                 <listitem>
                   <para>
                     The built-in kernel suspend/resume support.
-                    Use this if nothing else is supported on your system.
+		    Use this if nothing else is supported on your system.
+		    The kernel backend is always used if nothing else is available.
                 </para>
                 </listitem>
               </varlistentry>
-- 
cgit v1.2.3


From 8125023126e165ecbe5bd01495ac30bfd94273b6 Mon Sep 17 00:00:00 2001
From: Victor Lowther <victor.lowther@gmail.com>
Date: Sun, 5 Oct 2008 19:17:08 -0500
Subject: --store-quirks-as-fdi, not --save-quirks-as-fdi

---
 man/pm-action.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'man/pm-action.xml')

diff --git a/man/pm-action.xml b/man/pm-action.xml
index 40e3376..964676f 100644
--- a/man/pm-action.xml
+++ b/man/pm-action.xml
@@ -294,7 +294,7 @@
         </listitem>
       </varlistentry>
        <varlistentry>
-        <term><option>--save-quirks-as-fdi</option></term>
+        <term><option>--store-quirks-as-fdi</option></term>
         <listitem>
           <para>
 		  Save the quirks passed to <command>pm-suspend</command> or 
-- 
cgit v1.2.3