chiark - git - mdw - disorder/blob - doc/disorder_options.5.in

   1 .\"
   2 .\" Copyright (C) 2008 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 2 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, but
  10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 .\" 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, write to the Free Software
  16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  17 .\" USA
  18 .\"
  19 .TH disorder_options 5
  20 .SH NAME
  21 pkgconfdir/options - DisOrder CGI actions
  22 .SH DESCRIPTION
  23 The DisOrder CGI reads much extra configuration information from
  24 \fIpkgconfdir/options\fR.
  25 The general syntax is the same as the main configuration file (see
  26 \fBdisorder_config\fR(5)).
  27 .SH DIRECTIVES
  28 Valid directives are:
  29 .TP
  30 .B columns \fINAME\fR \fIHEADING\fR...
  31 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB.
  32 \fINAME\fR must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
  33 \fIHEADING\fR...  is a list of heading names.
  34 If a column is defined more than once then the last definitions is used.
  35 .IP
  36 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
  37 are built in.
  38 .TP
  39 .B include \fIPATH\fR
  40 Includes another file.
  41 If \fIPATH\fR starts with a \fB/\fR then it is taken as is, otherwise
  42 it is searched for in \fIpkgconfdir\fR and \fIpkgdatadir\fR.
  43 .TP
  44 .B label \fINAME\fR \fIVALUE\fR
  45 Define a label.
  46 If a label is defined more than once then the last definition is used.
  47 .SH LABELS
  48 Some labels are defined inside \fBdisorder.cgi\fR and others by the
  49 default templates.
  50 You can define your own labels and use them inside a template.
  51 .PP
  52 When an undefined label is expanded, if it has a dot in its name then
  53 the part after the final dot is used as its value.
  54 Otherwise the whole name is used as the value.
  55 .PP
  56 Labels are not individually documented here, see the shipped
  57 \fIoptions.labels\fR file instead.
  58 .SH "OPTION FILES"
  59 The shipped \fIoptions\fR file includes four standard options files.
  60 In order, they are:
  61 .TP
  62 .I options.labels
  63 The default labels file.
  64 You wouldn't normally edit this directly - instead supply your own commands
  65 in \fIoptions.user\fR.
  66 Have a look at the shipped version of the file for documentation of
  67 labels used by the standard templates.
  68 .TP
  69 .I options.user
  70 A user options file.
  71 Here you should put any overrides for the default labels and any
  72 extra labels required by your modified templates.
  73 .SH "SEE ALSO"
  74 .BR disorder_config (5),
  75 .BR disorder_templates (5),
  76 .BR disorder_actions (5),
  77 .BR disorder.cgi (8)
  78 .\" Local Variables:
  79 .\" mode:nroff
  80 .\" fill-column:79
  81 .\" End: