code-4f25deb20dfa/share/man/man1/roundup-admin.10000644000000000000000000000203212130756264017444 0ustar 00000000000000.TH ROUNDUP-ADMIN 1 "24 January 2003" .SH NAME roundup-admin \- administrate roundup trackers .SH SYNOPSIS \fBroundup-admin\fP [\fIoptions\fP] \fI\fP \fI\fP .SH OPTIONS .TP \fB-i\fP \fIinstance home\fP specify the issue tracker "home directory" to administer .TP \fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP] the user and password to use for commands .TP \fB-c\fP When outputting lists of data, comma-separate them. Same as \fB-S ","\fP. .TP \fB-S\fP \fIstring\fP When outputting lists of data, separate items with given string. .TP \fB-s\fP When outputting lists of data, space-separate them. Same as \fB-S " "\fP. .SH FURTHER HELP roundup-admin -h roundup-admin help -- this help roundup-admin help -- command-specific help roundup-admin help all -- all available help .SH AUTHOR This manpage was written by Bastian Kleineidam for the Debian distribution of roundup. The main author of roundup is Richard Jones . code-4f25deb20dfa/share/man/man1/roundup-demo.10000644000000000000000000000247612130756264017314 0ustar 00000000000000.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 . code-4f25deb20dfa/share/man/man1/roundup-mailgw.10000644000000000000000000000537112130756264017645 0ustar 00000000000000.TH ROUNDUP-MAILGW 1 "24 January 2003" .SH NAME roundup-mailgw \- mail gateway for roundup .SH SYNOPSIS \fBroundup-mailgw\fP \fIinstance_home\fP [\fImethod\fP] .SH OPTIONS .TP \fB-v\fP Print version and exit. .TP \fB-C\fP \fIhyperdb class\fP specify a tracker class - one of msg (the default), issue, file, user - to manipulate with -S options .TP \fB-S\fP \fIproperty\fP\fB=\fP\fIvalue\fP[\fB;\fP\fIproperty\fP\fB=\fP\fIvalue\fP] \fIpairs\fP specify the values to set on the class specified by -C using the same format as the Subject line property manipulations .SH DESCRIPTION The roundup mail gateway may be called in one of three ways: .IP \(bu with an instance home as the only argument, .IP \(bu with both an instance home and a mail spool file, or .IP \(bu with both an instance home and a pop server account. .PP \fBPIPE\fP .br In the first case, the mail gateway reads a single message from the standard input and submits the message to the roundup.mailgw module. \fBUNIX mailbox\fP .br In the second case, the gateway reads all messages from the mail spool file and submits each in turn to the roundup.mailgw module. The file is emptied once all messages have been successfully handled. The file is specified as: \fImailbox /path/to/mailbox\fP In all of the following the username and password can be stored in a ~/.netrc file. In this case only the server name need be specified on the command-line. The username and/or password will be prompted for if not supplied on the command-line or in ~/.netrc. \fBPOP\fP .br In the third case, the gateway reads all messages from the POP server specified and submits each in turn to the roundup.mailgw module. The server is specified as: \fBpop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP .br The username and password may be omitted: \fBpop\fP \fIusername\fP\fB@\fP\fIserver\fP \fBpop\fP \fIserver\fP .br are both valid. The username and/or password will be prompted for if not supplied on the command-line. \fBAPOP\fP .br Same as POP, but using Authenticated POP: \fBapop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP \fBIMAP\fP .br Connect to an IMAP server. This supports the same notation as that of POP mail. \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP .br It also allows you to specify a specific mailbox other than INBOX using this format: \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver mailbox\fP \fBIMAPS\fP .br Connect to an IMAP server over ssl. This supports the same notation as IMAP. \fBimaps\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP [\fImailbox\fP] .SH AUTHOR This manpage was written by Bastian Kleineidam for the Debian distribution of roundup. The main author of roundup is Richard Jones . code-4f25deb20dfa/share/man/man1/roundup-server.10000644000000000000000000000466212130756264017675 0ustar 00000000000000.TH ROUNDUP-SERVER 1 "27 July 2004" .SH NAME roundup-server \- start roundup web server .SH SYNOPSIS \fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]* .SH OPTIONS .TP \fB-C\fP \fIfile\fP Use options read from the configuration file (see below). .TP \fB-n\fP \fIhostname\fP Sets the host name or IP address to listen on .TP \fB-p\fP \fIport\fP Sets the port to listen on (default: 8080). .TP \fB-d\fP \fIfile\fP Daemonize, and write the server's PID to the nominated file. .TP \fB-l\fP \fIfile\fP Sets a filename to log to (instead of stdout). This is required if the -d option is used. .TP \fB-i\fP \fIfile\fP Sets a filename to use as a template for generating the tracker index page. The variable "trackers" is available to the template and is a dict of all configured trackers. .TP \fB-s\fP Enables to use of SSL. .TP \fB-e\fP \fIfile\fP Sets a filename containing the PEM file to use for SSL. If left blank, a temporary self-signed certificate will be used. .TP \fB-N\fP Log client machine names instead of IP addresses (much slower). .TP \fB-u\fP \fIUID\fP Runs the Roundup web server as this UID. .TP \fB-g\fP \fIGID\fP Runs the Roundup web server as this GID. .TP \fB-d\fP \fIPIDfile\fP Run the server in the background and write the server's PID to the file indicated by PIDfile. The -l option \fBmust\fP be specified if -d is used. .TP \fB-v\fP Print version and exit. .TP \fB-h\fP Print help and exit. .TP \fBname=\fP\fItracker home\fP Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is identified in the URL (it's the first part of the URL path). The \fItracker home\fP variable is the directory that was identified when you did "roundup-admin init". You may specify any number of these name=home pairs on the command-line. For convenience, you may edit the TRACKER_HOMES variable in the roundup-server file instead. Make sure the name part doesn't include any url-unsafe characters like spaces, as these confuse the cookie handling in browsers like IE. .SH EXAMPLES .TP .B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1 Start the server on port \fB9000\fP serving two trackers; one under \fB/bugs\fP and one under \fB/reqs\fP. .SH CONFIGURATION FILE See the "admin_guide" in the Roundup "doc" directory. .SH AUTHOR This manpage was written by Bastian Kleineidam for the Debian distribution of roundup. The main author of roundup is Richard Jones .