Mercurial > p > roundup > code
comparison doc/roundup-server.1 @ 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 | 679118b572d5 |
| children |
comparison
equal
deleted
inserted
replaced
| 3910:006fcf5b8954 | 3911:daedf66344f7 |
|---|---|
| 35 .TP | 35 .TP |
| 36 \fB-h\fP | 36 \fB-h\fP |
| 37 print help | 37 print help |
| 38 .TP | 38 .TP |
| 39 \fBname=\fP\fItracker home\fP | 39 \fBname=\fP\fItracker home\fP |
| 40 Sets the tracker home(s) to use. The name is how the tracker is | 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 | 41 identified in the URL (it's the first part of the URL path). The \fItracker |
| 42 tracker home is the directory that was identified when you did | 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 | 43 "roundup-admin init". You may specify any number of these name=home pairs on |
| 44 pairs on the command-line. For convenience, you may edit the | 44 the command-line. For convenience, you may edit the TRACKER_HOMES variable in |
| 45 TRACKER_HOMES variable in the roundup-server file instead. | 45 the roundup-server file instead. Make sure the name part doesn't include any |
| 46 Make sure the name part doesn't include any url-unsafe characters like | 46 url-unsafe characters like spaces, as these confuse the cookie handling in |
| 47 spaces, as these confuse the cookie handling in browsers like IE. | 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 | |
| 48 .SH CONFIGURATION FILE | 54 .SH CONFIGURATION FILE |
| 49 See the "admin_guide" in the Roundup "doc" directory. | 55 See the "admin_guide" in the Roundup "doc" directory. |
| 50 .SH AUTHOR | 56 .SH AUTHOR |
| 51 This manpage was written by Bastian Kleineidam | 57 This manpage was written by Bastian Kleineidam |
| 52 <calvin@debian.org> for the Debian distribution of roundup. | 58 <calvin@debian.org> for the Debian distribution of roundup. |