view share/man/man1/roundup-demo.1 @ 5695:3e1b66c4e1e2

Update docs. Correct errors reported by setup.py build_docs. Add rest interface and link to rest doc to features page. Add link to xmlrpc doc to features page. Add rest doc to index. Update rest doc, hopefully clarify confusing use of parameters in patch action section. Fix code examples in "Adding new rest endpoints" section. Fix example adding import of exception.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Apr 2019 20:17:52 -0400
parents ab542607f2fb
children 47a521b9ebb9
line wrap: on
line source

.TH ROUNDUP-SERVER 1 "27 July 2004"
.SH NAME
roundup-demo \- create a roundup "demo" tracker and launch its web interface
.SH SYNOPSIS
\fBroundup-demo\fP [\fIbackend\fP [\fBnuke\fP]]
.SH OPTIONS
.TP
\fBnuke\fP
Create a fresh demo tracker (deleting the existing one if any). If the
additional \fIbackend\fP argument is specified, the new demo tracker will
use the backend named (one of "anydbm", "sqlite", "metakit", "mysql" or
"postgresql"; subject to availability on your system).
.SH DESCRIPTION
This command creates a fresh demo tracker for you to experiment with. The
email features of Roundup will be turned off (so the nosy feature won't
send email). It does this by removing the \fInosyreaction.py\fP module
from the demo tracker's \fIdetectors\fP directory.

If you wish, you may modify the demo tracker by editing its configuration
files and HTML templates. See the \fIcustomisation\fP manual for
information about how to do that.

Once you've fiddled with the demo tracker, you may use it as a template for
creating your real, live tracker. Simply run the \fIroundup-admin\fP
command to install the tracker from inside the demo tracker home directory,
and it will be listed as an available template for installation. No data
will be copied over.
.SH AUTHOR
This manpage was written by Richard Jones
<richard@users.sourceforge.net>.

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