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