1.\" $NetBSD: optstr.9,v 1.1 2006/02/03 11:04:46 jmmv Exp $ 2.\" 3.\" Copyright (c) 2006 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Julio M. Merino Vidal. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd February 3, 2006 38.Dt OPTSTR 9 39.Os 40.Sh NAME 41.Nm optstr_get 42.Nd Options string management 43.Sh SYNOPSIS 44.In sys/optstr.h 45.Ft boolean_t 46.Fn optstr_get "const char *optstr" "const char *key" "char *buf" "size_t bufsize" 47.Sh DESCRIPTION 48An options string is a list of key/value pairs represented in textual form. 49Each pair is expressed as 50.Sq 'key=value' 51and is separated from other pairs by one or more spaces. 52For example: 53.Bd -literal 54key1=value1 key2=value2 key3=value3 55.Ed 56.Pp 57Options strings are used to pass information between userland programs and 58the kernel in a binary-agnostic way. 59This makes them endianness and ABI independent. 60.Sh FUNCTIONS 61The following functions are provided to manage options strings: 62.Bl -tag -width compact 63.It Fn optstr_get "optstr" "key" "buf" "bufsize" 64Scans the 65.Va optstr 66options string looking for the key 67.Va key 68and stores its value in the buffer pointed to by 69.Va buf 70copying a maximum of 71.Va bufsize 72bytes. 73Returns 74.Sq TRUE 75if the key was found or 76.Sq FALSE 77otherwise, in which case 78.Va buf 79is left unmodified. 80.El 81.Sh CODE REFERENCES 82The options string management functions are implemented within the files 83.Pa sys/kern/subr_optstr.c 84and 85.Pa sys/sys/optstr.h . 86.Sh HISTORY 87Options strings appeared in 88.Nx 4.0 . 89