~mdw / runlisp / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
@@@ more wip
[runlisp] / query-runlisp-config.1
CommitLineData
8996f767
MW		 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
46query-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
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.
80The
81.B query-runlisp-config
82program assists with understanding and debugging
83.BR runlisp.conf (5)
84files.
85.
86.SS "Options"
87The command-line options are as follows.
88.
89.TP
90.BR "\-h" ", " "\-\-help"
91Write a synopsis of
92.BR query-runlisp-config 's
93command-line syntax
94and a description of the command-line options
95to standard output
96and immediately exit with status 0.
97.
98.TP
99.BR "\-V" ", " "\-\-version"
100Write
101.BR query-runlisp-config 's
102version number
103to standard output
104and immediately exit with status 0.
105.
106.TP
107.BR "\-L" ", " "\-\-list-sections"
108List all of the known section names to standard output.
109.
110.TP
111.BI "\-c" "\fR, " "\-\-config-file=" conf
112Read configuration from
113.IR conf .
114If
115.I conf
116is a directory, then all of the files within
117whose names end with
118.RB ` .conf ',
119are loaded, in ascending lexicographical order;
120otherwise,
121.I conf
122is opened as a file.
123All of the files are expected to as described in
124.BR runlisp.conf (5).
125.
126.TP
127.BI "\-l" "\fR, " "\-\-list-variables=" sect
128List all of the variables assigned in section
129.I sect
130to standard output.
131.
132.TP
133.BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value
134Assign
135.I value
136to the variable
137.I var
138in configuration section
139.IR sect ,
140or
141.B @CONFIG
142if no section is specified.
143The value is unexpandable,
144and overrides any similarly named setting
145from the configuration file(s).
146.
147
148
149.
150.\"--------------------------------------------------------------------------
151.
152.SH BUGS
153.hP \*o
154.
155.SH SEE ALSO
156.BR dump-runlisp-image (1),
157.BR query-runlisp-config (1),
158.BR runlisp (1).
159.
160.SH AUTHOR
161Mark Wooding, <mdw@distorted.org.uk>
162.
163.
164.\"----- That's all, folks --------------------------------------------------
Run Common Lisp programs from the command line.