3 .\" Manual for `query-runlisp-config'
5 .\" (c) 2020 Mark Wooding
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of Runlisp, a tool for invoking Common Lisp scripts.
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.
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
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/>.
40 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
43 .\"--------------------------------------------------------------------------
44 .TH query-runlisp-config 1 "2 August 2020" "Mark Wooding"
46 query-runlisp-config \- inspect and debug runlisp configuration files
48 .\"--------------------------------------------------------------------------
51 .B query-runlisp-config
78 .\"--------------------------------------------------------------------------
82 .B query-runlisp-config
83 program assists with understanding and debugging
88 The command-line options are as follows.
91 .BR "\-h" ", " "\-\-help"
93 .BR query-runlisp-config 's
95 and a description of the command-line options
97 and immediately exit with status 0.
100 .BR "\-V" ", " "\-\-version"
102 .BR query-runlisp-config 's
105 and immediately exit with status 0.
108 .BR "\-L" ", " "\-\-list-sections"
109 List all of the known section names to standard output.
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
120 .BR \-\-no-machine-readable .
123 .BI "\-c" "\fR, " "\-\-config-file=" conf
124 Read configuration from
128 is a directory, then all of the files within
131 are loaded, in ascending lexicographical order;
135 All of the files are expected to be as described in
136 .BR runlisp.conf (5).
139 .BI "\-l" "\fR, " "\-\-list-variables=" sect
140 List all of the variables assigned in section
145 .BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value
150 in configuration section
154 if no section is specified.
155 The value is unexpandable,
156 and overrides any similarly named setting
157 from the configuration file(s).
160 .BI "\-p" "\fR, " "\-\-print-variable=\fR[" sect :\fR] var
161 Print the raw (unexpanded) result of looking up the variable
163 in configuration section
169 .BR "\-q" ", " "\-\-quiet"
170 Don't print warning messages.
171 This option may be repeated:
172 each use reduces verbosity by one step,
176 The default verbosity level is 1,
177 which prints only warning measages.
180 .BR "\-v" ", " "\-\-verbose"
181 Print informational or debugging messages.
182 This option may be repeated:
183 each use increases verbosity by one step,
187 The default verbosity level is 1,
188 which prints only warning measages.
189 Higher verbosity levels print informational and debugging messages.
192 .BI "\-w" "\fR, " "\-\-split-variable=\fR[" sect :\fR] var
193 Print the result of looking up, expanding, and word-splitting the variable
195 in configuration section
199 The words are quoted in shell-style, and separated by spaces.
202 .BI "\-x" "\fR, " "\-\-expand-variable=\fR[" sect :\fR] var
203 Print the result of looking up and expanding the variable
205 in configuration section
210 .\"--------------------------------------------------------------------------
213 .BR dump-runlisp-image (1),
214 .BR query-runlisp-config (1),
218 Mark Wooding, <mdw@distorted.org.uk>
221 .\"----- That's all, folks --------------------------------------------------