changeset 3911:daedf66344f7

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 :)
author Justus Pendleton <jpend@users.sourceforge.net>
date Thu, 20 Sep 2007 17:03:17 +0000
parents 006fcf5b8954
children 82f462d9ad16
files doc/roundup-server.1
diffstat 1 files changed, 14 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/roundup-server.1	Tue Sep 18 17:44:26 2007 +0000
+++ b/doc/roundup-server.1	Thu Sep 20 17:03:17 2007 +0000
@@ -37,14 +37,20 @@
 print help
 .TP
 \fBname=\fP\fItracker home\fP
-Sets the tracker home(s) to use. The name is how the tracker is
-identified in the URL (it's the first part of the URL path). The
-tracker home is the directory that was identified when you did
-"roundup-admin init". You may specify any number of these name=home
-pairs on the command-line. For convenience, you may edit the
-TRACKER_HOMES variable in the roundup-server file instead.
-Make sure the name part doesn't include any url-unsafe characters like
-spaces, as these confuse the cookie handling in browsers like IE.
+Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is
+identified in the URL (it's the first part of the URL path). The \fItracker
+home\fP variable is the directory that was identified when you did
+"roundup-admin init". You may specify any number of these name=home pairs on
+the command-line. For convenience, you may edit the TRACKER_HOMES variable in
+the roundup-server file instead.  Make sure the name part doesn't include any
+url-unsafe characters like spaces, as these confuse the cookie handling in
+browsers like IE.
+.SH EXAMPLES
+.TP
+.B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
+Start the server on port \fB9000\fP serving two trackers; one under
+\fB/bugs\fP and one under \fB/reqs\fP.
+
 .SH CONFIGURATION FILE
 See the "admin_guide" in the Roundup "doc" directory.
 .SH AUTHOR

Roundup Issue Tracker: http://roundup-tracker.org/