aboutsummaryrefslogtreecommitdiff
path: root/man/rc_plugin_hook.3
diff options
context:
space:
mode:
authorRoy Marples <roy@marples.name>2007-12-24 22:03:27 +0000
committerRoy Marples <roy@marples.name>2007-12-24 22:03:27 +0000
commit5741ad634d778df45d802aa3ee1de5bee178f138 (patch)
treea79922fad6a955220b11d815372b333f721465f6 /man/rc_plugin_hook.3
parent7de72229a55300a7a22bfe4a4da43207f3fe475f (diff)
Add man pages for all librc functions.
Diffstat (limited to 'man/rc_plugin_hook.3')
-rw-r--r--man/rc_plugin_hook.351
1 files changed, 51 insertions, 0 deletions
diff --git a/man/rc_plugin_hook.3 b/man/rc_plugin_hook.3
new file mode 100644
index 00000000..0600b697
--- /dev/null
+++ b/man/rc_plugin_hook.3
@@ -0,0 +1,51 @@
+.\" Copyright 2007 Roy Marples
+.\" 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 AUTHOR 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 AUTHOR 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 Dec 24, 2007
+.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_t 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 environemnt by writing NULL separated strings to
+.Va rc_environ_fd .
+.Sh SEE ALSO
+.Xr rc 8 ,
+.Xr runscript 8
+.Sh AUTHORS
+.An "Roy Marples" Aq roy@marples.name