NetBSD/share/man/man9/dopowerhooks.9

61 lines
2.2 KiB
Groff

.\" $NetBSD: dopowerhooks.9,v 1.6 2010/04/05 19:31:29 joerg Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Lennart Augustsson.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd February 11, 2010
.Dt DOPOWERHOOKS 9
.Os
.Sh NAME
.Nm dopowerhooks
.Nd run all power hooks
.Sh SYNOPSIS
.Ft void
.Fn dopowerhooks "int why"
.Sh DESCRIPTION
.Em The
.Nm
.Em routine is deprecated.
.Em Use
.Xr pmf_system_suspend 9
.Em instead.
.Pp
The
.Fn dopowerhooks
function invokes all power hooks established using the
.Xr powerhook_establish 9
function.
When power is disappearing the power hooks are called in
reverse order, i.e., the power hook established last will be called first.
When power is restored they are called normal order.
.Pp
This function is called from the
.Xr apm 4
driver when a power change is detected.
.Sh SEE ALSO
.Xr powerhook_establish 9