2 .\" Copyright (c) 1998 Jordan Hubbard
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\" $FreeBSD: src/lib/libutil/property.3,v 1.8.2.7 2001/12/17 10:08:32 ru Exp $
35 .Nd "functions to allow creating simple property lists from ASCII file data"
42 .Fn properties_read "int fd"
44 .Fn property_find "properties list" "const char *name"
46 .Fn properties_free "properties list"
49 typedef struct _properties {
50 struct _properties *next;
60 pairs from the file descriptor passed in
62 and returns the head of a new property list, assuming that the
63 file's contents have been parsed properly, or NULL in case
67 Returns the associated value string for the property named
69 if found, otherwise NULL. The value returned may be up to
70 .Dv PROPERTY_MAX_VALUE
74 is used to free the structure returned by
76 when it is no longer needed.
78 Each property in the file is assumed to have the format of
82 is an alphanumeric string (and any punctuation not including the `=' character)
85 is an arbitrary string of text terminated by a newline character. If newlines
86 are desired, the entire value should be enclosed in { } (curly-bracket)
87 characters. Any line beginning with a # or ; character is assumed to
88 be a comment and will be ignored.