2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)confstr.3 8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/lib/libc/gen/confstr.3,v 1.15 2007/01/09 00:27:53 imp Exp $
30 .\" $DragonFly: src/lib/libc/gen/confstr.3,v 1.6 2008/05/02 02:05:03 swildner Exp $
37 .Nd get string-valued configurable variables
43 .Fn confstr "int name" "char *buf" "size_t len"
45 This interface is specified by
47 A more flexible (but non-portable) interface is provided by
52 function provides a method for applications to get configuration
53 defined string values.
54 Shell programmers needing access to these parameters should use the
60 argument specifies the system variable to be queried.
61 Symbolic constants for each name value are found in the include file
65 argument specifies the size of the buffer referenced by the
72 is a non-null pointer, and
76 \- 1 bytes of the value are copied into the buffer
78 The copied value is always null terminated.
80 The available values are as follows:
83 Return a value for the
85 environment variable that finds all the standard utilities.
90 is not successful, 0 is returned and
93 Otherwise, if the variable does not have a configuration defined value,
97 Otherwise, the buffer size needed to hold the entire configuration-defined
99 If this size is greater than the argument
107 function may fail and set
109 for any of the errors specified for the library functions
114 In addition, the following errors may be reported:
134 function first appeared in