From 52eb352e78517ec70f1b3c626a49f789274c8caa Mon Sep 17 00:00:00 2001
From: Andrew Wilcox <AWilcox@Wilcox-Tech.com>
Date: Sat, 9 Apr 2016 11:31:47 -0500
Subject: Add our first utility, getconf(1)

---
 getconf/getconf.1 | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 getconf/getconf.1

(limited to 'getconf/getconf.1')

diff --git a/getconf/getconf.1 b/getconf/getconf.1
new file mode 100644
index 0000000..35f9c13
--- /dev/null
+++ b/getconf/getconf.1
@@ -0,0 +1,110 @@
+.Dd April 9, 2016
+.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.
+
+Valid system variables are one of the following:
+
+.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
+
+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.
+
+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.
+.Pp
+.Ar path_var
+variables are not yet supported.
-- 
cgit v1.2.3-60-g2f50