chiark / gitweb /
examples/disorder.init.in: Read settings from `/etc/default/disorder'.
[disorder] / doc / disorder_actions.5.head
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 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_actions 5
18 .SH NAME
19 disorder_actions - DisOrder CGI actions
20 .SH DESCRIPTION
21 The primary CGI parameter to the DisOrder web interface is \fBaction\fR.
22 This determines which of a set of actions from the list below it carries out.
23 .PP
24 For any action \fIACTION\fR not in the list, the CGI expands the template
25 \fIACTION\fB.tmpl\fR.
26 .PP
27 If no action is set, then the default is \fBplaying\fR, unless the argument
28 \fBc\fR is present, in which case it is \fBconfirm\fR.
29 This is a hack to keep confirmation URLs short.
30 .SS Redirection
31 Actions in the list below that do not documented what template they expand
32 issue an HTTP redirect according to the value of the \fBback\fR argument.
33 There are three possibilities:
34 .TP
35 .BR 1 )
36 \fBback\fR is a URL.
37 The browser is redirected to that URL.
38 .TP
39 .BR 2 )
40 \fBback\fR is an action name.
41 The browser is redirected to a URL which uses that action.
42 .TP
43 .BR 3 )
44 \fBback\fR is not set.
45 The browser is redirected to the front page.
46 .PP
47 If an action needs more rights than the logged-in user has then they are
48 redirected to \fBlogin\fR with \fBback\fR set to retry the action they wanted.
49 .PP
50 Certain errors cause a redirection to \fBerror\fR with \fB@error\fR set.
51 .SH ACTIONS
52 .\" Local Variables:
53 .\" mode:nroff
54 .\" fill-column:79
55 .\" End: