| 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 [ \-Lqv ] |
| 53 | .RB [ \-c |
| 54 | .IR conf ] |
| 55 | .RB [ \-o |
| 56 | .RI [ sect \c |
| 57 | .BR : ] \c |
| 58 | .IB var = \c |
| 59 | .IR value ] |
| 60 | .br |
| 61 | \c |
| 62 | .RB [ \-l |
| 63 | .IR sect ] |
| 64 | .RB [ \-p |
| 65 | .RI [ sect \c |
| 66 | .BR : ] \c |
| 67 | .IR var ] |
| 68 | .RB [ \-w |
| 69 | .RI [ sect \c |
| 70 | .BR : ] \c |
| 71 | .IR var ] |
| 72 | .RB [ \-x |
| 73 | .RI [ sect \c |
| 74 | .BR : ] \c |
| 75 | .IR var ] |
| 76 | . |
| 77 | .\"-------------------------------------------------------------------------- |
| 78 | .SH DESCRIPTION |
| 79 | . |
| 80 | The |
| 81 | .B query-runlisp-config |
| 82 | program assists with understanding and debugging |
| 83 | .BR runlisp.conf (5) |
| 84 | files. |
| 85 | . |
| 86 | .SS "Options" |
| 87 | The command-line options are as follows. |
| 88 | . |
| 89 | .TP |
| 90 | .BR "\-h" ", " "\-\-help" |
| 91 | Write a synopsis of |
| 92 | .BR query-runlisp-config 's |
| 93 | command-line syntax |
| 94 | and a description of the command-line options |
| 95 | to standard output |
| 96 | and immediately exit with status 0. |
| 97 | . |
| 98 | .TP |
| 99 | .BR "\-V" ", " "\-\-version" |
| 100 | Write |
| 101 | .BR query-runlisp-config 's |
| 102 | version number |
| 103 | to standard output |
| 104 | and immediately exit with status 0. |
| 105 | . |
| 106 | .TP |
| 107 | .BR "\-L" ", " "\-\-list-sections" |
| 108 | List all of the known section names to standard output. |
| 109 | . |
| 110 | .TP |
| 111 | .BI "\-c" "\fR, " "\-\-config-file=" conf |
| 112 | Read configuration from |
| 113 | .IR conf . |
| 114 | If |
| 115 | .I conf |
| 116 | is a directory, then all of the files within |
| 117 | whose names end with |
| 118 | .RB ` .conf ', |
| 119 | are loaded, in ascending lexicographical order; |
| 120 | otherwise, |
| 121 | .I conf |
| 122 | is opened as a file. |
| 123 | All of the files are expected to be as described in |
| 124 | .BR runlisp.conf (5). |
| 125 | . |
| 126 | .TP |
| 127 | .BI "\-l" "\fR, " "\-\-list-variables=" sect |
| 128 | List all of the variables assigned in section |
| 129 | .I sect |
| 130 | to standard output. |
| 131 | . |
| 132 | .TP |
| 133 | .BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value |
| 134 | Assign |
| 135 | .I value |
| 136 | to the variable |
| 137 | .I var |
| 138 | in configuration section |
| 139 | .IR sect , |
| 140 | or |
| 141 | .B @CONFIG |
| 142 | if no section is specified. |
| 143 | The value is unexpandable, |
| 144 | and overrides any similarly named setting |
| 145 | from the configuration file(s). |
| 146 | . |
| 147 | .TP |
| 148 | .BI "\-p" "\fR, " "\-\-print-variable=\fR[" sect :\fR] var |
| 149 | Print the raw (unexpanded) result of looking up the variable |
| 150 | .I var |
| 151 | in configuration section |
| 152 | .I sect |
| 153 | (defaulting to |
| 154 | .BR @CONFIG ). |
| 155 | . |
| 156 | .TP |
| 157 | .BR "\-q" ", " "\-\-quiet" |
| 158 | Don't print warning messages. |
| 159 | This option may be repeated: |
| 160 | each use reduces verbosity by one step, |
| 161 | counteracting one |
| 162 | .RB ` \-v ' |
| 163 | option. |
| 164 | The default verbosity level is 1, |
| 165 | which prints only warning measages. |
| 166 | . |
| 167 | .TP |
| 168 | .BR "\-v" ", " "\-\-verbose" |
| 169 | Print informational or debugging messages. |
| 170 | This option may be repeated: |
| 171 | each use increases verbosity by one step, |
| 172 | counteracting one |
| 173 | .RB ` \-q ' |
| 174 | option. |
| 175 | The default verbosity level is 1, |
| 176 | which prints only warning measages. |
| 177 | Higher verbosity levels print informational and debugging messages. |
| 178 | . |
| 179 | .TP |
| 180 | .BI "\-w" "\fR, " "\-\-split-variable=\fR[" sect :\fR] var |
| 181 | Print the result of looking up, expanding, and word-splitting the variable |
| 182 | .I var |
| 183 | in configuration section |
| 184 | .I sect |
| 185 | (defaulting to |
| 186 | .BR @CONFIG ). |
| 187 | The words are quoted in shell-style, and separated by spaces. |
| 188 | . |
| 189 | .TP |
| 190 | .BI "\-x" "\fR, " "\-\-expand-variable=\fR[" sect :\fR] var |
| 191 | Print the result of looking up and expanding the variable |
| 192 | .I var |
| 193 | in configuration section |
| 194 | .I sect |
| 195 | (defaulting to |
| 196 | .BR @CONFIG ). |
| 197 | . |
| 198 | .\"-------------------------------------------------------------------------- |
| 199 | . |
| 200 | .SH SEE ALSO |
| 201 | .BR dump-runlisp-image (1), |
| 202 | .BR query-runlisp-config (1), |
| 203 | .BR runlisp (1). |
| 204 | . |
| 205 | .SH AUTHOR |
| 206 | Mark Wooding, <mdw@distorted.org.uk> |
| 207 | . |
| 208 | . |
| 209 | .\"----- That's all, folks -------------------------------------------------- |