diff options
Diffstat (limited to 'man/rc_config.3')
| -rw-r--r-- | man/rc_config.3 | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/man/rc_config.3 b/man/rc_config.3 new file mode 100644 index 0000000..0e26e9c --- /dev/null +++ b/man/rc_config.3 @@ -0,0 +1,72 @@ +.\" 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_CONFIG 3 SMM +.Os OpenRC +.Sh NAME +.Nm rc_config_list , rc_config_load , rc_config_value , rc_yesno +.Nd functions to query OpenRC service configurations +.Sh LIBRARY +Run Command library (librc, -lrc) +.Sh SYNOPSIS +.In rc.h +.Ft "char **" Fn rc_config_list "const char *file" +.Ft "char **" Fn rc_config_load "const char *file" +.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 +.Fn rc_strlist_free +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 +.Xr rc_strlist_free 3 , +.Xr sh 1 +.Sh AUTHORS +.An "Roy Marples" Aq roy@marples.name |