getconf(1)
NAME
getconf - get configuration values
SYNOPSIS
getconf [-v specification] system_var
getconf [-v specification] path_var pathname
getconf -a
DESCRIPTION
In the first synopsis form, the getconf utility will write
to the standard output the value of the variable specified
by system_var, in accordance with specification if the -v
option is used.
In the second synopsis form, getconf will write to the stan-
dard output the value of the variable specified by path_var
for the path specified by pathname, in accordance with
specification if the -v option is used.
In the third synopsis form, config will write to the stan-
dard output the names of the current system configuration
variables.
The value of each configuration variable will be determined
as if it were obtained by calling the function from which it
is defined to be available. The value will reflect condi-
tions in the current operating environment.
OPTIONS
The following options are supported:
-a Writes the names of the current system configuration
variables to the standard output.
-v specification
Gives the specification which governs the selection of
values for configuration variables.
OPERANDS
The following operands are supported:
path_var
A name of a configuration variable whose value is
available from the pathconf(2) function. All of the
values in the following table are supported:
LINK_MAX NAME_MAX _POSIX_CHOWN_RESTRICTED
MAX_CANON PATH_MAX _POSIX_NO_TRUNC
MAX_INPUT PIPE_BUF _POSIX_VDISABLE
pathname
A path name for which the variable specified by
path_var is to be determined.
system_var
A name of a configuration variable whose value is
available from confstr(3C) or sysconf(3C). All of the
values in the following table are supported:
ARG_MAX BC_BASE_MAX
BC_DIM_MAX BC_SCALE_MAX
BC_STRING_MAX CHAR_BIT
CHARCLASS_NAME_MAX CHAR_MAX
CHAR_MIN CHILD_MAX
CLK_TCK COLL_WEIGHTS_MAX
CS_PATH EXPR_NEST_MAX
INT_MAX INT_MIN
LFS64_CFLAGS LFS64_LDFLAGS
LFS64_LIBS LFS64_LINTFLAGS
LFS_CFLAGS LFS_LDFLAGS
LFS_LIBS LFS_LINTFLAGS
LINE_MAX LONG_BIT
LONG_MAX LONG_MIN
MB_LEN_MAX NGROUPS_MAX
NL_ARGMAX NL_LANGMAX
NL_MSGMAX NL_NMAX
NL_SETMAX NL_TEXTMAX
NZERO OPEN_MAX
POSIX2_BC_BASE_MAX POSIX2_BC_DIM_MAX
POSIX2_BC_SCALE_MAX POSIX2_BC_STRING_MAX
POSIX2_C_BIND POSIX2_C_DEV
POSIX2_CHAR_TERM POSIX2_COLL_WEIGHTS_MAX
POSIX2_C_VERSION POSIX2_EXPR_NEST_MAX
POSIX2_FORT_DEV POSIX2_FORT_RUN
POSIX2_LINE_MAX POSIX2_LOCALEDEF
POSIX2_RE_DUP_MAX POSIX2_SW_DEV
POSIX2_UPE POSIX2_VERSION
_POSIX_ARG_MAX _POSIX_CHILD_MAX
_POSIX_JOB_CONTROL _POSIX_LINK_MAX
_POSIX_MAX_CANON _POSIX_MAX_INPUT
_POSIX_NAME_MAX _POSIX_NGROUPS_MAX
_POSIX_OPEN_MAX _POSIX_PATH_MAX
_POSIX_PIPE_BUF _POSIX_SAVED_IDS
_POSIX_SSIZE_MAX _POSIX_STREAM_MAX
_POSIX_TZNAME_MAX _POSIX_VERSION
RE_DUP_MAX SCHAR_MAX
SCHAR_MIN SHRT_MAX
SHRT_MIN SSIZE_MAX
STREAM_MAX TMP_MAX
TZNAME_MAX UCHAR_MAX
UINT_MAX ULONG_MAX
USHRT_MAX WORD_BIT
XBS5_ILP32_OFF32 XBS5_ILP32_OFF32_CFLAGS
XBS5_ILP32_OFF32_LDFLAGS XBS5_ILP32_OFF32_LIBS
XBS5_ILP32_OFF32_LINTFLAGS XBS5_ILP32_OFFBIG
XBS5_ILP32_OFFBIG_CFLAGS XBS5_ILP32_OFFBIG_LDFLAGS
XBS5_ILP32_OFFBIG_LIBS XBS5_ILP32_OFFBIG_LINTFLAGS
XBS5_LP64_OFF64 XBS5_LP64_OFF64_CFLAGS
XBS5_LP64_OFF64_LDFLAGS XBS5_LP64_OFF64_LIBS
XBS5_LP64_OFF64_LINTFLAGS XBS5_LPBIG_OFFBIG
XBS5_LPBIG_OFFBIG_CFLAGS XBS5_LPBIG_OFFBIG_LDFLAGS
XBS5_LPBIG_OFFBIG_LIBS XBS5_LPBIG_OFFBIG_LINTFLAGS
_XOPEN_CRYPT _XOPEN_ENH_I18N
_XOPEN_LEGACY _XOPEN_SHM
_XOPEN_VERSION _XOPEN_XCU_VERSION
_XOPEN_XPG2 _XOPEN_XPG3
_XOPEN_XPG4
The symbol PATH also is recognized, yielding the same value
as the confstr() name value CS_PATH.
USAGE
See largefile(5) for the description of the behavior of
getconf when encountering files greater than or equal to 2
Gbyte ( 2**31 bytes).
EXAMPLES
Example 1: Writing the value of a variable
This example illustrates the value of {NGROUPS_MAX}:
example% getconf NGROUPS_MAX
Example 2: Writing the value of a variable for a specific
directory
This example illustrates the value of NAME_MAX for a
specific directory:
example% getconf NAME_MAX /usr
Example 3: Dealing with unspecified results
This example shows how to deal more carefully with results
that might be unspecified:
if value=$(getconf PATH_MAX /usr); then
if [ "$value" = "undefined" ]; then
echo PATH_MAX in /usr is infinite.
else
echo PATH_MAX in /usr is $value.
fi
else
echo Error in getconf.
fi
Notice that
sysconf(_SC_POSIX_C_BIND);
and
system("getconf POSIX2_C_BIND");
in a C program could give different answers. The sysconf
call supplies a value that corresponds to the conditions
when the program was either compiled or executed, depending
on the implementation; the system call to getconf always
supplies a value corresponding to conditions when the pro-
gram is executed.
ENVIRONMENT VARIABLES
See environ(5) for descriptions of the following environment
variables that affect the execution of getconf: LANG,
LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.
EXIT STATUS
The following exit values are returned:
0 The specified variable is valid and information about
its current state was written successfully.
>0 An error occurred.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | SUNWcsu |
|_____________________________|_____________________________|
| Interface Stability | Standard |
|_____________________________|_____________________________|
SEE ALSO
pathconf(2), confstr(3C), sysconf(3C), attributes(5),
environ(5), largefile(5), standards(5)
Man(1) output converted with
man2html