Annotation of src/usr.bin/getconf/getconf.1, Revision 1.13
1.13 ! jmc 1: .\" $OpenBSD: getconf.1,v 1.12 2013/03/02 05:33:41 guenther Exp $
1.2 deraadt 2: .\" $NetBSD: getconf.1,v 1.2 1996/04/20 01:15:12 jtc Exp $
3: .\"
4: .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
1.1 deraadt 5: .\" All rights reserved.
6: .\"
1.2 deraadt 7: .\" This code is derived from software contributed to The NetBSD Foundation
8: .\" by J.T. Conklin.
9: .\"
1.1 deraadt 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: .\"
1.13 ! jmc 36: .Dd $Mdocdate: March 2 2013 $
1.1 deraadt 37: .Dt GETCONF 1
38: .Os
39: .Sh NAME
40: .Nm getconf
41: .Nd get configuration values
42: .Sh SYNOPSIS
43: .Nm getconf
1.12 guenther 44: .Op Fl Ll
45: .Op Fl v Ar specification
1.1 deraadt 46: .Ar name
47: .Op Ar pathname
48: .Sh DESCRIPTION
49: The
1.5 aaron 50: .Nm
51: utility writes the current value of a configurable system limit or
1.1 deraadt 52: option variable to the standard output.
53: .Pp
54: The
55: .Ar name
1.4 aaron 56: argument specifies the system variable to be queried.
1.5 aaron 57: The
58: .Ar pathname
1.1 deraadt 59: argument must be supplied for system variables associated with a
60: pathname.
1.12 guenther 61: .Pp
62: The options are as follows:
63: .Bl -tag -width Ds
64: .It Fl L
65: List the system variables that can be used with the
66: .Nm
67: utility that require a
68: .Ar pathname
69: argument.
70: .It Fl l
71: List the system variables that can be used with the
72: .Nm
73: utility without a
74: .Ar pathname
75: argument.
76: .It Fl v Ar specification
77: Indicate a specific version and compilation environment for which
78: configuration variables shall be queried.
1.13 ! jmc 79: .Ox
! 80: does not change behavior for different compilation environments,
1.12 guenther 81: so the argument to this option is only checked for validity.
82: .El
1.11 jmc 83: .Sh EXIT STATUS
1.9 sobrado 84: .Ex -std getconf
1.1 deraadt 85: .Sh SEE ALSO
86: .Xr pathconf 2 ,
87: .Xr confstr 3 ,
88: .Xr sysconf 3
89: .Sh STANDARDS
90: The
1.5 aaron 91: .Nm
1.7 jmc 92: utility is compliant with the
1.10 jmc 93: .St -p1003.1-2008
1.7 jmc 94: specification.
1.12 guenther 95: .Pp
96: The flags
97: .Op Fl Ll
98: are extensions to that specification.