Mercurial > p > roundup > code
annotate doc/roundup-server.1 @ 3696:790363e96852
Sorting/grouping by multiple properties.
- Implement sorting/grouping by multiple properties for the web
interface. I'm now using @sort0/@sortdir0,@sort1/@sortdir1,... and
@group0/@groupdir0,... when generating URLs from a search template.
These are converted to a list internally. When saving URLs (e.g. when
storing queries) I'm using @sort=prop1,prop2,... and @group=... with
optional '-' prepended to individual props.
This means saved URLs are backward compatible with existing trackers
(and yes, this was a design goal).
I need the clumsy version with @sort0,@sort1 etc, because I'm
currently using several selectors and checkboxes (as the classic
template does, too). I don't think there is a way around that in HTML?
- Updated (hopefully all) documentation to reflect the new URL format
and the consequences in the web-interface.
- I've set the number of sort/group properties in the classic template
to two -- this can easily be reverted by changing n_sort to 1.
Richard, would you look over these changes? I've set a tag before and
(will set) after commit, so that it would be easy to merge out.
Don't be too scared about the size of the change, most is documentation,
the guts are in cgi/templating.py and small changes in the classic
template.
| author | Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net> |
|---|---|
| date | Wed, 30 Aug 2006 20:28:26 +0000 |
| parents | 9c55f2bc5961 |
| children | 2359d6304a4f |
| rev | line source |
|---|---|
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
1 .TH ROUNDUP-SERVER 1 "27 July 2004" |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 .SH NAME |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
3 roundup-server \- start roundup web server |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 .SH SYNOPSIS |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
5 \fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]* |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
6 .SH OPTIONS |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 .TP |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
8 \fB-C\fP \fIfile\fP |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
9 Use options read from the configuration file (see below). |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
10 .TP |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 \fB-n\fP \fIhostname\fP |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
12 Sets the host name. |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 .TP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 \fB-p\fP \fIport\fP |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
15 Sets the port to listen on. |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
16 .TP |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
17 \fB-d\fP \fIfile\fP |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
18 Daemonize, and write the server's PID to the nominated file. |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 .TP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 \fB-l\fP \fIfile\fP |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
21 Sets a filename to log to (instead of stdout). This is required if the -d |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
22 option is used. |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 .TP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 \fB-h\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 print help |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 .TP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 \fBname=\fP\fItracker home\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 Sets the tracker home(s) to use. The name is how the tracker is |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 identified in the URL (it's the first part of the URL path). The |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 tracker home is the directory that was identified when you did |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 "roundup-admin init". You may specify any number of these name=home |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 pairs on the command-line. For convenience, you may edit the |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 TRACKER_HOMES variable in the roundup-server file instead. |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 Make sure the name part doesn't include any url-unsafe characters like |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 spaces, as these confuse the cookie handling in browsers like IE. |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
36 .SH CONFIGURATION FILE |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
37 See the "admin_guide" in the Roundup "doc" directory. |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 .SH AUTHOR |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 This manpage was written by Bastian Kleineidam |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
40 <calvin@debian.org> for the Debian distribution of roundup. |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 The main author of roundup is Richard Jones |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 <richard@users.sourceforge.net>. |
