| property.3 (112541) | property.3 (131504) |
|---|---|
| 1.\" 2.\" Copyright (c) 1998 Jordan Hubbard 3.\" 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: --- 9 unchanged lines hidden (view full) --- 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. 25.\" | 1.\" 2.\" Copyright (c) 1998 Jordan Hubbard 3.\" 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: --- 9 unchanged lines hidden (view full) --- 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. 25.\" |
| 26.\" $FreeBSD: head/lib/libutil/property.3 112541 2003-03-24 16:02:05Z charnier $ | 26.\" $FreeBSD: head/lib/libutil/property.3 131504 2004-07-02 23:52:20Z ru $ |
| 27.\" " 28.Dd October 7, 1998 29.Os 30.Dt PROPERTIES 3 31.Sh NAME 32.Nm properties_read , 33.Nm propery_find , 34.Nm properties_free --- 27 unchanged lines hidden (view full) --- 62and returns the head of a new property list, assuming that the 63file's contents have been parsed properly, or NULL in case 64of error. 65.Pp 66The 67.Fn property_find 68function returns the associated value string for the property named 69.Fa name | 27.\" " 28.Dd October 7, 1998 29.Os 30.Dt PROPERTIES 3 31.Sh NAME 32.Nm properties_read , 33.Nm propery_find , 34.Nm properties_free --- 27 unchanged lines hidden (view full) --- 62and returns the head of a new property list, assuming that the 63file's contents have been parsed properly, or NULL in case 64of error. 65.Pp 66The 67.Fn property_find 68function returns the associated value string for the property named 69.Fa name |
| 70if found, otherwise NULL. The value returned may be up to | 70if found, otherwise NULL. 71The value returned may be up to |
| 71.Dv PROPERTY_MAX_VALUE 72bytes in length. 73.Pp 74The 75.Fn properties_free 76function is used to free the structure returned by 77.Fn properties_read 78when it is no longer needed. 79.Sh FILE FORMAT 80Each property in the file is assumed to have the format of 81.Fa name = value 82where 83.Fa name 84is an alphanumeric string (and any punctuation not including the `=' character) 85and 86.Fa value | 72.Dv PROPERTY_MAX_VALUE 73bytes in length. 74.Pp 75The 76.Fn properties_free 77function is used to free the structure returned by 78.Fn properties_read 79when it is no longer needed. 80.Sh FILE FORMAT 81Each property in the file is assumed to have the format of 82.Fa name = value 83where 84.Fa name 85is an alphanumeric string (and any punctuation not including the `=' character) 86and 87.Fa value |
| 87is an arbitary string of text terminated by a newline character. If newlines | 88is an arbitary string of text terminated by a newline character. 89If newlines |
| 88are desired, the entire value should be enclosed in { } (curly-bracket) | 90are desired, the entire value should be enclosed in { } (curly-bracket) |
| 89characters. Any line beginning with a # or ; character is assumed to | 91characters. 92Any line beginning with a # or ; character is assumed to |
| 90be a comment and will be ignored. 91.Sh SEE ALSO 92.Xr auth_getval 3 93.Sh BUGS 94Simplistic. 95.Sh AUTHORS 96.An Jordan Hubbard | 93be a comment and will be ignored. 94.Sh SEE ALSO 95.Xr auth_getval 3 96.Sh BUGS 97Simplistic. 98.Sh AUTHORS 99.An Jordan Hubbard |