Mercurial > p > roundup > code

annotate share/man/man1/roundup-demo.1 @ 8386:4e2ffa4151cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: formatting fix. Don't trigger description list.
author John Rouillard <rouilj@ieee.org>
date Sat, 12 Jul 2025 17:53:17 -0400
parents d614d8e1c09d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7918
d5dfc152cd9d Fix title on roundup-demo man page.
John Rouillard <rouilj@ieee.org>
parents: 7917
diff changeset
1 .TH ROUNDUP-DEMO 1 "27 July 2004"
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
2 .SH NAME
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
3 roundup-demo \- create a roundup "demo" tracker and launch its web interface
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
4 .SH SYNOPSIS
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
5 \fBroundup_demo\fP [\fB\-h\fP] [\fB-b\fP \fIBIND_ADDRESS\fP]
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
6 [\fB-b\fP {\fBanydbm\fP,\fBmysql\fP,\fBsqlite\fP,\fBpostgresql\fP}]
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
7 [\fB-t\fb
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
8 {\fBminimal\fP,\fBjinja2\fP,\fBclassic\fP,\fBresponsive\fP,\fBdevel\fP}]
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
9 [\fB-p\fP \fIPORT\fP] [\fB-P\fP \fIURLPORT\fP] [\fB-V\fP]
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
10 [\fIdirectory\fP] [\fIbackend\fP] [\fBnuke\fP]
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
11 .SH OPTIONS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
12 .TP
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
13 \fIdirectory\fP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
14
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
15 The home directory for the new demo tracker. (*)
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
16 .TP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
17 \fIbackend\fP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
18
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
19 Choose backend database. Depricated, use \fB-b\fP.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
20 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
21 \fBnuke\fP
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
22
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
23 Create a fresh demo tracker (deleting the existing one if
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
24 any). E.G.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
25 .EX
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
26 roundup-demo -b sqlite -t classic ./mytracker nuke
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
27 .EE
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
28 will remove an existing tracker (if present) from the directory
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
29 \fB./mytracker\fP. Then it will create and serve a new empty classic
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
30 tracker using the sqlite backend.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
31 .TP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
32 \fB-h\fP, \fB--help\fP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
33
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
34 Show the help message and exit
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
35 .TP
7926
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
36 \fB-B\fp \fIBIND_ADDRESS\fI, \fB--bind_address\fP \fIBIND_ADDRESS\fP
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
37
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
38 Choose address for server to listen at. Use 0.0.0.0 to bind to all addreses.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
39 Default: 127.0.0.1.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
40 .TP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
41 \fB-b\fP {\fBanydbm\fP,\fBmysql\fP,\fBsqlite\fP,\fBpostgresql\fP}, \
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
42 \fB--backend_db\fP {\fBanydbm\fP,\fBmysql\fP,\fBsqlite\fP,\fBpostgresql\fP}
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
43
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
44 Choose backend database. Default:
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
45 sqlite. Available backends are subject to availability on your system.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
46 .TP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
47 \fB-t\fP \
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
48 {\fBminimal\fP,\fBjinja2\fP,\fBclassic\fP,\fBresponsive\fP,\fBdevel\fP}, \
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
49 \fP--template\fB \
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
50 {\fBminimal\fP,\fBjinja2\fP,\fBclassic\fP,\fBresponsive\fP,\fBdevel\fP}
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
51
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
52 Use specified template when building tracker. (*)
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
53 .TP
7926
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
54 \fB-h\fP \fIHOSTNAME\fP, \fB--hostname\fP \fIHOSTNAME\fP
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
55
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
56 Set the hostname used in the URL. This does not make the server listen
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
57 at the hostname. Use the hostname with \fB-B\fP to listen on that IP
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
58 address.
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
59 .TP
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
60 \fB-p\fP \fIPORT\fP, \fB--port\fP \fIPORT\fP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
61
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
62 Listen at this port. Default: search for open port starting at 8917.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
63 .TP
7926
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
64 \fB-P\fP \fIURLPORT\fP, \fB--urlport\fP \fIURLPORT\fP
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
65
7926
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
66 When using docker this option passes the docker external port to the
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
67 demo instance. If using \fBdocker ... -p 9090:8917 ...\fP this should
05f36a527a45 feat: allow setting URL hostname with -H option to roundup-demo
John Rouillard <rouilj@ieee.org>
parents: 7918
diff changeset
68 be set to \fB-P 9090\fP. Default: as selected by \fB--port\fP.
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
69 .TP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
70 \fB-V\fP, \fB--version\fP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
71
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
72 Show program's version number and exit
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
73
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
74 .PP
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
75 If items marked with (*) are missing, they will be asked for
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
76 interactively when setting up the tracker.
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
77
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
78 .SH DESCRIPTION
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
79 This command creates a fresh demo tracker for you to experiment
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
80 with. The email features of Roundup will be turned off (so the nosy
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
81 feature won't send email). It does this by removing the
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
82 \fBnosyreaction.py\fP module from the demo tracker's \fIdetectors\fP
7917
0b82d42790ae fix typo.
John Rouillard <rouilj@ieee.org>
parents: 7340
diff changeset
83 directory. If you wish to send email to promote the tracker to
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
84 production, you will need to copy \fBnosyreaction.py\fP from the
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
85 default tracker templates directory. The \fBtemplates\fP command from
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
86 roundup-admin(1) can help you locate a replacement.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
87
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
88 If you wish, you may modify the demo tracker by editing its configuration
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
89 files and HTML templates. See the \fIcustomisation\fP manual for
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
90 information about how to do that.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
91
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
92 Once you've fiddled with the demo tracker, you may use it as a template for
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
93 creating your real, live tracker. Simply run the \fIroundup-admin\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
94 command to install the tracker from inside the demo tracker home directory,
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
95 and it will be listed as an available template for installation. No data
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
96 will be copied over.
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
97 .SH SEE ALSO
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
98
7993
d614d8e1c09d update man pages with see also section.
John Rouillard <rouilj@ieee.org>
parents: 7926
diff changeset
99 roundup-admin(1), roundup-mailgw(1), roundup-server(1)
d614d8e1c09d update man pages with see also section.
John Rouillard <rouilj@ieee.org>
parents: 7926
diff changeset
100
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
101 .SH AUTHOR
7340
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
102 This manpage was written by Richard Jones and extensively modified by
7b9bddda9d2d Add support for demo mode in docker.
John Rouillard <rouilj@ieee.org>
parents: 6472
diff changeset
103 John Rouillard <rouilj@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/