path: root/getconf/getconf.1

.Dd August 21, 2018
.Dt GETCONF 1 "Base Commands Manual"
.Os "Adélie Linux"
.Sh NAME
.Nm getconf
.Nd get system configuration values
.Sh SYNOPSIS
.Nm
.Op Fl v Ar specification
.Ar system_var
.Nm
.Op Fl v Ar specification
.Ar path_var
.Ar pathname
.Sh DESCRIPTION
In the first form, the
.Nm
utility prints the value of the system variable specified by
.Ar system_var
on the currently running system, under the specification given for the
.Fl v
argument if specified.
.Pp
Valid system variables are one of the following:
.Pp
.Bl -bullet -offset indent -compact
.It
The variable name of a valid parameter to the
.Xr sysconf 3
function as specified in
.St -p1003.1-2008 ,
excluding braces.  The variables
.Dq _SC_CLK_TCK ,
.Dq _SC_GETGR_R_SIZE_MAX ,
and
.Dq _SC_GETPW_R_SIZE_MAX
are not supported.
.It
A valid parameter to the
.Xr confstr 3
function as specified in
.St -p1003.1-2008 ,
excluding the
.Dq _CS_
prefix.
.It
A constant listed under the
.Dq Maximum Values
or
.Dq Minimum Values
section of the
.Aq Pa limits.h
header as specified in
.St -p1003.1-2008 ,
excluding braces.
.El
.Pp
In the second form, the
.Nm
utility prints the value of the path variable specified by
.Ar path_var
for the path specified by
.Ar pathname
on the currently running system, under the specification given for the
.Fl v
argument if specified.
.Pp
Valid path variables are those accepted by the
.Xr fpathconf 3
function as specified in
.St -p1003.1-2008 ,
exluding braces.
.Sh OPTIONS
.Bl -tag
.It -v
Indicates the specification to use.  Currently, this option is unsupported and
will be ignored.
.El
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
.Xr confstr 3 ,
.Xr fpathconf 3 ,
.Xr sysconf 3 .
.Sh STANDARDS
The eventual goal for the
.Nm
utility is full conformance to
.St -p1003.1 2013 Edition.
.Sh AUTHORS
.An A. Wilcox
.Aq awilfox@adelielinux.org
.Sh BUGS
The
.Fl v
argument is not currently handled correctly.