sysconf.3: Document _SC_MQ_{OPEN, PRIO}_MAX.
[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 November 7, 2009
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_MQ_OPEN_MAX
110 The maximum number of open message queue descriptors per process.
111 .It Li _SC_MQ_PRIO_MAX
112 The maximum number of message priorities supported by the implementation.
113 .It Li _SC_NGROUPS_MAX
114 The maximum number of supplemental groups.
115 .It Li _SC_NPROCESSORS_CONF
116 The number of processors configured.
117 .It Li _SC_NPROCESSORS_ONLN
118 The number of processors online.
119 .It Li _SC_OPEN_MAX
120 The maximum number of open files per user id.
121 .It Li _SC_PAGESIZE
122 The size of a system page in bytes.
123 .It Li _SC_RE_DUP_MAX
124 The maximum number of repeated occurrences of a regular expression
125 permitted when using interval notation.
126 .It Li _SC_SAVED_IDS
127 Returns 1 if saved set-group and saved set-user ID is available,
128 otherwise \-1.
129 .It Li _SC_STREAM_MAX
130 The minimum maximum number of streams that a process may have open
131 at any one time.
132 .It Li _SC_TZNAME_MAX
133 The minimum maximum number of types supported for the name of a
134 timezone.
135 .It Li _SC_VERSION
136 The version of
137 .St -p1003.1
138 with which the system
139 attempts to comply.
140 .It Li _SC_2_C_BIND
141 Return 1 if the system's C-language development facilities support the
142 C-Language Bindings Option, otherwise \-1.
143 .It Li _SC_2_C_DEV
144 Return 1 if the system supports the C-Language Development Utilities Option,
145 otherwise \-1.
146 .It Li _SC_2_CHAR_TERM
147 Return 1 if the system supports at least one terminal type capable of
148 all operations described in
149 .St -p1003.2 ,
150 otherwise \-1.
151 .It Li _SC_2_FORT_DEV
152 Return 1 if the system supports the FORTRAN Development Utilities Option,
153 otherwise \-1.
154 .It Li _SC_2_FORT_RUN
155 Return 1 if the system supports the FORTRAN Runtime Utilities Option,
156 otherwise \-1.
157 .It Li _SC_2_LOCALEDEF
158 Return 1 if the system supports the creation of locales, otherwise \-1.
159 .It Li _SC_2_SW_DEV
160 Return 1 if the system supports the Software Development Utilities Option,
161 otherwise \-1.
162 .It Li _SC_2_UPE
163 Return 1 if the system supports the User Portability Utilities Option,
164 otherwise \-1.
165 .It Li _SC_2_VERSION
166 The version of
167 .St -p1003.2
168 with which the system attempts to comply.
169 .El
170 .Sh RETURN VALUES
171 If the call to
172 .Fn sysconf
173 is not successful, \-1 is returned and
174 .Va errno
175 is set appropriately.
176 Otherwise, if the variable is associated with functionality that is not
177 supported, \-1 is returned and
178 .Va errno
179 is not modified.
180 Otherwise, the current variable value is returned.
181 .Sh ERRORS
182 The
183 .Fn sysconf
184 function may fail and set
185 .Va errno
186 for any of the errors specified for the library function
187 .Xr sysctl 3 .
188 In addition, the following error may be reported:
189 .Bl -tag -width Er
190 .It Bq Er EINVAL
191 The value of the
192 .Fa name
193 argument is invalid.
194 .El
195 .Sh SEE ALSO
196 .Xr sysctl 3
197 .Sh STANDARDS
198 Except for the fact that values returned by
199 .Fn sysconf
200 may change over the lifetime of the calling process,
201 this function conforms to
202 .St -p1003.1-88 .
203 .Pp
204 _SC_NPROCESSORS_CONF and _SC_NPROCESSORS_ONLN are nonstandard, but implemented
205 in many systems.
206 .Sh HISTORY
207 The
208 .Fn sysconf
209 function first appeared in
210 .Bx 4.4 .
211 .Sh BUGS
212 The value for _SC_STREAM_MAX is a minimum maximum, and required to be
213 the same as ANSI C's FOPEN_MAX, so the returned value is a ridiculously
214 small and misleading number.