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