openrc/man/rc_runlevel.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/HEAD/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/HEAD/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_RUNLEVEL 3 SMM
.Os OpenRC
.Sh NAME
.Nm rc_runlevel_get , rc_runlevel_exists , rc_runlevel_list , rc_runlevel_set ,
.Nm rc_runlevel_starting , rc_runlevel_stopping
.Nd RC runlevel functions
.Sh LIBRARY
Run Command library (librc, -lrc)
.Sh SYNOPSIS
.In rc.h
.Ft "char *" Fn rc_runlevel_get void
.Ft bool Fn rc_runlevel_exists
.Ft "RC_STRINGLIST *" Fn rc_runlevel_list void
.Ft bool Fn rc_runlevel_set "const char *runlevel"
.Ft bool Fn rc_runlevel_starting void
.Ft bool Fn rc_runlevel_stopping void
.Sh DESCRIPTION
These functions provide a means of querying OpenRC to find out which runlevel
we are in and what services are in which runlevel.
.Sh IMPLEMENTATION NOTES
Each function that returns
.Fr "char *"
returns a malloced NULL terminated string that should be freed when done.
.Pp
Each function that returns
.Fr "RC_STRINGLIST *"
should by freed by calling
.Fn rc_stringlist_free
when done.
.Sh FILES
.Pa /etc/init.d/functions.sh
is provided by OpenRC, which allows shell scripts to use the above functions.
For historical reasons our verbose functions are prefixed with v instead of
suffixed. So einfov becomes veinfo, einfovn becomes veinfon.
Rinse and repeat for the other verbose functions.
.Sh SEE ALSO
.Xr malloc 3 ,
.Xr free 3
.Xr rc_stringlist_free 3
.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-05 06:52:19 +08:00			`.\" Copyright (c) 2007-2015 The OpenRC Authors.`
			`.\" See the Authors file at the top-level directory of this distribution and`
use HEAD in git URIs to point to the default branch This makes the URIs shorter and dynamic: whatever the default branch the repo uses will be used. 2021-12-21 09:07:00 +08:00			`.\" https://github.com/OpenRC/openrc/blob/HEAD/AUTHORS`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08: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-05 06:52:19 +08: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`
use HEAD in git URIs to point to the default branch This makes the URIs shorter and dynamic: whatever the default branch the repo uses will be used. 2021-12-21 09:07:00 +08:00			`.\" distribution and at https://github.com/OpenRC/openrc/blob/HEAD/LICENSE`
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-05 06:52:19 +08:00			`.\" 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-25 06:03:27 +08: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-17 01:00:56 +08:00			`.Dd Mar 16, 2008`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08:00			`.Dt RC_RUNLEVEL 3 SMM`
			`.Os OpenRC`
			`.Sh NAME`
			`.Nm rc_runlevel_get , rc_runlevel_exists , rc_runlevel_list , rc_runlevel_set ,`
			`.Nm rc_runlevel_starting , rc_runlevel_stopping`
			`.Nd RC runlevel functions`
			`.Sh LIBRARY`
			`Run Command library (librc, -lrc)`
			`.Sh SYNOPSIS`
Whitespace 2012-01-22 08:17:42 +08:00			`.In rc.h`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08:00			`.Ft "char *" Fn rc_runlevel_get void`
			`.Ft bool Fn rc_runlevel_exists`
Remove null terminated char ** lists in favour of RC_STRINGLIST, using TAILQ from queue(3). Refactor code style around the BSD KNF. 2008-03-17 01:00:56 +08:00			`.Ft "RC_STRINGLIST *" Fn rc_runlevel_list void`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08:00			`.Ft bool Fn rc_runlevel_set "const char *runlevel"`
			`.Ft bool Fn rc_runlevel_starting void`
			`.Ft bool Fn rc_runlevel_stopping void`
			`.Sh DESCRIPTION`
			`These functions provide a means of querying OpenRC to find out which runlevel`
			`we are in and what services are in which runlevel.`
			`.Sh IMPLEMENTATION NOTES`
			`Each function that returns`
			`.Fr "char *"`
			`returns a malloced NULL terminated string that should be freed when done.`
			`.Pp`
			`Each function that returns`
Remove null terminated char ** lists in favour of RC_STRINGLIST, using TAILQ from queue(3). Refactor code style around the BSD KNF. 2008-03-17 01:00:56 +08:00			`.Fr "RC_STRINGLIST *"`
			`should by freed by calling`
			`.Fn rc_stringlist_free`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08:00			`when done.`
			`.Sh FILES`
			`.Pa /etc/init.d/functions.sh`
			`is provided by OpenRC, which allows shell scripts to use the above functions.`
			`For historical reasons our verbose functions are prefixed with v instead of`
			`suffixed. So einfov becomes veinfo, einfovn becomes veinfon.`
			`Rinse and repeat for the other verbose functions.`
			`.Sh SEE ALSO`
			`.Xr malloc 3 ,`
			`.Xr free 3`
Remove null terminated char ** lists in favour of RC_STRINGLIST, using TAILQ from queue(3). Refactor code style around the BSD KNF. 2008-03-17 01:00:56 +08:00			`.Xr rc_stringlist_free 3`
Add man pages for all librc functions. 2007-12-25 06:03:27 +08:00			`.Sh AUTHORS`
Typo. 2008-12-31 03:08:51 +08:00			`.An Roy Marples <roy@marples.name>`