initial commit

man/rc_plugin_hook.3

@@ -0,0 +1,37 @@
+.\" Copyright (c) 2007-2015 The OpenRC Authors.
+.\" See the Authors file at the top-level directory of this distribution and
+.\" https://github.com/OpenRC/openrc/blob/master/AUTHORS
+.\"
+.\" This file is part of OpenRC. It is subject to the license terms in
+.\" the LICENSE file found in the top-level directory of this
+.\" distribution and at https://github.com/OpenRC/openrc/blob/master/LICENSE
+.\" This file may not be copied, modified, propagated, or distributed
+.\"    except according to the terms contained in the LICENSE file.
+.\"
+.Dd Mar 16, 2008
+.Dt RC_PLUGIN_HOOK 3 SMM
+.Os OpenRC
+.Sh NAME
+.Nm rc_plugin_hook
+.Nd hooks plugins into OpenRC services
+.Sh LIBRARY
+Run Command library (librc, -lrc)
+.Sh SYNOPSIS
+.In rc.h
+.Ft int Fn rc_plugin_hook "RC_HOOK hook" "const char *name"
+.Sh DESCRIPTION
+.Fn rc_plugin_hook
+is called for each shareable object found in
+.Pa /lib/rc/plugins .
+.Fa hook
+is set to the hook running, and
+.Fa name
+is set to the name of the runlevel or name of the service.
+.Pp
+Plugins can affect the parent environment by writing NULL separated strings to
+.Va rc_environ_fd .
+.Sh SEE ALSO
+.Xr openrc 8 ,
+.Xr openrc-run 8
+.Sh AUTHORS
+.An Roy Marples <roy@marples.name>