9b89344ea2be2cabfc5bbfc6e15bb18230f68acb
[dragonfly.git] / lib / libc / gen / sysconf.3
1 .\" Copyright (c) 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
19 .\"
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
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)sysconf.3   8.3 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/lib/libc/gen/sysconf.3,v 1.8.2.6 2001/12/14 18:33:51 ru Exp $
34 .\" $DragonFly: src/lib/libc/gen/sysconf.3,v 1.7 2008/05/02 02:05:03 swildner Exp $
35 .\"
36 .Dd February 21, 2008
37 .Dt SYSCONF 3
38 .Os
39 .Sh NAME
40 .Nm sysconf
41 .Nd get configurable system variables
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft long
47 .Fn sysconf "int name"
48 .Sh DESCRIPTION
49 This interface is defined by
50 .St -p1003.1-88 .
51 A far more complete interface is available using
52 .Xr sysctl 3 .
53 .Pp
54 The
55 .Fn sysconf
56 function provides a method for applications to determine the current
57 value of a configurable system limit or option variable.
58 The
59 .Fa name
60 argument specifies the system variable to be queried.
61 Symbolic constants for each name value are found in the include file
62 .In unistd.h .
63 .Pp
64 The available values are as follows:
65 .Bl -tag -width 6n
66 .It Li _SC_ARG_MAX
67 The maximum bytes of argument to
68 .Xr execve 2 .
69 .It Li _SC_BC_BASE_MAX
70 The maximum ibase/obase values in the
71 .Xr bc 1
72 utility.
73 .It Li _SC_BC_DIM_MAX
74 The maximum array size in the
75 .Xr bc 1
76 utility.
77 .It Li _SC_BC_SCALE_MAX
78 The maximum scale value in the
79 .Xr bc 1
80 utility.
81 .It Li _SC_BC_STRING_MAX
82 The maximum string length in the
83 .Xr bc 1
84 utility.
85 .It Li _SC_CHILD_MAX
86 The maximum number of simultaneous processes per user id.
87 .It Li _SC_CLK_TCK
88 The frequency of the statistics clock in ticks per second.
89 .It Li _SC_COLL_WEIGHTS_MAX
90 The maximum number of weights that can be assigned to any entry of
91 the LC_COLLATE order keyword in the locale definition file.
92 .It Li _SC_EXPR_NEST_MAX
93 The maximum number of expressions that can be nested within
94 parenthesis by the
95 .Xr expr 1
96 utility.
97 .It Li _SC_IOV_MAX
98 The maximum number of elements in the I/O vector used by
99 .Xr readv 2 ,
100 .Xr writev 2 ,
101 .Xr recvmsg 2 ,
102 and
103 .Xr sendmsg 2 .
104 .It Li _SC_JOB_CONTROL
105 Return 1 if job control is available on this system, otherwise \-1.
106 .It Li _SC_LINE_MAX
107 The maximum length in bytes of a text-processing utility's input
108 line.
109 .It Li _SC_NGROUPS_MAX
110 The maximum number of supplemental groups.
111 .It Li _SC_NPROCESSORS_CONF
112 The number of processors configured.
113 .It Li _SC_NPROCESSORS_ONLN
114 The number of processors online.
115 .It Li _SC_OPEN_MAX
116 The maximum number of open files per user id.
117 .It Li _SC_PAGESIZE
118 The size of a system page in bytes.
119 .It Li _SC_RE_DUP_MAX
120 The maximum number of repeated occurrences of a regular expression
121 permitted when using interval notation.
122 .It Li _SC_SAVED_IDS
123 Returns 1 if saved set-group and saved set-user ID is available,
124 otherwise \-1.
125 .It Li _SC_STREAM_MAX
126 The minimum maximum number of streams that a process may have open
127 at any one time.
128 .It Li _SC_TZNAME_MAX
129 The minimum maximum number of types supported for the name of a
130 timezone.
131 .It Li _SC_VERSION
132 The version of
133 .St -p1003.1
134 with which the system
135 attempts to comply.
136 .It Li _SC_2_C_BIND
137 Return 1 if the system's C-language development facilities support the
138 C-Language Bindings Option, otherwise \-1.
139 .It Li _SC_2_C_DEV
140 Return 1 if the system supports the C-Language Development Utilities Option,
141 otherwise \-1.
142 .It Li _SC_2_CHAR_TERM
143 Return 1 if the system supports at least one terminal type capable of
144 all operations described in
145 .St -p1003.2 ,
146 otherwise \-1.
147 .It Li _SC_2_FORT_DEV
148 Return 1 if the system supports the FORTRAN Development Utilities Option,
149 otherwise \-1.
150 .It Li _SC_2_FORT_RUN
151 Return 1 if the system supports the FORTRAN Runtime Utilities Option,
152 otherwise \-1.
153 .It Li _SC_2_LOCALEDEF
154 Return 1 if the system supports the creation of locales, otherwise \-1.
155 .It Li _SC_2_SW_DEV
156 Return 1 if the system supports the Software Development Utilities Option,
157 otherwise \-1.
158 .It Li _SC_2_UPE
159 Return 1 if the system supports the User Portability Utilities Option,
160 otherwise \-1.
161 .It Li _SC_2_VERSION
162 The version of
163 .St -p1003.2
164 with which the system attempts to comply.
165 .El
166 .Sh RETURN VALUES
167 If the call to
168 .Fn sysconf
169 is not successful, \-1 is returned and
170 .Va errno
171 is set appropriately.
172 Otherwise, if the variable is associated with functionality that is not
173 supported, \-1 is returned and
174 .Va errno
175 is not modified.
176 Otherwise, the current variable value is returned.
177 .Sh ERRORS
178 The
179 .Fn sysconf
180 function may fail and set
181 .Va errno
182 for any of the errors specified for the library function
183 .Xr sysctl 3 .
184 In addition, the following error may be reported:
185 .Bl -tag -width Er
186 .It Bq Er EINVAL
187 The value of the
188 .Fa name
189 argument is invalid.
190 .El
191 .Sh SEE ALSO
192 .Xr sysctl 3
193 .Sh STANDARDS
194 Except for the fact that values returned by
195 .Fn sysconf
196 may change over the lifetime of the calling process,
197 this function conforms to
198 .St -p1003.1-88 .
199 .Pp
200 _SC_NPROCESSORS_CONF and _SC_NPROCESSORS_ONLN are nonstandard, but implemented
201 in many systems.
202 .Sh HISTORY
203 The
204 .Fn sysconf
205 function first appeared in
206 .Bx 4.4 .
207 .Sh BUGS
208 The value for _SC_STREAM_MAX is a minimum maximum, and required to be
209 the same as ANSI C's FOPEN_MAX, so the returned value is a ridiculously
210 small and misleading number.