chiark / gitweb /
Merge branch 'master' of git.distorted.org.uk:~mdw/publish/public-git/disorder
[disorder] / doc / disorder_options.5.in
... / ...
CommitLineData
1.\"
2.\" Copyright (C) 2008, 2011 Richard Kettlewell
3.\"
4.\" This program is free software: you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation, either version 3 of the License, or
7.\" (at your option) any later version.
8.\"
9.\" This program is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
16.\"
17.TH disorder_options 5
18.SH NAME
19pkgconfdir/options - DisOrder CGI actions
20.SH DESCRIPTION
21The DisOrder CGI reads much extra configuration information from
22\fIpkgconfdir/options\fR.
23The general syntax is the same as the main configuration file (see
24\fBdisorder_config\fR(5)).
25.SH DIRECTIVES
26Valid directives are:
27.TP
28.B include \fIPATH\fR
29Includes another file.
30If \fIPATH\fR starts with a \fB/\fR then it is taken as is, otherwise
31it is searched for in \fIpkgconfdir\fR and \fIpkgdatadir\fR.
32.TP
33.B label \fINAME\fR \fIVALUE\fR
34Define a label.
35If a label is defined more than once then the last definition is used.
36.SH LABELS
37Some labels are defined inside \fBdisorder.cgi\fR and others by the
38default templates.
39You can define your own labels and use them inside a template.
40.PP
41When an undefined label is expanded, if it has a dot in its name then
42the part after the final dot is used as its value.
43Otherwise the whole name is used as the value.
44.PP
45Labels are not individually documented here, see the shipped
46\fIoptions.labels\fR file instead.
47.SH "OPTION FILES"
48The shipped \fIoptions\fR file includes two standard options files.
49In order, they are:
50.TP
51.I options.labels
52The default labels file.
53You wouldn't normally edit this directly - instead supply your own commands
54in \fIoptions.user\fR.
55Have a look at the shipped version of the file for documentation of
56labels used by the standard templates.
57.TP
58.I options.user
59A user options file.
60Here you should put any overrides for the default labels and any
61extra labels required by your modified templates.
62.SH "SEE ALSO"
63.BR disorder_config (5),
64.BR disorder_templates (5),
65.BR disorder_actions (5),
66.BR disorder.cgi (8)
67.\" Local Variables:
68.\" mode:nroff
69.\" fill-column:79
70.\" End: