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. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)confstr.3 8.1 (Berkeley) 6/4/93
39 .Nd get string-valued configurable variables
41 .Fd #include <unistd.h>
43 .Fn confstr "int name" "char *buf" "size_t len"
46 This interface is obsoleted by
52 function provides a method for applications to get configuration
53 defined string values.
57 argument specifies the system variable to be queried.
58 Symbolic constants for each name value are found in the include file
62 argument specifies the size of the buffer referenced by the
69 is a non-null pointer, and
73 \- 1 bytes of the value are copied into the buffer
75 The copied value is always null terminated.
77 The available values are as follows:
79 .Bl -tag -width "123456"
82 Return a value for the
84 environment variable that finds all the standard utilities.
89 is not successful, \-1 is returned and
92 Otherwise, if the variable does not have a configuration defined value,
96 Otherwise, the buffer size needed to hold the entire configuration-defined
98 If this size is greater than the argument
106 function may fail and set
108 for any of the errors specified for the library functions
113 In addition, the following errors may be reported:
124 function first appeared in