openrc/man/rc_plugin_hook.3

.\" 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>
Convert OpenRC to a centralized copyright/license structure In the past, OpenRC was a hybrid of a centralized and file-scope license/copyright structure. I followed the instructions from the Software Freedom Law Center [1] to convert to a Centralized structure where possible, for easier future maintenance. [1] https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html 2015-12-04 16:52:19 -06:00			`.\" 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`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.\"`
Convert OpenRC to a centralized copyright/license structure In the past, OpenRC was a hybrid of a centralized and file-scope license/copyright structure. I followed the instructions from the Software Freedom Law Center [1] to convert to a Centralized structure where possible, for easier future maintenance. [1] https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html 2015-12-04 16:52:19 -06:00			`.\" 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.`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.\"`
Remove null terminated char ** lists in favour of RC_STRINGLIST, using TAILQ from queue(3). Refactor code style around the BSD KNF. 2008-03-16 17:00:56 +00:00			`.Dd Mar 16, 2008`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.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`
Remove null terminated char ** lists in favour of RC_STRINGLIST, using TAILQ from queue(3). Refactor code style around the BSD KNF. 2008-03-16 17:00:56 +00:00			`.Ft int Fn rc_plugin_hook "RC_HOOK hook" "const char *name"`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.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`
random spelling fixes Signed-off-by: Mike Frysinger <vapier@gentoo.org> 2010-01-08 03:39:25 -05:00			`Plugins can affect the parent environment by writing NULL separated strings to`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.Va rc_environ_fd .`
			`.Sh SEE ALSO`
Rename the rc binary to openrc Debian requested this rename due to the "rc" binary conflicting with the "rc" binary from the plan 9 shell. We also add a deprecation warning to the binary when it is run as rc to encourage users to switch to openrc instead. X-Gentoo-Bug: 493958 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=493958 2013-12-11 17:39:38 -06:00			`.Xr openrc 8 ,`
Rename runscript to openrc-run This was requested by Debian, because the minicom software, which is available on Debian and other distros, has a binary named runscript. We are keeping a backward compatibility symlink for now, but this allows Debian or any other distro to safely remove the symlink. X-Gentoo-Bug: 494220 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=494220 2013-12-21 14:51:11 -06:00			`.Xr openrc-run 8`
Add man pages for all librc functions. 2007-12-24 22:03:27 +00:00			`.Sh AUTHORS`
Typo. 2008-12-30 19:08:51 +00:00			`.An Roy Marples <roy@marples.name>`