1 .\" (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" Modified Sat Jul 24 17:51:42 1993 by Rik Faith (faith@cs.unc.edu)
24 .\" Modified Tue Aug 17 11:42:20 1999 by Ariel Scolnicov (ariels@compugen.co.il)
25 .TH SYSCONF 3 1993-04-18 "GNU" "Linux Programmer's Manual"
27 sysconf \- Get configuration information at runtime
30 .B #include <unistd.h>
32 .BI "long sysconf(int " "name" );
35 POSIX allows an application to test at compile- or run-time
36 whether certain options are supported, or what the value is
37 of certain configurable constants or limits.
39 At compile time this is done by including
43 and testing the value of certain macros.
45 At run time, one can ask for numerical values using the present function
47 On can ask for numerical values that may depend
48 on the filesystem a file is in using the calls
52 One can ask for string values using
55 The values obtained from these functions are system configuration constants.
56 They do not change during the lifetime of a process.
57 .\" except that sysconf(_SC_OPEN_MAX) may change answer after a call
58 .\" to setrlimit( ) which changes the RLIMIT_NOFILE soft limit
60 For options, typically, there is a constant
62 that may be defined in
64 If it is undefined, one should ask at run-time.
65 If it is defined to \-1, then the option is not supported.
66 If it is defined to 0, then relevant functions and headers exist,
67 but one has to ask at runtime what degree of support is available.
68 If it is defined to a value other than \-1 or 0, then the option is
70 Usually the value (such as 200112L) indicates the year and month
71 of the POSIX revision describing the option.
72 Glibc uses the value 1
73 to indicate support as long as the POSIX revision has not been published yet.
74 .\" and 999 to indicate support for options no longer present in the latest
80 For a list of options, see
83 For variables or limits, typically, there is a constant
91 The constant will not be defined if the limit is unspecified.
92 If the constant is defined, it gives a guaranteed value, and
93 more might actually be supported.
94 If an application wants to take advantage of values which may change
95 between systems, a call to
102 .SS "POSIX.1 Variables"
103 We give the name of the variable, the name of the
105 parameter used to inquire about its value,
106 and a short description.
108 First, the POSIX.1 compatible values.
109 .\" [for the moment: only the things that are unconditionally present]
111 .\" .BR AIO_LISTIO_MAX " - " _SC_AIO_LISTIO_MAX
112 .\" (if _POSIX_ASYNCHRONOUS_IO)
113 .\" Maximum number of I/O operations in a single list I/O call.
114 .\" Must not be less than _POSIX_AIO_LISTIO_MAX.
116 .\" .BR AIO_MAX " - " _SC_AIO_MAX
117 .\" (if _POSIX_ASYNCHRONOUS_IO)
118 .\" Maximum number of outstanding asynchronous I/O operations.
119 .\" Must not be less than _POSIX_AIO_MAX.
121 .\" .BR AIO_PRIO_DELTA_MAX " - " _SC_AIO_PRIO_DELTA_MAX
122 .\" (if _POSIX_ASYNCHRONOUS_IO)
123 .\" The maximum amount by which a process can decrease its
124 .\" asynchronous I/O priority level from its own scheduling priority.
125 .\" Must be non-negative.
127 .BR ARG_MAX " - " _SC_ARG_MAX
128 The maximum length of the arguments to the
131 Must not be less than
135 .BR CHILD_MAX " - " _SC_CHILD_MAX
136 The max number of simultaneous processes per user ID.
137 Must not be less than
141 .BR HOST_NAME_MAX " - " _SC_HOST_NAME_MAX
142 Max length of a hostname, not including the terminating null byte,
145 Must not be less than
146 .B _POSIX_HOST_NAME_MAX
149 .BR LOGIN_NAME_MAX " - " _SC_LOGIN_NAME_MAX
150 Maximum length of a login name, including the terminating null byte.
151 Must not be less than
152 .B _POSIX_LOGIN_NAME_MAX
155 .BR "" "clock ticks - " _SC_CLK_TCK
156 The number of clock ticks per second.
157 The corresponding variable is obsolete.
158 It was of course called
162 does not give information: it must equal 1000000.)
164 .BR OPEN_MAX " - " _SC_OPEN_MAX
165 The maximum number of files that a process can have open at any time.
166 Must not be less than
170 .BR PAGESIZE " - " _SC_PAGESIZE
171 Size of a page in bytes.
172 Must not be less than 1.
173 (Some systems use PAGE_SIZE instead.)
175 .BR RE_DUP_MAX " - " _SC_RE_DUP_MAX
176 The number of repeated occurrences of a BRE permitted by
180 Must not be less than
181 .B _POSIX2_RE_DUP_MAX
184 .BR STREAM_MAX " - " _SC_STREAM_MAX
185 The maximum number of streams that a process can have open at any
187 If defined, it has the same value as the standard C macro
189 Must not be less than
194 The maximum number of symbolic links seen in a pathname before resolution
197 Must not be less than
198 .B _POSIX_SYMLOOP_MAX
201 .BR TTY_NAME_MAX " - " _SC_TTY_NAME_MAX
202 The maximum length of terminal device name,
203 including the terminating null byte.
204 Must not be less than
205 .BR _POSIX_TTY_NAME_MAX
208 .BR TZNAME_MAX " - " _SC_TZNAME_MAX
209 The maximum number of bytes in a timezone name.
210 Must not be less than
211 .BR _POSIX_TZNAME_MAX
214 .BR _POSIX_VERSION " - " _SC_VERSION
215 indicates the year and month the POSIX.1 standard was approved in the
220 indicates the Sept. 1990 revision.
221 .SS "POSIX.2 Variables"
222 Next, the POSIX.2 values, giving limits for utilities.
224 .BR BC_BASE_MAX " - " _SC_BC_BASE_MAX
225 indicates the maximum
227 value accepted by the
231 .BR BC_DIM_MAX " - " _SC_BC_DIM_MAX
232 indicates the maximum value of elements permitted in an array by
235 .BR BC_SCALE_MAX " - " _SC_BC_SCALE_MAX
236 indicates the maximum
241 .BR BC_STRING_MAX " - " _SC_BC_STRING_MAX
242 indicates the maximum length of a string accepted by
245 .BR COLL_WEIGHTS_MAX " - " _SC_COLL_WEIGHTS_MAX
246 indicates the maximum numbers of weights that can be assigned to an
249 keyword in the locale definition file,
251 .BR EXPR_NEST_MAX " - " _SC_EXPR_NEST_MAX
252 is the maximum number of expressions which can be nested within
256 .BR LINE_MAX " - " _SC_LINE_MAX
257 The maximum length of a utility's input line length, either from
258 standard input or from a file.
259 This includes length for a trailing
262 .BR RE_DUP_MAX " - " _SC_RE_DUP_MAX
263 The maximum number of repeated occurrences of a regular expression when
264 the interval notation
268 .BR POSIX2_VERSION " - " _SC_2_VERSION
269 indicates the version of the POSIX.2 standard in the format of
272 .BR POSIX2_C_DEV " - " _SC_2_C_DEV
273 indicates whether the POSIX.2 C language development facilities are
276 .BR POSIX2_FORT_DEV " - " _SC_2_FORT_DEV
277 indicates whether the POSIX.2 FORTRAN development utilities are
280 .BR POSIX2_FORT_RUN " - " _SC_2_FORT_RUN
281 indicates whether the POSIX.2 FORTRAN runtime utilities are supported.
283 .BR _POSIX2_LOCALEDEF " - " _SC_2_LOCALEDEF
284 indicates whether the POSIX.2 creation of locates via
288 .BR POSIX2_SW_DEV " - " _SC_2_SW_DEV
289 indicates whether the POSIX.2 software development utilities option is
292 These values also exist, but may not be standard.
294 .BR "" " - " _SC_PHYS_PAGES
295 The number of pages of physical memory.
296 Note that it is possible
297 for the product of this value and the value of
301 .BR "" " - " _SC_AVPHYS_PAGES
302 The number of currently available pages of physical memory.
306 is invalid, \-1 is returned, and
310 Otherwise, the value returned is the value of the system resource and
313 In the case of options, a positive value is returned if a queried option
314 is available, and \-1 if it is not.
315 In the case of limits, \-1 means that there is no definite limit.
319 It is difficult to use
321 because it is not specified how much of the argument space for
323 is consumed by the user's environment variables.
325 Some returned values may be huge; they are not suitable for allocating