Mercurial > p > roundup > code
annotate share/man/man1/roundup-admin.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 | a5a9b81f8f6b |
| children | e8d64096fb08 |
| rev | line source |
|---|---|
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
1 .TH ROUNDUP-ADMIN 1 "24 January 2003" |
|
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-admin \- administrate roundup trackers |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
4 .SH SYNOPSIS |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
5 \fBroundup-admin\fP [\fIoptions\fP] \fI<command>\fP \fI<arguments>\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
6 .SH OPTIONS |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
7 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
8 \fB-i\fP \fIinstance home\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
9 specify the issue tracker "home directory" to administer |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
10 .TP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
11 \fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP] |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
12 the user and password to use for commands |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
13 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
14 \fB-c\fP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
15 When outputting lists of data, comma-separate them. Same as |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
16 \fB-S ","\fP. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
17 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
18 \fB-S\fP \fIstring\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
19 When outputting lists of data, separate items with given string. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
20 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
21 \fB-s\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
22 When outputting lists of data, space-separate them. Same as |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
23 \fB-S " "\fP. |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
24 .SH FURTHER HELP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
25 roundup-admin -h |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
26 roundup-admin help -- this help |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
27 roundup-admin help <command> -- command-specific help |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
28 roundup-admin help all -- all available help |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
29 .SH AUTHOR |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
30 This manpage was written by Bastian Kleineidam |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
31 <calvin@debian.org> for the Debian distribution of roundup. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
32 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
33 The main author of roundup is Richard Jones |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
34 <richard@users.sourceforge.net>. |
