[unix-history] / lib / libutil / config_open.3

.\" Copyright (c) 1994 Christoph M. Robitschko
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed by Christoph M. Robitschko
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software withough specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
.\"
.\"	$Id$
.\"
.Dd January 28, 1994
.Dt config_open 3
.Os FreeBSD
.Sh NAME
.Nm config_open ,
.Nm config_close ,
.Nm config_next ,
.Nm config_skip
.Nd read config files
.Sh SYNOPSIS
.Ft char *
.Fn config_open "const char *filename" "int contlines"
.Ft void
.Fn config_close
.Ft char *
.Fn config_next
.Ft char *
.Fn config_skip "char **string"
.Sh DESCRIPTION
These functions are used to read config files with the following syntax:
.Bl -bullet -compact
.It
Lines starting in
.Sq #
are comments.
.It
An entry starts with the first 
.Sq !isspace()
character found.
.It
If continuation-lines are enabled, an entry ends before the first
empty line or before the first line not starting in an
.Sq isspace()
character, whichever comes first.
.It
Otherwise, an entry ends at the first
.Sq Li \en
.Li .
.El
.Pp
.Fn config_open
will open the specified
.Fa filename
and read it into a private malloced area, and close the file again. If
.Fa contlines
is non-zero, continuation lines will be allowed.
In case of trouble, the name of the system-call causing the trouble will
be returned. If successful,
.Fn config_open
returns NULL.
.Pp
.Fn config_close
will free the malloced area.
.Pp
.Fn config_next
returns the next entry in the area. NULL is returned to indicate End-of-file.
The returned string is null-terminated, and
.Sq \en
characters (if continuation lines are enabled) are converted to
space characters.
.Pp
.Fn config_skip
returns the next word from the string
.Fa *string
.Li .
.Fa *string
will be advanced to point to the next word.
NULL is returned to indicate the end of the string.
.Sh FILES
.Pa /usr/lib/libutil.a
The name of the library these functions are part of.
.Sh AUTHOR
Poul-Henning Kamp <phk@login.dkuug.dk>
Commit	Line	Data
c4d09a4c CR	1	.\" Copyright (c) 1994 Christoph M. Robitschko
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by Christoph M. Robitschko
	15	.\" 4. The name of the author may not be used to endorse or promote products
	16	.\" derived from this software withough specific prior written permission
	17	.\"
	18	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	19	.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	20	.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	21	.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	22	.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	23	.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	24	.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	25	.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	26	.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	27	.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
8ca81eb5 RG	28	.\"
	29	.\" $Id$
	30	.\"
c4d09a4c CR	31	.Dd January 28, 1994
	32	.Dt config_open 3
	33	.Os FreeBSD
	34	.Sh NAME
	35	.Nm config_open ,
	36	.Nm config_close ,
	37	.Nm config_next ,
	38	.Nm config_skip
	39	.Nd read config files
	40	.Sh SYNOPSIS
	41	.Ft char *
	42	.Fn config_open "const char *filename" "int contlines"
	43	.Ft void
	44	.Fn config_close
	45	.Ft char *
	46	.Fn config_next
	47	.Ft char *
	48	.Fn config_skip "char **string"
	49	.Sh DESCRIPTION
	50	These functions are used to read config files with the following syntax:
	51	.Bl -bullet -compact
	52	.It
	53	Lines starting in
	54	.Sq #
	55	are comments.
	56	.It
	57	An entry starts with the first
	58	.Sq !isspace()
	59	character found.
	60	.It
	61	If continuation-lines are enabled, an entry ends before the first
	62	empty line or before the first line not starting in an
	63	.Sq isspace()
	64	character, whichever comes first.
	65	.It
	66	Otherwise, an entry ends at the first
	67	.Sq Li \en
	68	.Li .
	69	.El
	70	.Pp
	71	.Fn config_open
	72	will open the specified
	73	.Fa filename
	74	and read it into a private malloced area, and close the file again. If
	75	.Fa contlines
	76	is non-zero, continuation lines will be allowed.
	77	In case of trouble, the name of the system-call causing the trouble will
	78	be returned. If successful,
	79	.Fn config_open
	80	returns NULL.
	81	.Pp
	82	.Fn config_close
	83	will free the malloced area.
	84	.Pp
	85	.Fn config_next
	86	returns the next entry in the area. NULL is returned to indicate End-of-file.
	87	The returned string is null-terminated, and
	88	.Sq \en
	89	characters (if continuation lines are enabled) are converted to
	90	space characters.
	91	.Pp
	92	.Fn config_skip
	93	returns the next word from the string
	94	.Fa *string
95	.Li .
96	.Fa *string
97	will be advanced to point to the next word.
98	NULL is returned to indicate the end of the string.
99	.Sh FILES
100	.Pa /usr/lib/libutil.a
101	The name of the library these functions are part of.
102	.Sh AUTHOR
103	Poul-Henning Kamp <phk@login.dkuug.dk>