d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e334931601
freebsd-dev/share/man/man9/at_shutdown.9

99 lines
3.0 KiB
Groff
Raw Normal View History

Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.\"
.\" Copyright (c) 1996 Julian Elischer
.\"
.\" All rights reserved.
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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.
.\"
Make the long-awaited change from $Id$ to $FreeBSD$ This will make a number of things easier in the future, as well as (finally!) avoiding the Id-smashing problem which has plagued developers for so long. Boy, I'm glad we're not using sup anymore. This update would have been insane otherwise.
1997-01-14 07:20:47 +00:00
.\" $FreeBSD$
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.\" "
.Dd August 15, 1996
.Os
.Dt AT_SHUTDOWN 9
.Sh NAME
.Nm at_shutdown ,
.Nm rm_at_shutdown
.Nd ask that a function be run at shutdown.
.Sh SYNOPSIS
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
.Fd #include <sys/param.h>
Some cleanups to the callout lists recently added. note that at_shutdown has a new parameter to indicate When during a shutdown the callout should be made. also add a RB_POWEROFF flag to reboot "howto" parameter.. tells the reboot code in our at_shutdown module to turn off the UPS and kill the power. bound to be useful eventually on laptops
1996-08-22 03:50:33 +00:00
.Fd #include <sys/systm.h>
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
.Fd #include <sys/reboot.h>
.Ft typedef void \*(lp*bootlist_fn\*(rp\*(lpint howto, void *arg\*(rp
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
.Ft int
Some cleanups to the callout lists recently added. note that at_shutdown has a new parameter to indicate When during a shutdown the callout should be made. also add a RB_POWEROFF flag to reboot "howto" parameter.. tells the reboot code in our at_shutdown module to turn off the UPS and kill the power. bound to be useful eventually on laptops
1996-08-22 03:50:33 +00:00
.Fn at_shutdown "bootlist_fn func" "void *arg" "int when"
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
.Ft int
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Fn rm_at_shutdown "bootlist_fn func" "void *arg"
.Sh DESCRIPTION
The
.Nm at_shutdown
facility allows a kernel module to ensure that it is notified
at system shutdown.
The function
.Ar func
is called with the flags indicating boot type, and the opaque argument
.Ar arg
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
when the system is shut down.
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Pp
If the requirement for notification is removed, then the function
.Nm rm_at_shutdown
must be called with the exact
.Ar func
and
.Ar arg
arguments as the corresponding call to
.Fn at_shutdown .
Some cleanups to the callout lists recently added. note that at_shutdown has a new parameter to indicate When during a shutdown the callout should be made. also add a RB_POWEROFF flag to reboot "howto" parameter.. tells the reboot code in our at_shutdown module to turn off the UPS and kill the power. bound to be useful eventually on laptops
1996-08-22 03:50:33 +00:00
There are two shutdown queues, one run before the final sync and one after.
The last argument to
.Nm at_shutdown
should be one of
.Em SHUTDOWN_PRE_SYNC
or
.Em SHUTDOWN_POST_SYNC
to specify which queue should be used.
.Nm rm_at_shutdown
will remove an entry from either queue.
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Pp
.Sh RETURN VALUES
.Nm at_shutdown
Fixed SYNOPSIS (#includes, return types, arg names and formatting) and a couple of other things.
1996-08-28 16:58:34 +00:00
returns an error code, 0 meaning success.
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Nm rm_at_shutdown
returns the number of items removed (should be 0 or 1).
.Sh SEE ALSO
Xref boot(9).
1997-02-14 07:08:17 +00:00
.Xr reboot 2 ,
.Xr boot 9
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Sh HISTORY
The
Style fix.
1997-02-14 07:07:13 +00:00
.Fn at_shutdown
and
.Fn rm_shutdown
functions
Use the .Fx macro to reference FreeBSD versions in several newer man pages. For those of you that don't know, here is an example of how the .Fx macro is used: The xyzzy command first appeared in .Fx 2.2 . Will expand to: The xyzzy command first appeared in FreeBSD 2.2.
1996-08-21 21:43:28 +00:00
appeared in
.Fx 2.2 .
Add man-pages for at_exit, at_fork and at_shutdown() so that people can look and comment. I'll add the at_fork and at_exit immediatly, but I'll add teh at_shutdown later as it's more extensive and I desire people's comments.. julian
1996-08-19 02:22:15 +00:00
.Sh BUGS
Since the shutdown queue is not sorted
and items are added to the head, order of execution
is reversed to that of insertion.
.Sh AUTHORS
The function was written by
.ie t Julian Elischer (julian@freebsd.org)
.el Julian Elischer (julian@freebsd.org)
Reference in New Issue Copy Permalink