Skip to content

Commit 063200f

Browse files
author
Justus Pendleton
committed
add an example to roundup-server's man page
I also made a slight change to the name=tracker_instance portion to hopefully clarify that "name" is a variable. hopefully this will eliminate some of the confusion in [SF#1637358] Suggestions about better clarifications are welcome :)
1 parent 4c0189b commit 063200f

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

doc/roundup-server.1

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,20 @@ temporary self-signed certificate will be used.
3737
print help
3838
.TP
3939
\fBname=\fP\fItracker home\fP
40-
Sets the tracker home(s) to use. The name is how the tracker is
41-
identified in the URL (it's the first part of the URL path). The
42-
tracker home is the directory that was identified when you did
43-
"roundup-admin init". You may specify any number of these name=home
44-
pairs on the command-line. For convenience, you may edit the
45-
TRACKER_HOMES variable in the roundup-server file instead.
46-
Make sure the name part doesn't include any url-unsafe characters like
47-
spaces, as these confuse the cookie handling in browsers like IE.
40+
Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is
41+
identified in the URL (it's the first part of the URL path). The \fItracker
42+
home\fP variable is the directory that was identified when you did
43+
"roundup-admin init". You may specify any number of these name=home pairs on
44+
the command-line. For convenience, you may edit the TRACKER_HOMES variable in
45+
the roundup-server file instead. Make sure the name part doesn't include any
46+
url-unsafe characters like spaces, as these confuse the cookie handling in
47+
browsers like IE.
48+
.SH EXAMPLES
49+
.TP
50+
.B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
51+
Start the server on port \fB9000\fP serving two trackers; one under
52+
\fB/bugs\fP and one under \fB/reqs\fP.
53+
4854
.SH CONFIGURATION FILE
4955
See the "admin_guide" in the Roundup "doc" directory.
5056
.SH AUTHOR

0 commit comments

Comments
 (0)