From: richard Date: Wed, 12 Feb 2003 00:24:40 +0000 (+0000) Subject: included UN*X manual pages from Bastian Kleineidam X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=32eb14fa1d7b39e533211b75a021454e6fb7cb5c;p=roundup.git included UN*X manual pages from Bastian Kleineidam git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1497 57a73879-2fb5-44c3-a270-3262357dd7e2 --- diff --git a/CHANGES.txt b/CHANGES.txt index d3d3da2..4feb8ab 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -48,6 +48,7 @@ are given with the most recent entry first. tracker name - fixed error in indexargs_url (thanks Patrick Ohly) - fixed getnode (sf bug 684531) +- included UN*X manual pages from Bastian Kleineidam 2003-??-?? 0.5.6 diff --git a/MANIFEST.in b/MANIFEST.in index 07ec028..b8840be 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,7 +4,7 @@ recursive-include scripts *.* *-* recursive-include tools *.* recursive-include cgi-bin *.cgi recursive-include test *.py *.txt -recursive-include doc *.html *.png *.txt *.css +recursive-include doc *.html *.png *.txt *.css *.1 recursive-exclude roundup *.pyc *.pyo .cvsignore recursive-exclude frontends *.pyc *.pyo .cvsignore include run_tests *.txt diff --git a/doc/index.txt b/doc/index.txt index dec63c8..50c274f 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -61,6 +61,7 @@ Juergen Hermann, Tobias Hunger, James Kew, Sheila King, +Bastian Kleineidam, Detlef Lannert, Andrey Lebedev, Gordon McMillan, diff --git a/doc/roundup-admin.1 b/doc/roundup-admin.1 new file mode 100644 index 0000000..3bf0e72 --- /dev/null +++ b/doc/roundup-admin.1 @@ -0,0 +1,26 @@ +.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 +the user[:password] to use for commands +.TP +\fB-c\fP +when outputting lists of data, just comma-separate them +.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 +. diff --git a/doc/roundup-mailgw.1 b/doc/roundup-mailgw.1 new file mode 100644 index 0000000..8e8a142 --- /dev/null +++ b/doc/roundup-mailgw.1 @@ -0,0 +1,46 @@ +.TH ROUNDUP-MAILGW 1 "24 January 2003" +.SH NAME +roundup-mailgw \- mail gateway for roundup +.SH SYNOPSIS +\fBroundup-mailgw\fP \fI\fP [\fImethod\fP] +.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 + +\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: + \fIpop username:password@server\fP +.br +The username and password may be omitted: + \fIpop username@server\fP + \fIpop server\fP +.br +are both valid. The username and/or password will be prompted for if +not supplied on the command-line. +.SH AUTHOR +This manpage was written by Bastian Kleineidam + for the Debian distribution of roundup. + +The main author of roundup is Richard Jones +. diff --git a/doc/roundup-server.1 b/doc/roundup-server.1 new file mode 100644 index 0000000..d12679f --- /dev/null +++ b/doc/roundup-server.1 @@ -0,0 +1,37 @@ +.TH ROUNDUP-SERVER 1 "24 January 2003" +.SH NAME +roundup-server \- start roundup server +.SH SYNOPSIS +\fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]* +.SH OPTIONS +.TP +\fB-n\fP \fIhostname\fP +sets the host name +.TP +\fB-p\fP \fIport\fP +sets the port to listen on +.TP +\fB-l\fP \fIfile\fP +sets a filename to log to (instead of stdout) +.TP +\fB-d\fP \fIfile\fP +daemonize, and write the server's PID to the nominated file +.TP +\fB-h\fP +print help +.TP +\fBname=\fP\fItracker home\fP +Sets the tracker home(s) to use. The name is how the tracker is +identified in the URL (it's the first part of the URL path). The +tracker home 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 AUTHOR +This manpage was written by Bastian Kleineidam + for the Debian distribution of roundup. + +The main author of roundup is Richard Jones +. diff --git a/setup.py b/setup.py index 800603e..c641b10 100644 --- a/setup.py +++ b/setup.py @@ -16,7 +16,7 @@ # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # -# $Id: setup.py,v 1.41 2002-12-10 00:11:13 richard Exp $ +# $Id: setup.py,v 1.42 2003-02-12 00:24:39 richard Exp $ from distutils.core import setup, Extension from distutils.util import get_platform @@ -157,6 +157,11 @@ if __name__ == '__main__': ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']), ] + # install man pages on POSIX platforms + if os.name == 'posix': + installdatafiles.append(('man/man1', ['doc/roundup-admin.1', + 'doc/roundup-mailgw.1', 'doc/roundup-server.1'])) + # munge the template HTML into the htmlbase module buildTemplates()