Mercurial > p > roundup > code

annotate doc/roundup-server.1 @ 4026:c8b0a23ba38d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix issue2550493: hide 'hidden' files.
author Stefan Seefeld <stefan@seefeld.name>
date Mon, 09 Feb 2009 17:47:12 +0000
parents daedf66344f7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
3880
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 2632
diff changeset
24 \fB-i\fP \fIfile\fP
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 2632
diff changeset
25 Sets a filename to use as a template for generating the tracker index page.
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 2632
diff changeset
26 The variable "trackers" is available to the template and is a dict of all
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 2632
diff changeset
27 configured trackers.
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 2632
diff changeset
28 .TP
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
29 \fB-s\fP
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
30 Enables to use of SSL.
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
31 .TP
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
32 \fB-e\fP \fIfile\fP
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
33 Sets a filename containing the PEM file to use for SSL. If left blank, a
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
34 temporary self-signed certificate will be used.
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
35 .TP
1419
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 \fB-h\fP
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 print help
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 .TP
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 \fBname=\fP\fItracker home\fP
3911
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
40 Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
41 identified in the URL (it's the first part of the URL path). The \fItracker
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
42 home\fP variable is the directory that was identified when you did
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
43 "roundup-admin init". You may specify any number of these name=home pairs on
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
44 the command-line. For convenience, you may edit the TRACKER_HOMES variable in
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
45 the roundup-server file instead. Make sure the name part doesn't include any
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
46 url-unsafe characters like spaces, as these confuse the cookie handling in
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
47 browsers like IE.
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
48 .SH EXAMPLES
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
49 .TP
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
50 .B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
51 Start the server on port \fB9000\fP serving two trackers; one under
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
52 \fB/bugs\fP and one under \fB/reqs\fP.
daedf66344f7 add an example to roundup-server's man page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3883
diff changeset
53
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 1419
diff changeset
54 .SH CONFIGURATION FILE
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 1419
diff changeset
55 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
56 .SH AUTHOR
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 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
58 <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
59
c717b8d63a7e included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 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
61 <richard@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/