Move man pages into 'share/man/man1' and simplify setup.py

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4188 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/doc/roundup-admin.1 b/doc/roundup-admin.1
deleted file mode 100644 (file)
index 3bf0e72..0000000
--- a/doc/roundup-admin.1
+++ /dev/null
@@ -1,26 +0,0 @@
-.TH ROUNDUP-ADMIN 1 "24 January 2003"
-.SH NAME
-roundup-admin \- administrate roundup trackers
-.SH SYNOPSIS
-\fBroundup-admin\fP [\fIoptions\fP] \fI<command>\fP \fI<arguments>\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>             -- command-specific help
- roundup-admin help all                   -- all available help
-.SH AUTHOR
-This manpage was written by Bastian Kleineidam
-<calvin@debian.org> for the Debian distribution of roundup.
-
-The main author of roundup is Richard Jones
-<richard@users.sourceforge.net>.

diff --git a/doc/roundup-demo.1 b/doc/roundup-demo.1
deleted file mode 100644 (file)
index caa6684..0000000
--- a/doc/roundup-demo.1
+++ /dev/null
@@ -1,30 +0,0 @@
-.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>.

diff --git a/doc/roundup-mailgw.1 b/doc/roundup-mailgw.1
deleted file mode 100644 (file)
index 5802fb7..0000000
--- a/doc/roundup-mailgw.1
+++ /dev/null
@@ -1,65 +0,0 @@
-.TH ROUNDUP-MAILGW 1 "24 January 2003"
-.SH NAME
-roundup-mailgw \- mail gateway for roundup
-.SH SYNOPSIS
-\fBroundup-mailgw\fP \fI<instance home>\fP [\fImethod\fP]
-.SH OPTIONS
-.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=value[;property=value] pairs\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:
- \fIpop username:password@server\fP
-.br
-The username and password may be omitted:
- \fIpop username@server\fP
- \fIpop server\fP
-.br
-are both valid.
-
-\fBAPOP\fP
-Same as POP, but using Authenticated POP:
- \fIapop username:password@server\fP
-.SH AUTHOR
-This manpage was written by Bastian Kleineidam
-<calvin@debian.org> for the Debian distribution of roundup.
-
-The main author of roundup is Richard Jones
-<richard@users.sourceforge.net>.

diff --git a/doc/roundup-server.1 b/doc/roundup-server.1
deleted file mode 100644 (file)
index 8b92673..0000000
--- a/doc/roundup-server.1
+++ /dev/null
@@ -1,61 +0,0 @@
-.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.
-.TP
-\fB-p\fP \fIport\fP
-Sets the port to listen on.
-.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-h\fP
-print help
-.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
-<calvin@debian.org> for the Debian distribution of roundup.
-
-The main author of roundup is Richard Jones
-<richard@users.sourceforge.net>.

diff --git a/setup.py b/setup.py
index e2e226d7889d0f0caaca584192a440f96da340b6..f1f247beb784d09ea8b88ac6594fb5a0adc91980 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -52,11 +52,8 @@ def scriptname(path):
     return script
 
 def main():
-    # build list of scripts from their implementation modules
-    roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
-
     # template munching
-    packagelist = [
+    packages = [
         'roundup',
         'roundup.anypy',
         'roundup.cgi',
@@ -66,44 +63,31 @@ def main():
         'roundup.backends',
         'roundup.scripts',
     ]
-    installdatafiles = [
-        ('share/roundup/cgi-bin', ['frontends/roundup.cgi']),
-    ]
     py_modules = ['roundup.demo',]
 
+    # build list of scripts from their implementation modules
+    scripts = [scriptname(f) for f in glob('roundup/scripts/[!_]*.py')]
+
+    data_files = [
+        ('share/roundup/cgi-bin', ['frontends/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',
-            'doc/roundup-demo.1']))
+        data_files.append(include('share/man/man1', '*'))
 
     # add the templates to the data files lists
     from roundup.init import listTemplates
     templates = [t['path'] for t in listTemplates(os.path.join('share','roundup','templates')).values()]
     for tdir in templates:
-        # scan for data files
         for idir in '. detectors extensions html'.split():
-            idir = os.path.join(tdir, idir)
-            if not os.path.isdir(idir):
-                continue
-            tfiles = []
-            for f in os.listdir(idir):
-                if f.startswith('.'):
-                    continue
-                ifile = os.path.join(idir, f)
-                if os.path.isfile(ifile):
-                    tfiles.append(ifile)
-            installdatafiles.append(
-                (os.path.join('share', 'roundup', idir), tfiles)
-            )
+            data_files.append(include(os.path.join(tdir, idir), '*'))
 
     # add message files
     for (_dist_file, _mo_file) in list_message_files():
-        installdatafiles.append((os.path.dirname(_mo_file),
-            [os.path.join("build", _mo_file)]))
+        data_files.append((os.path.dirname(_mo_file), [os.path.join("build", _mo_file)]))
 
     # add docs
-    installdatafiles.append(include(os.path.join('share', 'doc', 'roundup', 'html'), '*'))
+    data_files.append(include(os.path.join('share', 'doc', 'roundup', 'html'), '*'))
 
     # perform the setup action
     from roundup import __version__
@@ -140,10 +124,10 @@ with command-line, web and e-mail interfaces. Highly customisable.""",
                      'build': build,
                      'bdist_rpm': bdist_rpm,
                      },
-          packages=packagelist,
+          packages=packages,
           py_modules=py_modules,
-          scripts=roundup_scripts,
-          data_files=installdatafiles)
+          scripts=scripts,
+          data_files=data_files)
 
 if __name__ == '__main__':
     main()

diff --git a/share/man/man1/roundup-admin.1 b/share/man/man1/roundup-admin.1
new file mode 100644 (file)
index 0000000..3bf0e72
--- /dev/null
+++ b/share/man/man1/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<command>\fP \fI<arguments>\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>             -- command-specific help
+ roundup-admin help all                   -- all available help
+.SH AUTHOR
+This manpage was written by Bastian Kleineidam
+<calvin@debian.org> for the Debian distribution of roundup.
+
+The main author of roundup is Richard Jones
+<richard@users.sourceforge.net>.

diff --git a/share/man/man1/roundup-demo.1 b/share/man/man1/roundup-demo.1
new file mode 100644 (file)
index 0000000..caa6684
--- /dev/null
+++ b/share/man/man1/roundup-demo.1
@@ -0,0 +1,30 @@
+.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>.

diff --git a/share/man/man1/roundup-mailgw.1 b/share/man/man1/roundup-mailgw.1
new file mode 100644 (file)
index 0000000..5802fb7
--- /dev/null
+++ b/share/man/man1/roundup-mailgw.1
@@ -0,0 +1,65 @@
+.TH ROUNDUP-MAILGW 1 "24 January 2003"
+.SH NAME
+roundup-mailgw \- mail gateway for roundup
+.SH SYNOPSIS
+\fBroundup-mailgw\fP \fI<instance home>\fP [\fImethod\fP]
+.SH OPTIONS
+.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=value[;property=value] pairs\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:
+ \fIpop username:password@server\fP
+.br
+The username and password may be omitted:
+ \fIpop username@server\fP
+ \fIpop server\fP
+.br
+are both valid.
+
+\fBAPOP\fP
+Same as POP, but using Authenticated POP:
+ \fIapop username:password@server\fP
+.SH AUTHOR
+This manpage was written by Bastian Kleineidam
+<calvin@debian.org> for the Debian distribution of roundup.
+
+The main author of roundup is Richard Jones
+<richard@users.sourceforge.net>.

diff --git a/share/man/man1/roundup-server.1 b/share/man/man1/roundup-server.1
new file mode 100644 (file)
index 0000000..8b92673
--- /dev/null
+++ b/share/man/man1/roundup-server.1
@@ -0,0 +1,61 @@
+.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.
+.TP
+\fB-p\fP \fIport\fP
+Sets the port to listen on.
+.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-h\fP
+print help
+.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
+<calvin@debian.org> for the Debian distribution of roundup.
+
+The main author of roundup is Richard Jones
+<richard@users.sourceforge.net>.