emo/openrc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8115f3274e
openrc/man/rc_config.3

60 lines
1.7 KiB
Groff
Raw Normal View History

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 04:22:19 +05:30
.\" 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 06:37:00 +05:30
.\" https://github.com/OpenRC/openrc/blob/HEAD/AUTHORS
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
.\"
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 04:22:19 +05:30
.\" 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 06:37:00 +05:30
.\" 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 04:22:19 +05:30
.\" 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 03:33:27 +05:30
.\"
Make rc_getline private and save it's buffer so it's sort of like getline from glibc.
2008-03-18 02:57:37 +05:30
.Dd Mar 17, 2008
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
.Dt RC_CONFIG 3 SMM
.Os OpenRC
.Sh NAME
Make rc_getline private and save it's buffer so it's sort of like getline from glibc.
2008-03-18 02:57:37 +05:30
.Nm rc_config_list , rc_config_load , rc_config_value , rc_yesno
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
.Nd functions to query OpenRC service configurations
.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 22:30:56 +05:30
.Ft "RC_STRINGLIST *" Fn rc_config_list "const char *file"
.Ft "RC_STRINGLIST *" Fn rc_config_load "const char *file"
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
.Ft "char *" Fn rc_config_value "const char *const *list" "const char *entry"
.Ft bool Fn rc_yesno "const char *value"
.Sh DESCRIPTION
These functions provide an easy means of querying OpenRC configuration files.
.Pp
.Fn rc_config_list
returns a list of non comment lines in
.Fa file .
.Fn rc_config_load
does the same, but attempts to parse the line as if it was
a shell assignment.
.Fn rc_config_value
returns the value of
.Fa entry
found in
.Fa list .
.Pp
Each list should be freed using
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 22:30:56 +05:30
.Fn rc_stringlist_free
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
when done.
.Pp
.Fn rc_yesno
returns if
.Fa value
is true, yes, on or 1 regardless of case, otherwise false.
If
.Fa value
is also not false, no, off or 0 regardless of case then
.Va errno
is set to
.Va EINVAL .
.Sh SEE ALSO
add rc_getline to the man page
2008-01-07 18:09:27 +05:30
.Xr malloc 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-16 22:30:56 +05:30
.Xr rc_stringlist_free 3 ,
Add man pages for all librc functions.
2007-12-25 03:33:27 +05:30
.Xr sh 1
.Sh AUTHORS
Typo.
2008-12-31 00:38:51 +05:30
.An Roy Marples <roy@marples.name>
Reference in New Issue Copy Permalink