Module Name: src
Committed By: wiz
Date: Sun May 10 12:46:42 UTC 2009
Modified Files:
src/share/man/man9: pmf.9
Log Message:
New sentence, new line. Use Xr for cross-reference.
To generate a diff of this commit:
cvs rdiff -u -r1.8 -r1.9 src/share/man/man9/pmf.9
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man9/pmf.9
diff -u src/share/man/man9/pmf.9:1.8 src/share/man/man9/pmf.9:1.9
--- src/share/man/man9/pmf.9:1.8 Sun May 10 10:56:17 2009
+++ src/share/man/man9/pmf.9 Sun May 10 12:46:41 2009
@@ -1,4 +1,4 @@
-.\" $NetBSD: pmf.9,v 1.8 2009/05/10 10:56:17 tsutsui Exp $
+.\" $NetBSD: pmf.9,v 1.9 2009/05/10 12:46:41 wiz Exp $
.\"
.\" Copyright (c) 2007 Jared D. McNeill <[email protected]>
.\" All rights reserved.
@@ -137,15 +137,17 @@
.Sh FUNCTIONS
.Bl -tag -width compact
.It Fn pmf_device_register "dev" "suspend" "resume"
-Register a device with the power management framework. If either
+Register a device with the power management framework.
+If either
.Fa suspend
or
.Fa resume
is
.Dv NULL
then it is assumed that device state does not need to be captured and
-resumed on a power transition. Bus and class-level power management
-will still be performed. Returns
+resumed on a power transition.
+Bus and class-level power management will still be performed.
+Returns
.Dv false
if there was an error.
.It Fn pmf_device_register1 "dev" "suspend" "resume" "shutdown"
@@ -186,20 +188,24 @@
Register a device with the power management framework as a display-class
device.
.It Fn pmf_system_suspend "void"
-Suspend all attached devices. Devices are suspended by traversing the
+Suspend all attached devices.
+Devices are suspended by traversing the
autoconfiguration tree beginning with the leaf nodes.
This function will fail if any attached drivers do not support the power
management framework.
.It Fn pmf_system_resume "void"
-Resume all attached devices. Devices are resumed by traversing the
+Resume all attached devices.
+Devices are resumed by traversing the
autoconfiguration tree beginning with devices that do not have a parent.
This function will fail if any attached drivers do not support the power
management framework.
.It Fn pmf_system_shutdown "int"
-Shutdown all attached devices. Devices are shut down by traversing the
+Shutdown all attached devices.
+Devices are shut down by traversing the
autoconfiguration tree beginning with the leaf nodes.
The integer argument is passed to the driver shutdown functions.
-It should contain the reboot(2)
+It should contain the
+.Xr reboot 2
.Dq howto
argument.
This function ignores the presence of attached drivers that do not support the
@@ -209,7 +215,8 @@
.Fa handler
to be called whenever an
.Fa ev
-event is triggered. If
+event is triggered.
+If
.Fa global
is
.Dv true ,
@@ -220,7 +227,8 @@
Deregister the callback previously registered with
.Fn pmf_event_register .
.It Fn pmf_event_inject "dev" "ev"
-Inject an inter-driver message into the message queue. If
+Inject an inter-driver message into the message queue.
+If
.Fa dev
is
.Dv NULL ,
@@ -233,7 +241,8 @@
.It Fn pmf_get_platform "key"
Retrieve the value for
.Fa key
-from the platform information database. Returns
+from the platform information database.
+Returns
.Dv NULL
if the key is not present.
.El
