mdw@git.distorted.org.uk Git - runlisp/blob - query-runlisp-config.1.in

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" Manual for `query-runlisp-config'
   4 .\"
   5 .\" (c) 2020 Mark Wooding
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of Runlisp, a tool for invoking Common Lisp scripts.
  11 .\"
  12 .\" Runlisp is free software: you can redistribute it and/or modify it
  13 .\" under the terms of the GNU General Public License as published by the
  14 .\" Free Software Foundation; either version 3 of the License, or (at your
  15 .\" option) any later version.
  16 .\"
  17 .\" Runlisp is distributed in the hope that it will be useful, but WITHOUT
  18 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 .\" for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public License
  23 .\" along with Runlisp.  If not, see <https://www.gnu.org/licenses/>.
  24 ..
  25 .ie t \{\
  26 .  ds o \(bu
  27 .  if \n(.g \{\
  28 .    fam P
  29 .    ev an-1
  30 .    fam P
  31 .    ev
  32 .  \}
  33 .\}
  34 .el \{\
  35 .  ds o o
  36 .\}
  37 .
  38 .de hP
  39 .IP
  40 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
  41 ..
  42 .
  43 .\"--------------------------------------------------------------------------
  44 .TH query-runlisp-config 1 "2 August 2020" "Mark Wooding"
  45 .SH NAME
  46 query-runlisp-config \- inspect and debug runlisp configuration files
  47 .
  48 .\"--------------------------------------------------------------------------
  49 .SH SYNOPSIS
  50 .
  51 .B query-runlisp-config
  52 .RB [ \-LMqv ]
  53 .RB [ +M ]
  54 .RB [ \-c
  55 .IR conf ]
  56 .RB [ \-o
  57 .RI [ sect \c
  58 .BR : ] \c
  59 .IB var = \c
  60 .IR value ]
  61 .br
  62         \c
  63 .RB [ \-l
  64 .IR sect ]
  65 .RB [ \-p
  66 .RI [ sect \c
  67 .BR : ] \c
  68 .IR var ]
  69 .RB [ \-w
  70 .RI [ sect \c
  71 .BR : ] \c
  72 .IR var ]
  73 .RB [ \-x
  74 .RI [ sect \c
  75 .BR : ] \c
  76 .IR var ]
  77 .
  78 .\"--------------------------------------------------------------------------
  79 .SH DESCRIPTION
  80 .
  81 The
  82 .B query-runlisp-config
  83 program assists with understanding and debugging
  84 .BR runlisp.conf (5)
  85 files.
  86 .
  87 .SS "Options"
  88 The command-line options are as follows.
  89 .
  90 .TP
  91 .BR "\-h" ", " "\-\-help"
  92 Write a synopsis of
  93 .BR query-runlisp-config 's
  94 command-line syntax
  95 and a description of the command-line options
  96 to standard output
  97 and immediately exit with status 0.
  98 .
  99 .TP
 100 .BR "\-V" ", " "\-\-version"
 101 Write
 102 .BR query-runlisp-config 's
 103 version number
 104 to standard output
 105 and immediately exit with status 0.
 106 .
 107 .TP
 108 .BR "\-L" ", " "\-\-list-sections"
 109 List all of the known section names to standard output.
 110 .
 111 .TP
 112 .BR "\-M" ", " "\-\-machine-readable"
 113 Don't print prefixes or header lines to the output.
 114 This makes it easier to use
 115 .B query-runlisp-config
 116 from simple scripts.
 117 Negate with
 118 .B  +M
 119 or
 120 .BR \-\-no-machine-readable .
 121 .
 122 .TP
 123 .BI "\-c" "\fR, " "\-\-config-file=" conf
 124 Read configuration from
 125 .IR conf .
 126 If
 127 .I conf
 128 is a directory, then all of the files within
 129 whose names end with
 130 .RB ` .conf ',
 131 are loaded, in ascending lexicographical order;
 132 otherwise,
 133 .I conf
 134 is opened as a file.
 135 All of the files are expected to be as described in
 136 .BR runlisp.conf (5).
 137 .
 138 .TP
 139 .BI "\-l" "\fR, " "\-\-list-variables=" sect
 140 List all of the variables assigned in section
 141 .I sect
 142 to standard output.
 143 .
 144 .TP
 145 .BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value
 146 Assign
 147 .I value
 148 to the variable
 149 .I var
 150 in configuration section
 151 .IR sect ,
 152 or
 153 .B @CONFIG
 154 if no section is specified.
 155 The value is unexpandable,
 156 and overrides any similarly named setting
 157 from the configuration file(s).
 158 .
 159 .TP
 160 .BI "\-p" "\fR, " "\-\-print-variable=\fR[" sect :\fR] var
 161 Print the raw (unexpanded) result of looking up the variable
 162 .I var
 163 in configuration section
 164 .I sect
 165 (defaulting to
 166 .BR @CONFIG ).
 167 .
 168 .TP
 169 .BR "\-q" ", " "\-\-quiet"
 170 Don't print warning messages.
 171 This option may be repeated:
 172 each use reduces verbosity by one step,
 173 counteracting one
 174 .RB ` \-v '
 175 option.
 176 The default verbosity level is 1,
 177 which prints only warning measages.
 178 .
 179 .TP
 180 .BR "\-v" ", " "\-\-verbose"
 181 Print informational or debugging messages.
 182 This option may be repeated:
 183 each use increases verbosity by one step,
 184 counteracting one
 185 .RB ` \-q '
 186 option.
 187 The default verbosity level is 1,
 188 which prints only warning measages.
 189 Higher verbosity levels print informational and debugging messages.
 190 .
 191 .TP
 192 .BI "\-w" "\fR, " "\-\-split-variable=\fR[" sect :\fR] var
 193 Print the result of looking up, expanding, and word-splitting the variable
 194 .I var
 195 in configuration section
 196 .I sect
 197 (defaulting to
 198 .BR @CONFIG ).
 199 The words are quoted in shell-style, and separated by spaces.
 200 .
 201 .TP
 202 .BI "\-x" "\fR, " "\-\-expand-variable=\fR[" sect :\fR] var
 203 Print the result of looking up and expanding the variable
 204 .I var
 205 in configuration section
 206 .I sect
 207 (defaulting to
 208 .BR @CONFIG ).
 209 .
 210 .\"--------------------------------------------------------------------------
 211 .
 212 .SH SEE ALSO
 213 .BR dump-runlisp-image (1),
 214 .BR query-runlisp-config (1),
 215 .BR runlisp (1).
 216 .
 217 .SH AUTHOR
 218 Mark Wooding, <mdw@distorted.org.uk>
 219 .
 220 .
 221 .\"----- That's all, folks --------------------------------------------------