Mercurial > p > roundup > code

annotate doc/index.html @ 253:5973f1d80ace

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More doc, straight out of the mailgw module and roundup-admin help
author Richard Jones <richard@users.sourceforge.net>
date Sat, 29 Sep 2001 13:42:07 +0000
parents 2f4123c715f1
children af6e10660e27
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
251
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 <html><head>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 <title>Roundup: an Issue-Tracking System for Knowledge Workers</title>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 </head><body>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 <h1 align=center>Roundup</h1>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 <h3 align=center>An Issue-Tracking System for Knowledge Workers</h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 <h2>Contents</h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 <li><a href="overview.html">Overview</a> (Initial submission to SC Track)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 <li><a href="#installation">Installation</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 <li><a href="#requires">Prerequisites</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 <li><a href="#getting">Getting Roundup</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 <li><a href="#installing">Installing Roundup</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 <li><a href="#starting">Getting Started</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 <li><a href="#instance">The Instance</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 <li><a href="#startcmd">Command Line Tool</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 <li><a href="#startweb">E-Mail Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 <li><a href="#startweb">Web Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 <li><a href="#users">Users</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 <li><a href="#issues">Issues</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 </ul>
253
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
27 <li><a href="#guide">User Guide</a>
251
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 <li><a href="#cmd">Command Line Tool</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 <li><a href="#web">Web Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 <li><a href="#mail">E-Mail Gateway</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 <li><a href="spec.html">Roundup's Design Document</a> ("Implementation Guide")
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 <li><a href="#ack">Acknowledgements</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 <h2><a name="installation">Installation</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 <h3><a name="requires">Prerequisites</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 <dl>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 <dt>Either:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 <dd>Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 <dt>or
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 <dd>Python 2.1 or later
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 </dl>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 Download the latest version from
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 <a href="http://www.python.org/">http://www.python.org/</a>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 <h3><a name="getting">Getting Roundup</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 Download the latest version from
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 <a href="http://roundup.sf.net/">http://roundup.sf.net/</a>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 <h3><a name="installing">Installing Roundup</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 <li>Run:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 <br><tt>python setup.py install</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 <li>If you would prefer the scripts installed in somewhere other than
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 <tt>/usr/local/bin</tt>, add <tt>"--install-scripts=&lt;dir&gt;"</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 to the command:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 <br><tt>python setup.py install --install-scripts=&lt;dir&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 <li>The command:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 <br><tt>python setup.py install --help</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 <br>gives all the options available for installation.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 <h2><a name="starting">Getting Started</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 The following instructions assume that you have installed roundup. If you
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80 haven't, you may still proceed - just preface all commands with "./"
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 ie. "./roundup-admin init".
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 <h3><a name="instance">The Instance</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 We'll be referring to the term "instance" a lot from now on. An instance is
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87 a directory in your filesystem that is where all the information about a
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 live issue tracker database is stored. The data that is entered as issues,
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 the users who access the database and the definition of the database itself
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 all reside there:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 <li><strong>Hyperdatabase</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 <br>This is the lowest component of Roundup and is where all the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94 issues, users, file attachments and messages are stored.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 <li><strong>Database schema</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 <br>This describes the content of the hyperdatabase - what fields are
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 stored for issues, what user information, etc. Being stored in the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98 instance, this allows it to be customised for a particular application.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 It also means that changes in the Roundup core code do not affect a
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 running instance.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101 <li><strong>Web Interface</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102 <br>The web interface templates are defined in the instance too - and
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103 the actual CGI interface class is defined (mostly using base classes in
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 the Roundup core code) so it, like the database, may be customised for
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 each instance in use.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108 Instances are created using the <tt>roundup-admin</tt> tool.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110 <h3><a name="startcmd">Command Line Tool</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 To initiliase a new instance, run <tt>roundup-admin init</tt>. You will be
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 asked a series of questions:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 <li>Instance home directory
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 <li>Schema to use
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 <li>Database back-end to use
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119 <li>Administration user "admin" password.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122 Roundup is configurable using a localconfig.py file in the instance home.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123 It may have the following variable declarations:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
124
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
125 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126 <li>MAILHOST
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
127 <br>The SMTP mail host that roundup will use to send mail
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128 <li>MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
129 <br>The domain name used for email addresses
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
130 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
131
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
132 Any further configuration should be possible by editing the instance home's
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
133 __init__.py directly.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134 <p>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
135 The email addresses used by the system by default are:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
136
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
137 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
138 <li>issue_tracker@MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
139 <br>submissions of issues
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
140 <li>roundup-admin@MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
141 <br>roundup's internal use (problems, etc)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
142 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
143
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144 <em>Note:</em>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145 We run the instance as group "issue_tracker" and add the mail and web user
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
146 ("mail" and "apache" on our RedHat 7.1 system) to that group, as well as
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
147 any admin people.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
148
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 <h3><a name="startweb">E-Mail Interface</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151 Set up a mail alias called "issue_tracker" as:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
152 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
153 <tt>|/usr/bin/python /usr/local/bin/roundup-mailgw
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154 &lt;instance_home&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
155 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
156
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
157 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
158 so sendmail will accept the pipe command. In that case, symlink
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
159 /etc/smrsh/roundup-mailgw to /usr/local/bin/roundup-mailgw and change the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
160 command to:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
161 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162 <tt>|roundup-mailgw &lt;instance_home&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
164
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165 To test the mail gateway on unix systems, try:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
166
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
167 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
168 <tt>echo test |mail -s '[issue] test' issue_tracker@your.domain</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
169 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
171
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
172
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
173 <h3><a name="startweb">Web Interface</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
174 This software will work through apache or stand-alone.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
175 <p>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
176 <strong>Stand-alone:</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
178 <li>Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
179 about your instance. *** command-line option
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180 <li><tt>roundup-server [hostname port]</tt> (hostname may be "")
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181 <li>Load up the page <tt>/&lt;instance name&gt;/index</tt> where
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182 instance name is the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
183 name you nominated in <tt>ROUNDUP_INSTANCE_HOMES</tt>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
184 *** command-line option
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
186
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
187 <strong>Apache:</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
188 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189 <li>Make sure roundup.cgi is executable. Edit it at the top -
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
190 ROUNDUP_INSTANCE_HOMES needs to know about your instance.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
191 <li>Edit your <tt>/etc/httpd/conf/httpd.conf</tt> and make sure that the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 <tt>/home/httpd/html/roundup/roundup.cgi</tt> script will be treated as a CGI
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193 script.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
194 <li>Add the following to your <tt>/etc/httpd/conf/httpd.conf</tt>:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
195 <pre>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196 ------8<------- snip here ------8<-------
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
197 RewriteEngine on
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198 RewriteCond %{HTTP:Authorization} ^(.*)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
199 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
200 ------8<------- snip here ------8<-------
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
201 </pre>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202 note: the RewriteRule must be on one line - no breaks
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
203 <li>Re-start your apache to re-load the config
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
204 <li>Load up the page <tt>/roundup/roundup.cgi/&lt;instance name&gt;/index</tt> where
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
205 instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
206 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
207
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
208
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
209 <h3><a name="users">Users</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
210 To add users, use one of the following interfaces:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
211
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
212 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
213 <li>On the web, access the URL <tt>.../&lt;instance name&gt;/newuser</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
214 to bring up a form which may be used to add a new user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
215 <li>On the command-line, use:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
216 <br><tt>roundup-admin -i &lt;instance home&gt; create user
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
217 username=bozo password=bozo address=richard@clown.org</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
218 <br>Supply the admin username and password. roundup-admin will print the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
219 id of the new user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
220 <li>Any e-mail sent to roundup from an address that doesn't match an
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
221 existing user in the database will result in a new user entry being
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
222 created for that user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
223 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
224
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
225
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
226
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227 <h3><a name="issues">Issues</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
228 To add issues, use one of the following interfaces:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
230 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
231 <li>On the web, access the URL <tt>.../&lt;instance name&gt;/newissue</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
232 to bring up a form which may be used to add a new issue.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
233 <li>On the command-line, use:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
234 <br><tt>roundup-admin -i &lt;instance home&gt; create issue
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
235 title="test issue"</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
236 <br>Supply the admin username and password. roundup-admin will print the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
237 id of the new issue.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
238 <li>Any e-mail sent to roundup with the subject line containing [issue]
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
239 will automatically created a new issue in the database using the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
240 contents of the e-mail.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
241 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
242
253
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
243 <p><br>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
244 <h2><a name="guide">User Guide</a></h2>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
245 <h3><a name="cmd">Command Line Tool</a></h3>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
246
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
247 Usage:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
248 <tt>roundup-admin [-i instance home] [-u login] [-c] &lt;command&gt;
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
249 &lt;arguments&gt;</tt>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
250 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
251 <dl>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
252 <dt>Commands:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
253 <dd>create classname property=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
254 <dd>find classname propname=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
255 <dd>freshen
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
256 <dd>get property designator[,designator]*
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
257 <dd>history designator
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
258 <dd>init [template [backend [admin password]]]
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
259 <dd>list classname [property]
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
260 <dd>retire designator[,designator]*
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
261 <dd>set designator[,designator]* propname=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
262 <dd>spec classname
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
263 <dt>Help:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
264 <dd>roundup-admin -h
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
265 <dd>roundup-admin help -- this help
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
266 <dd>roundup-admin help <command> -- command-specific help
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
267 <dd>roundup-admin morehelp -- even more detailed help
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
268 <dt>Options:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
269 <dd>-i instance home -- specify the issue tracker "home directory" to administer
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
270 <dd>-u -- the user[:password] to use for commands
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
271 <dd>-c -- when outputting lists of data, just comma-separate them
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
272 </dl>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
273
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
274 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
275 All commands (except help) require an instance specifier. This is just the path
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
276 to the roundup instance you're working with. A roundup instance is where
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
277 roundup keeps the database and configuration file that defines an issue
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
278 tracker. It may be thought of as the issue tracker's "home directory". It may
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
279 be specified in the environment variable ROUNDUP_INSTANCE or on the command
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
280 line as "-i instance".
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
281
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
282 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
283 A designator is a classname and a nodeid concatenated, eg. bug1, user10, ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
284
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
285 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
286 Property values are represented as strings in command arguments and in the
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
287 printed results:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
288 <ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
289 <li>Strings are, well, strings.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
290 <li>Date values are printed in the full date format in the local time zone, and
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
291 accepted in the full format or any of the partial formats explained below.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
292 <li>Link values are printed as node designators. When given as an argument,
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
293 node designators and key strings are both accepted.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
294 <li>Multilink values are printed as lists of node designators joined by commas.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
295 When given as an argument, node designators and key strings are both
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
296 accepted; an empty string, a single node, or a list of nodes joined by
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
297 commas is accepted.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
298 </ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
299 When multiple nodes are specified to the roundup get or roundup set
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
300 commands, the specified properties are retrieved or set on all the listed
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
301 nodes.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
302 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
303 When multiple results are returned by the roundup get or roundup find
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
304 commands, they are printed one per line (default) or joined by commas (with
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
305 the -c) option.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
306 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
307 Where the command changes data, a login name/password is required. The
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
308 login may be specified as either "name" or "name:password".
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
309 <ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
310 <li>ROUNDUP_LOGIN environment variable
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
311 <li>the -u command-line option
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
312 </ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
313 If either the name or password is not supplied, they are obtained from the
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
314 command-line.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
315 <p>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
316 Date format examples:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
317 <table>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
318 <tr><th>Input of...</th><th>Means...</th></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
319 <tr><td>"2000-04-17.03:45"</td><td>2000-04-17.08:45:00</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
320 <tr><td>"2000-04-17"</td><td>2000-04-17.00:00:00</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
321 <tr><td>"01-25"</td><td>yyyy-01-25.00:00:00</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
322 <tr><td>"08-13.22:13"</td><td>yyyy-08-14.03:13:00</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
323 <tr><td>"11-07.09:32:43"</td><td>yyyy-11-07.14:32:43</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
324 <tr><td>"14:25"</td><td>yyyy-mm-dd.19:25:00</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
325 <tr><td>"8:47:11"</td><td>yyyy-mm-dd.13:47:11</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
326 <tr><td>"."</td><td>"right now"</td></tr>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
327 </table>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
328
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
329 <h4>Specific Command help</h4>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
330
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
331 <pre>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
332 history:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
333 Usage: history designator
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
334 Show the history entries of a designator.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
335
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
336 Lists the journal entries for the node identified by the designator.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
337
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
338 find:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
339 Usage: find classname propname=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
340 Find the nodes of the given class with a given property value.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
341
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
342 Find the nodes of the given class with a given property value. The
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
343 value may be either the nodeid of the linked node, or its key value.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
344
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
345 list:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
346 Usage: list classname [property]
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
347 List the instances of a class.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
348
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
349 Lists all instances of the given class along. If the property is not
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
350 specified, the "label" property is used. The label property is tried
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
351 in order: the key, "name", "title" and then the first property,
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
352 alphabetically.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
353
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
354 retire:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
355 Usage: retire designator[,designator]*
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
356 Retire the node specified by designator.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
357
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
358 This action indicates that a particular node is not to be retrieved by
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
359 the list or find commands, and its key value may be re-used.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
360
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
361 create:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
362 Usage: create classname property=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
363 Create a new entry of a given class.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
364
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
365 This creates a new entry of the given class using the property
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
366 name=value arguments provided on the command line after the "create"
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
367 command.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
368
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
369 get:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
370 Usage: get property designator[,designator]*
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
371 Get the given property of one or more designator(s).
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
372
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
373 Retrieves the property value of the nodes specified by the designators.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
374
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
375 spec:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
376 Usage: spec classname
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
377 Show the properties for a classname.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
378
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
379 This lists the properties for a given class.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
380
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
381 set:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
382 Usage: set designator[,designator]* propname=value ...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
383 Set the given property of one or more designator(s).
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
384
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
385 Sets the property to the value for all designators given.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
386
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
387 init:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
388 Usage: init [template [backend [admin password]]]
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
389 Initialise a new Roundup instance.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
390
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
391 The command will prompt for the instance home directory (if not supplied
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
392 through INSTANCE_HOME or the -i option. The template, backend and admin
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
393 password may be specified on the command-line as arguments, in that order.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
394
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
395 freshen:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
396 Usage: freshen
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
397 Freshen an existing instance. **DO NOT USE**
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
398
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
399 This currently kills databases!!!!
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
400
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
401 This action should generally not be used. It reads in an instance
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
402 database and writes it again. In the future, is may also update
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
403 instance code to account for changes in templates. It's probably wise
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
404 not to use it anyway. Until we're sure it won't break things...
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
405 </pre>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
406
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
407 <h3><a name="web">Web Interface</a></h3>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
408 T.B.D.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
409
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
410 <h3><a name="mail">E-Mail Gateway</a></h3>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
411
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
412 Incoming messages are examined for multiple parts:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
413 <ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
414 <li>In a multipart/mixed message or part, each subpart is extracted and
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
415 examined. The text/plain subparts are assembled to form the textual
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
416 body of the message, to be stored in the file associated with a "msg"
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
417 class node. Any parts of other types are each stored in separate files
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
418 and given "file" class nodes that are linked to the "msg" node.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
419 <li>In a multipart/alternative message or part, we look for a text/plain
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
420 subpart and ignore the other parts.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
421 </ul>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
422
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
423 <h4>Summary</h4>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
424 The "summary" property on message nodes is taken from the first non-quoting
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
425 section in the message body. The message body is divided into sections by
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
426 blank lines. Sections where the second and all subsequent lines begin with
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
427 a "&gt;" or "|" character are considered "quoting sections". The first line of
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
428 the first non-quoting section becomes the summary of the message.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
429
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
430 <h4>Addresses</h4>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
431 All of the addresses in the To: and Cc: headers of the incoming message are
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
432 looked up among the user nodes, and the corresponding users are placed in
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
433 the "recipients" property on the new "msg" node. The address in the From:
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
434 header similarly determines the "author" property of the new "msg"
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
435 node. The default handling for addresses that don't have corresponding
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
436 users is to create new users with no passwords and a username equal to the
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
437 address. (The web interface does not permit logins for users with no
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
438 passwords.) If we prefer to reject mail from outside sources, we can simply
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
439 register an auditor on the "user" class that prevents the creation of user
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
440 nodes with no passwords.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
441
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
442 <h4>Actions</h4>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
443 The subject line of the incoming message is examined to determine whether
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
444 the message is an attempt to create a new item or to discuss an existing
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
445 item. A designator enclosed in square brackets is sought as the first thing
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
446 on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
447
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
448 If an item designator (class name and id number) is found there, the newly
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
449 created "msg" node is added to the "messages" property for that item, and
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
450 any new "file" nodes are added to the "files" property for the item.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
451
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
452 If just an item class name is found there, we attempt to create a new item
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
453 of that class with its "messages" property initialized to contain the new
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
454 "msg" node and its "files" property initialized to contain any new "file"
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
455 nodes.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
456
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
457 <h4>Triggers</h4>
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
458 Both cases may trigger detectors (in the first case we are calling the
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
459 set() method to add the message to the item's spool; in the second case we
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
460 are calling the create() method to create a new node). If an auditor raises
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
461 an exception, the original message is bounced back to the sender with the
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
462 explanatory message given in the exception.
5973f1d80ace More doc, straight out of the mailgw module and roundup-admin help
Richard Jones <richard@users.sourceforge.net>
parents: 251
diff changeset
463
251
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
464 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
465 <h2><a name="ack">Acknowledgements</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
466
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
467 Go Ping, you rock! Also, go Bizar Software for letting me implement this
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
468 system on their time.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
469
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
470 </body></html>
Roundup Issue Tracker: http://roundup-tracker.org/