xref: /openbsd/usr.bin/getconf/getconf.1 (revision 2d77330e)
1.\"	$OpenBSD: getconf.1,v 1.13 2013/03/02 07:08:22 jmc Exp $
2.\"	$NetBSD: getconf.1,v 1.2 1996/04/20 01:15:12 jtc Exp $
3.\"
4.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to The NetBSD Foundation
8.\" by J.T. Conklin.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"      This product includes software developed by Winning Strategies, Inc.
21.\" 4. The name of the author may not be used to endorse or promote products
22.\"    derived from this software without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34.\"
35.\"
36.Dd $Mdocdate: March 2 2013 $
37.Dt GETCONF 1
38.Os
39.Sh NAME
40.Nm getconf
41.Nd get configuration values
42.Sh SYNOPSIS
43.Nm getconf
44.Op Fl Ll
45.Op Fl v Ar specification
46.Ar name
47.Op Ar pathname
48.Sh DESCRIPTION
49The
50.Nm
51utility writes the current value of a configurable system limit or
52option variable to the standard output.
53.Pp
54The
55.Ar name
56argument specifies the system variable to be queried.
57The
58.Ar pathname
59argument must be supplied for system variables associated with a
60pathname.
61.Pp
62The options are as follows:
63.Bl -tag -width Ds
64.It Fl L
65List the system variables that can be used with the
66.Nm
67utility that require a
68.Ar pathname
69argument.
70.It Fl l
71List the system variables that can be used with the
72.Nm
73utility without a
74.Ar pathname
75argument.
76.It Fl v Ar specification
77Indicate a specific version and compilation environment for which
78configuration variables shall be queried.
79.Ox
80does not change behavior for different compilation environments,
81so the argument to this option is only checked for validity.
82.El
83.Sh EXIT STATUS
84.Ex -std getconf
85.Sh SEE ALSO
86.Xr pathconf 2 ,
87.Xr confstr 3 ,
88.Xr sysconf 3
89.Sh STANDARDS
90The
91.Nm
92utility is compliant with the
93.St -p1003.1-2008
94specification.
95.Pp
96The flags
97.Op Fl Ll
98are extensions to that specification.
99