Clarify how ACPI unhibernate works, as well as expand a bit on visual

feedback that may be presented to the user during unhibernate/resume.

suggested by espie@

1 files changed, 22 insertions, 3 deletions

diff --git a/usr.sbin/apm/apm.8 b/usr.sbin/apm/apm.8
index d2756633522..286f42f9c5c 100644
--- a/usr.sbin/apm/apm.8
+++ b/usr.sbin/apm/apm.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: apm.8,v 1.41 2015/01/28 05:10:44 tedu Exp $
+.\"	$OpenBSD: apm.8,v 1.42 2015/08/04 07:24:31 mlarkin Exp $
 .\"
 .\" Copyright (c) 1996 John T. Kohl
 .\" All rights reserved.
@@ -26,7 +26,7 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: January 28 2015 $
+.Dd $Mdocdate: August 4 2015 $
 .Dt APM 8
 .Os
 .Sh NAME
@@ -94,7 +94,13 @@ Request more verbose description of the displayed states.
 .It Fl Z
 Put the system into hibernation.
 System memory is saved to disk (swap space)
-and the machine is powered down.
+and the machine is powered down. For machines supporting the
+.Xr acpi 4 
+style hibernate functionality, on resume a full kernel
+boot will occur, followed by the reading of the saved
+memory image. The image will then be unpacked and the system
+resumed at the point immediately after the hibernation
+request.
 .It Fl z
 Put the system into suspend (deep sleep) state.
 .El
@@ -113,6 +119,19 @@ The command line flags serve the same purpose as for
 These commands do not wait for positive confirmation that the requested
 state has been entered; to do so would mean the command does not return
 until the system resumes from its sleep state.
+.Pp
+Each system provides methods for waking from suspend or hibernate. For
+those machines supporting
+.Xr acpi 4 
+style suspend/resume (or hibernate/unhibernate) semantics, the wakeup
+devices for each sleep state are printed during system boot in
+.Xr dmesg 8 .
+.Pp
+The system will attempt to provide as much feedback as is possible on
+the specific hardware being suspended/resumed. This includes setting
+system LEDs or other indicators to illustrate progress throughout the
+suspend/resume (or hibernate/unhibernate) process. Such feedback is
+machine-dependent.
 .Sh FILES
 .Bl -tag -width /var/run/apmdev -compact
 .It Pa /var/run/apmdev