doc/kyua-config.1.in

   1 .\" Copyright 2012 The Kyua Authors.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\" * Redistributions of source code must retain the above copyright
   9 .\"   notice, this list of conditions and the following disclaimer.
  10 .\" * Redistributions in binary form must reproduce the above copyright
  11 .\"   notice, this list of conditions and the following disclaimer in the
  12 .\"   documentation and/or other materials provided with the distribution.
  13 .\" * Neither the name of Google Inc. nor the names of its contributors
  14 .\"   may be used to endorse or promote products derived from this software
  15 .\"   without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .Dd September 9, 2012
  29 .Dt KYUA-CONFIG 1
  30 .Os
  31 .Sh NAME
  32 .Nm "kyua config"
  33 .Nd Inspects the values of the loaded configuration
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Ar variable1 .. variableN
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 command provides a way to list all defined configuration variables and
  41 their current values.
  42 .Pp
  43 This command is intended to help you in resolving the values of the
  44 configuration variables without having to scan over configuration files.
  45 .Pp
  46 In the default synopsis form (no arguments), the command prints all
  47 configuration variables.
  48 If any arguments are provided, the command will only print the
  49 requested variables.
  50 .Sh EXIT STATUS
  51 The
  52 .Nm
  53 command returns 0 on success or 1 if any of the specified configuration
  54 variables does not exist.
  55 .Pp
  56 Additional exit codes may be returned as described in
  57 .Xr kyua 1 .
  58 .Sh SEE ALSO
  59 .Xr kyua 1