Code

svn repository setup
[roundup.git] / doc / roundup-demo.1
1 .TH ROUNDUP-SERVER 1 "27 July 2004"
2 .SH NAME
3 roundup-demo \- create a roundup "demo" tracker and launch its web interface
4 .SH SYNOPSIS
5 \fBroundup-demo\fP [\fIbackend\fP [\fBnuke\fP]]
6 .SH OPTIONS
7 .TP
8 \fBnuke\fP
9 Create a fresh demo tracker (deleting the existing one if any). If the
10 additional \fIbackend\fP argument is specified, the new demo tracker will
11 use the backend named (one of "anydbm", "sqlite", "metakit", "mysql" or
12 "postgresql"; subject to availability on your system).
13 .SH DESCRIPTION
14 This command creates a fresh demo tracker for you to experiment with. The
15 email features of Roundup will be turned off (so the nosy feature won't
16 send email). It does this by removing the \fInosyreaction.py\fP module
17 from the demo tracker's \fIdetectors\fP directory.
19 If you wish, you may modify the demo tracker by editing its configuration
20 files and HTML templates. See the \fIcustomisation\fP manual for
21 information about how to do that.
23 Once you've fiddled with the demo tracker, you may use it as a template for
24 creating your real, live tracker. Simply run the \fIroundup-admin\fP
25 command to install the tracker from inside the demo tracker home directory,
26 and it will be listed as an available template for installation. No data
27 will be copied over.
28 .SH AUTHOR
29 This manpage was written by Richard Jones
30 <richard@users.sourceforge.net>.