chiark / gitweb /
Switch to GPL v3
[disorder] / doc / disorder_options.5.in
CommitLineData
5c1ae3bc
RK
1.\"
2.\" Copyright (C) 2008 Richard Kettlewell
3.\"
e7eb3a27 4.\" This program is free software: you can redistribute it and/or modify
5c1ae3bc 5.\" it under the terms of the GNU General Public License as published by
e7eb3a27 6.\" the Free Software Foundation, either version 3 of the License, or
5c1ae3bc 7.\" (at your option) any later version.
e7eb3a27
RK
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.\"
5c1ae3bc 14.\" You should have received a copy of the GNU General Public License
e7eb3a27 15.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
5c1ae3bc
RK
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 columns \fINAME\fR \fIHEADING\fR...
29Defines the columns used in \fB@playing@\fR and \fB@recent@\fB.
30\fINAME\fR must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
31\fIHEADING\fR... is a list of heading names.
32If a column is defined more than once then the last definitions is used.
33.IP
34The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
35are built in.
36.TP
37.B include \fIPATH\fR
38Includes another file.
39If \fIPATH\fR starts with a \fB/\fR then it is taken as is, otherwise
40it is searched for in \fIpkgconfdir\fR and \fIpkgdatadir\fR.
41.TP
42.B label \fINAME\fR \fIVALUE\fR
43Define a label.
44If a label is defined more than once then the last definition is used.
45.SH LABELS
46Some labels are defined inside \fBdisorder.cgi\fR and others by the
47default templates.
48You can define your own labels and use them inside a template.
49.PP
50When an undefined label is expanded, if it has a dot in its name then
51the part after the final dot is used as its value.
52Otherwise the whole name is used as the value.
53.PP
54Labels are not individually documented here, see the shipped
55\fIoptions.labels\fR file instead.
56.SH "OPTION FILES"
57The shipped \fIoptions\fR file includes four standard options files.
58In order, they are:
59.TP
60.I options.labels
61The default labels file.
62You wouldn't normally edit this directly - instead supply your own commands
63in \fIoptions.user\fR.
64Have a look at the shipped version of the file for documentation of
65labels used by the standard templates.
66.TP
67.I options.user
68A user options file.
69Here you should put any overrides for the default labels and any
70extra labels required by your modified templates.
71.SH "SEE ALSO"
72.BR disorder_config (5),
73.BR disorder_templates (5),
74.BR disorder_actions (5),
75.BR disorder.cgi (8)
76.\" Local Variables:
77.\" mode:nroff
78.\" fill-column:79
79.\" End: