89 lines
3.2 KiB
Groff
89 lines
3.2 KiB
Groff
.\" $NetBSD: optstr.9,v 1.1 2006/02/03 11:04:46 jmmv Exp $
|
|
.\"
|
|
.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Julio M. Merino Vidal.
|
|
.\"
|
|
.\" 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 the NetBSD
|
|
.\" Foundation, Inc. and its contributors.
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
.\" contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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 February 3, 2006
|
|
.Dt OPTSTR 9
|
|
.Os
|
|
.Sh NAME
|
|
.Nm optstr_get
|
|
.Nd Options string management
|
|
.Sh SYNOPSIS
|
|
.In sys/optstr.h
|
|
.Ft boolean_t
|
|
.Fn optstr_get "const char *optstr" "const char *key" "char *buf" "size_t bufsize"
|
|
.Sh DESCRIPTION
|
|
An options string is a list of key/value pairs represented in textual form.
|
|
Each pair is expressed as
|
|
.Sq 'key=value'
|
|
and is separated from other pairs by one or more spaces.
|
|
For example:
|
|
.Bd -literal
|
|
key1=value1 key2=value2 key3=value3
|
|
.Ed
|
|
.Pp
|
|
Options strings are used to pass information between userland programs and
|
|
the kernel in a binary-agnostic way.
|
|
This makes them endianness and ABI independent.
|
|
.Sh FUNCTIONS
|
|
The following functions are provided to manage options strings:
|
|
.Bl -tag -width compact
|
|
.It Fn optstr_get "optstr" "key" "buf" "bufsize"
|
|
Scans the
|
|
.Va optstr
|
|
options string looking for the key
|
|
.Va key
|
|
and stores its value in the buffer pointed to by
|
|
.Va buf
|
|
copying a maximum of
|
|
.Va bufsize
|
|
bytes.
|
|
Returns
|
|
.Sq TRUE
|
|
if the key was found or
|
|
.Sq FALSE
|
|
otherwise, in which case
|
|
.Va buf
|
|
is left unmodified.
|
|
.El
|
|
.Sh CODE REFERENCES
|
|
The options string management functions are implemented within the files
|
|
.Pa sys/kern/subr_optstr.c
|
|
and
|
|
.Pa sys/sys/optstr.h .
|
|
.Sh HISTORY
|
|
Options strings appeared in
|
|
.Nx 4.0 .
|