usr.bin/getconf/getconf.1

   1 .\"     $NetBSD: getconf.1,v 1.10 2006/10/07 15:20:44 elad Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by J.T. Conklin.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd October 7, 2006
  31 .Dt GETCONF 1
  32 .Os
  33 .Sh NAME
  34 .Nm getconf
  35 .Nd get configuration values
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Ar system_var
  39 .Nm
  40 .Fl a
  41 .Nm
  42 .Ar path_var
  43 .Ar pathname
  44 .Nm
  45 .Fl a
  46 .Ar pathname
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility writes the current value of a configurable system limit or
  51 option variable to the standard output.
  52 .Pp
  53 The
  54 .Ar system_var
  55 argument specifies the system variable to be queried.
  56 The names of the system variables are from
  57 .Xr sysconf 3
  58 with the leading
  59 .Dq Li _SC_
  60 removed.
  61 .Pp
  62 The
  63 .Ar path_var
  64 argument specifies the pathname variable to be queried for the specified
  65 .Ar pathname
  66 argument.
  67 The names of the pathname variables are from
  68 .Xr pathconf 2
  69 with the leading
  70 .Dq Li _PC_
  71 removed.
  72 .Pp
  73 When invoked with the option
  74 .Fl a ,
  75 .Nm
  76 writes a list of all applicable variables and their values to the
  77 standard output, in the format
  78 .Do
  79 .Va name
  80 =
  81 .Va value
  82 .Dc .
  83 .Sh EXIT STATUS
  84 The
  85 .Nm
  86 utility exits 0 on success, and \*[Gt]0 if an error occurs.
  87 .Sh SEE ALSO
  88 .Xr pathconf 2 ,
  89 .Xr confstr 3 ,
  90 .Xr sysconf 3
  91 .Sh STANDARDS
  92 The
  93 .Nm
  94 utility conforms to
  95 .St -p1003.2-92 .