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
77 .\"--------------------------------------------------------------------------
81 .B query-runlisp-config
82 program assists with understanding and debugging
87 The command-line options are as follows.
90 .BR "\-h" ", " "\-\-help"
92 .BR query-runlisp-config 's
94 and a description of the command-line options
96 and immediately exit with status 0.
99 .BR "\-V" ", " "\-\-version"
101 .BR query-runlisp-config 's
104 and immediately exit with status 0.
107 .BR "\-L" ", " "\-\-list-sections"
108 List all of the known section names to standard output.
111 .BI "\-c" "\fR, " "\-\-config-file=" conf
112 Read configuration from
116 is a directory, then all of the files within
119 are loaded, in ascending lexicographical order;
123 All of the files are expected to be as described in
124 .BR runlisp.conf (5).
127 .BI "\-l" "\fR, " "\-\-list-variables=" sect
128 List all of the variables assigned in section
133 .BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value
138 in configuration section
142 if no section is specified.
143 The value is unexpandable,
144 and overrides any similarly named setting
145 from the configuration file(s).
148 .BI "\-p" "\fR, " "\-\-print-variable=\fR[" sect :\fR] var
149 Print the raw (unexpanded) result of looking up the variable
151 in configuration section
157 .BR "\-q" ", " "\-\-quiet"
158 Don't print warning messages.
159 This option may be repeated:
160 each use reduces verbosity by one step,
164 The default verbosity level is 1,
165 which prints only warning measages.
168 .BR "\-v" ", " "\-\-verbose"
169 Print informational or debugging messages.
170 This option may be repeated:
171 each use increases verbosity by one step,
175 The default verbosity level is 1,
176 which prints only warning measages.
177 Higher verbosity levels print informational and debugging messages.
180 .BI "\-w" "\fR, " "\-\-split-variable=\fR[" sect :\fR] var
181 Print the result of looking up, expanding, and word-splitting the variable
183 in configuration section
187 The words are quoted in shell-style, and separated by spaces.
190 .BI "\-x" "\fR, " "\-\-expand-variable=\fR[" sect :\fR] var
191 Print the result of looking up and expanding the variable
193 in configuration section
198 .\"--------------------------------------------------------------------------
201 .BR dump-runlisp-image (1),
202 .BR query-runlisp-config (1),
206 Mark Wooding, <mdw@distorted.org.uk>
209 .\"----- That's all, folks --------------------------------------------------