Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
User Commandsgetconf(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 standard 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 standard 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 conditions 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_MAXNAME_MAXPOSIX_CHOWN_RESTRICTED
MAX_CANONPATH_MAXPOSIX_NO_TRUNC
MAX_INPUTPIPE_BUFPOSIX_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_MAXBC_BASE_MAX
BC_DIM_MAXBC_SCALE_MAX
BC_STRING_MAXCHAR_BIT
CHARCLASS_NAME_MAXCHAR_MAX
CHAR_MINCHILD_MAX
CLK_TCKCOLL_WEIGHTS_MAX
CS_PATHEXPR_NEST_MAX
INT_MAXINT_MIN
LFS64_CFLAGSLFS64_LDFLAGS
LFS64_LIBSLFS64_LINTFLAGS
LFS_CFLAGSLFS_LDFLAGS
LFS_LIBSLFS_LINTFLAGS
LINE_MAXLONG_BIT
LONG_MAXLONG_MIN
MB_LEN_MAXNGROUPS_MAX
NL_ARGMAXNL_LANGMAX
NL_MSGMAXNL_NMAX
NL_SETMAXNL_TEXTMAX
NZEROOPEN_MAX
POSIX2_BC_BASE_MAXPOSIX2_BC_DIM_MAX
POSIX2_BC_SCALE_MAXPOSIX2_BC_STRING_MAX
POSIX2_C_BINDPOSIX2_C_DEV
POSIX2_CHAR_TERMPOSIX2_COLL_WEIGHTS_MAX
POSIX2_C_VERSIONPOSIX2_EXPR_NEST_MAX
POSIX2_FORT_DEVPOSIX2_FORT_RUN
POSIX2_LINE_MAXPOSIX2_LOCALEDEF
POSIX2_RE_DUP_MAXPOSIX2_SW_DEV
POSIX2_UPEPOSIX2_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_MAXSCHAR_MAX
SCHAR_MINSHRT_MAX
SHRT_MINSSIZE_MAX
STREAM_MAXTMP_MAX
TZNAME_MAXUCHAR_MAX
UINT_MAXULONG_MAX
USHRT_MAXWORD_BIT
XBS5_ILP32_OFF32XBS5_ILP32_OFF32_CFLAGS
XBS5_ILP32_OFF32_LDFLAGSXBS5_ILP32_OFF32_LIBS
XBS5_ILP32_OFF32_LINTFLAGSXBS5_ILP32_OFFBIG
XBS5_ILP32_OFFBIG_CFLAGSXBS5_ILP32_OFFBIG_LDFLAGS
XBS5_ILP32_OFFBIG_LIBSXBS5_ILP32_OFFBIG_LINTFLAGS
XBS5_LP64_OFF64XBS5_LP64_OFF64_CFLAGS
XBS5_LP64_OFF64_LDFLAGSXBS5_LP64_OFF64_LIBS
XBS5_LP64_OFF64_LINTFLAGSXBS5_LPBIG_OFFBIG
XBS5_LPBIG_OFFBIG_CFLAGSXBS5_LPBIG_OFFBIG_LDFLAGS
XBS5_LPBIG_OFFBIG_LIBSXBS5_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 ( 231 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

Note 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 program is executed.

ENVIRONMENT VARIABLES

 

See environ(5) for descriptions of the following environment variables that affect the execution of getconf: 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 attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWcsu

SEE ALSO

 

pathconf(2), confstr(3C), sysconf(3C), attributes(5), environ(5), largefile(5)

SunOS 5.9Go To TopLast Changed 30 Jan 1998
 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.