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

4 files changed, 251 insertions, 1 deletions

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 949534c..7c44090 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,10 +1,14 @@
 #	@(#)Makefile	8.1 (Berkeley) 6/5/93
 
-MAN9=	copy.9 devfs_add_devswf.9 devfs_link.9 fetch.9 intro.9 sleep.9 \
+MAN9=	at_shutdown.9 at_fork.9 at_exit.9 copy.9 devfs_add_devswf.9 \
+	devfs_link.9 fetch.9 intro.9 sleep.9 \
 	store.9 style.9 timeout.9
 
 MLINKS+= copy.9 copyin.9 copy.9 copyout.9 copy.9 copystr.9 copy.9 copyinstr.9
 MLINKS+= fetch.9 fubyte.9 fetch.9 fusword.9 fetch.9 fuswintr.9 fetch.9 fuword.9
+MLINKS+= at_shutdown.9 rm_at_shutdown.9
+MLINKS+= at_exit.9 rm_at_exit.9
+MLINKS+= at_fork.9 rm_at_fork.9
 MLINKS+= sleep.9 tsleep.9 sleep.9 wakeup.9
 MLINKS+= store.9 subyte.9 store.9 susword.9 store.9 suswintr.9 store.9 suword.9
 MLINKS+= timeout.9 untimeout.9
diff --git a/share/man/man9/at_exit.9 b/share/man/man9/at_exit.9
new file mode 100644
index 0000000..a2a70f5
--- /dev/null
+++ b/share/man/man9/at_exit.9
@@ -0,0 +1,79 @@
+.\"
+.\" 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.
+.\"
+.\" $Id: at_exit.9,v 1.1 1996/04/13 16:59:07 joerg Exp $
+.\" "
+.Dd August 15, 1996
+.Os
+.Dt AT_EXIT 9
+.Sh NAME
+.Nm at_exit ,
+.Nm rm_at_exit
+.Nd ask that a function be run at exit.
+.Sh SYNOPSIS
+.Fd #include <sys/systm.h>
+
+.Ft typedef void \*(lp*exitlist_fn\*(rp \*(lpstruct proc *\*(rp;
+
+
+.Ft int
+.Fn at_exit "exitlist_fn func"
+.Ft int
+.Fn rm_at_exit "exitlist_fn func"
+.Sh DESCRIPTION
+The
+.Nm at_exit
+facility allows a kernel module to ensure that it is notified
+at any process exit.
+The function
+.Ar func
+is called with the a pointer to the exiting process's proc structure.
+.Pp
+If the requirement for notification is removed, then the function 
+.Nm rm_at_exit
+must be called with the exact
+.Ar func
+argument as the corresponding call to
+.Fn at_exit .
+.Pp
+.Sh RETURN VALUES
+.Nm at_exit
+returns an errno, 0 meaning success. 
+.Nm rm_at_exit
+returns the number of items removed (should be 0 or 1).
+.Sh SEE ALSO
+.Xr exit 2
+.Sh HISTORY
+The
+.Nm at_exit
+appeared in FreeBSD 2.2
+.Sh BUGS
+Since the exit 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 Julian Elischer  (julian@freebsd.org)
+.el Julian Elischer  (julian@freebsd.org)
diff --git a/share/man/man9/at_fork.9 b/share/man/man9/at_fork.9
new file mode 100644
index 0000000..1c13750
--- /dev/null
+++ b/share/man/man9/at_fork.9
@@ -0,0 +1,83 @@
+.\"
+.\" 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.
+.\"
+.\" $Id: at_fork.9,v 1.1 1996/04/13 16:59:07 joerg Exp $
+.\" "
+.Dd August 15, 1996
+.Os
+.Dt AT_FORK 9
+.Sh NAME
+.Nm at_fork ,
+.Nm rm_at_fork
+.Nd ask that a function be run at fork.
+.Sh SYNOPSIS
+.Fd #include <sys/systm.h>
+
+.Ft typedef void \*(lp*forklist_fn\*(rp \*(lpstruct proc*, struct proc*, int\*(rp;
+
+
+.Ft void
+.Fn at_fork "forklist_fn func"
+.Ft void
+.Fn rm_at_fork "forklist_fn func"
+.Sh DESCRIPTION
+The
+.Nm at_fork
+facility allows a kernel module to ensure that it is notified
+at any process fork.
+The function
+.Ar func
+is called with the a pointer to the forking process's proc structure,
+a pointer to the child's process structure and a flag word,
+as used in
+.Xr rfork 2
+to indicate the type of fork.
+.Pp
+If the requirement for notification is removed, then the function 
+.Nm rm_at_fork
+must be called with the exact
+.Ar func
+argument as the corresponding call to
+.Fn at_fork .
+.Pp
+.Sh RETURN VALUES
+.Nm at_fork
+returns an errno, 0 meaning success. 
+.Nm rm_at_fork
+returns the number of items removed (should be 0 or 1).
+.Sh SEE ALSO
+.Xr fork 2
+.Sh HISTORY
+The
+.Nm at_fork
+appeared in FreeBSD 2.2
+.Sh BUGS
+Since the fork 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 Julian Elischer  (julian@freebsd.org)
+.el Julian Elischer  (julian@freebsd.org)
diff --git a/share/man/man9/at_shutdown.9 b/share/man/man9/at_shutdown.9
new file mode 100644
index 0000000..ee85138
--- /dev/null
+++ b/share/man/man9/at_shutdown.9
@@ -0,0 +1,84 @@
+.\"
+.\" 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.
+.\"
+.\" $Id: at_shutdown.9,v 1.1 1996/04/13 16:59:07 joerg Exp $
+.\" "
+.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
+.Fd #include <sys/systm.h>
+.Fd #include <sys/reboot.h>
+
+.Ft typedef void \*(lp*bootlist_fn\*(rp \*(lpint, void *\*(rp;
+
+
+.Ft void
+.Fn at_shutdown "bootlist_fn func" "void *arg" 
+.Ft void
+.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
+when the system is shut down
+.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 .
+.Pp
+.Sh RETURN VALUES
+.Nm at_shutdown
+returns an errno, 0 meaning success. 
+.Nm rm_at_shutdown
+returns the number of items removed (should be 0 or 1).
+.Sh SEE ALSO
+.Xr reboot 2
+.Sh HISTORY
+The
+.Nm at_shutdown
+appeared in FreeBSD 2.2
+.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)