html/server-request.html.in

   1 $gRequestHtml = <<HTML_END
   2 <!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html>
   4 <head>
   5   <title>$gProject $gBug system - $gBug logs by mail server</title>
   6   <link rev="made" href="mailto:$gMaintainerEmail">
   7 </head>
   8 <body>
   9
  10 <h1><a name="introduction">Introduction to the $gBug system request server</a></h1>
  11
  12 <p>There is a mailserver which can send the $gBug reports and
  13 indices as plain text on request.
  14
  15 <p>To use it you send a mail message to
  16 <a href="mailto:request\@$gEmailDomain"><code>request\@$gEmailDomain</code></a>.
  17 The <code>Subject</code> of the message is ignored, except
  18 for generating the <code>Subject</code> of the reply.
  19
  20 <p>The body you send should be a series of commands, one per line.
  21 You'll receive a reply which looks like a transcript of your message
  22 being interpreted, with a response to each command.  No notifications
  23 are sent to anyone for most commands; however, the messages are logged
  24 and made available in the WWW pages.
  25
  26 <p>Any text on a line starting with a hash sign <code>#</code> is
  27 ignored; the server will stop processing when it finds a line starting
  28 with <code>quit</code>, <code>stop</code>, <code>thank</code> or two
  29 hyphens (to avoid parsing a signature).  It will also stop if it
  30 encounters too many unrecognised or badly-formatted commands.  If no
  31 commands are successfully handled it will send the help text for the
  32 server.
  33
  34 <h1>Commands available</h1>
  35
  36 <dl>
  37 <dt><code>send</code> <var>bugnumber</var>
  38 <dt><code>send-detail</code> <var>bugnumber</var>
  39
  40   <dd>Requests the transcript for the $gBug report in question.
  41   <code>send-detail</code> sends all of the `boring' messages in the
  42   transcript as well, such as the various auto-acks.
  43
  44 <dt><code>index</code> [<code>full</code>]
  45 <dt><code>index-summary by-package</code>
  46 <dt><code>index-summary by-number</code>
  47
  48   <dd>Request the full index (with full details, and including done and
  49   forwarded reports), or the summary sorted by package or by number,
  50   respectively.
  51
  52 <dt><code>index-maint</code>
  53
  54   <dd>Requests the index page giving the list of maintainers with $gBugs
  55   (open and recently-closed) in the tracking system.
  56
  57 <dt><code>index maint</code> <var>maintainer</var>
  58
  59   <dd>Requests the index pages of $gBugs in the system for the maintainer
  60   <var>maintainer</var>.  The search term is an exact match.
  61   The $gBug index will be sent in a separate message.
  62
  63 <dt><code>index-packages</code>
  64
  65   <dd>Requests the index page giving the list of packages with $gBugs (open
  66   and recently-closed) in the tracking system.
  67
  68 <dt><code>index packages</code> <var>package</var>
  69
  70   <dd>Requests the index pages of $gBugs in the system for the package
  71   <var>package</var>.  The search term is an exact match.
  72   The $gBug index will be sent in a separate message.
  73
  74 <dt><code>send-unmatched</code> [<code>this</code>|<code>0</code>]
  75 <dt><code>send-unmatched</code> <code>last</code>|<code>-1</code>
  76 <dt><code>send-unmatched</code> <code>old</code>|<code>-2</code>
  77
  78   <dd>Requests logs of messages not matched to a particular $gBug report,
  79   for this week, last week and the week before.  (Each week ends on a
  80   Wednesday.)
  81
  82 <dt><code>getinfo</code> <var>filename</var>
  83
  84   <dd>Request a file containing information about package(s) and or
  85   maintainer(s) - the files available are:
  86
  87   <dl compact>
  88   <dt><code>maintainers</code>
  89     <dd>The unified list of packages' maintainers, as used by the tracking
  90     system.
  91
  92     $gCreateMaintainers
  93
  94     <!-- Override file quivilent information -->
  95
  96   <dt><code>pseudo-packages.description</code>
  97   <dt><code>pseudo-packages.maintainers</code>
  98     <dd>List of descriptions and maintainers respectively for
  99     pseudo-packages.
 100   </dl>
 101
 102 <dt><code>refcard</code>
 103
 104   <dd>Requests that the mailservers' reference card be sent in plain ASCII.
 105
 106 <dt><code>user</code> <var>email</var>
 107
 108   <dd>Set the user to the given email address. The default user is the
 109   email address set in your mail client's From: or Reply-To: field. You
 110   should not use other people's email addresses without permission.
 111
 112 <dt><code>usertag</code> <var>bugnumber</var> [ <code>+</code> | <code>-</code> | <code>=</code> ] <var>tag</var> [ <var>tag</var> ... ]
 113
 114   <dd>Sets usertags for the $gBug report #<var>bugnumber</var>. No
 115   notification is sent to the user who reported the $gBug, nor to
 116   the package maintainer. Setting the action to <code>+</code> means
 117   to add each given <var>tag</var>, <code>-</code> means to remove
 118   each given <var>tag</var>, and <code>=</code> means to ignore the
 119   current tags and set them afresh to the list provided. The default
 120   action is adding.
 121
 122   <p>Example usage:</p>
 123
 124   <pre>
 125         # same as 'tags 123456 + patch'
 126         usertag 123456 patch
 127
 128         # same as 'tags 123456 + help security'
 129         usertag 123456 help security
 130   </pre>
 131
 132   <p>The meaning of usertags is decided by the owner of the email address
 133   they are associated with.
 134
 135 <dt><code>help</code>
 136
 137   <dd>Requests that this help document be sent by email in plain ASCII.
 138
 139 <dt><code>quit</code>
 140 <dt><code>stop</code>
 141 <dt><code>thank</code>...
 142 <dt><code>--</code>...
 143
 144   <dd>Stops processing at this point of the message.  After this you may
 145   include any text you like, and it will be ignored.  You can use this
 146   to include longer comments than are suitable for <code>#</code>, for
 147   example for the benefit of human readers of your message (reading it
 148   via the tracking system logs or due to a <code>CC</code> or
 149   <code>BCC</code>).
 150
 151 <dt><code>#</code>...
 152
 153   <dd>One-line comment.  The <code>#</code> must be at the start of the
 154   line.
 155
 156 <dt><code>debug</code> <var>level</var>
 157
 158   <dd>Sets the debugging level to <var>level</var>, which should be a
 159   nonnegative integer.  0 is no debugging; 1 is usually sufficient.  The
 160   debugging output appears in the transcript.  It is not likely to be
 161   useful to general users of the $gBug system.
 162
 163 </dl>
 164
 165 <p>There is a <a href="server-refcard.html">reference card</a> for the
 166 mailservers, available via the WWW, in
 167 <code>bug-mailserver-refcard.txt</code> or by email using the
 168 <code>refcard</code> command (see above).
 169
 170 <p>If you wish to manipulate $gBug reports you should use the
 171 <code>control\@gEmailDomain</code> address, which understands a
 172 <a href="server-control.html">superset of the commands listed
 173 above</a>.  This is described in another document, available on the
 174 <a href="server-control.html">WWW</a>, in the file
 175 <code>bug-maint-mailcontrol.txt</code>, or by
 176 sending <code>help</code> to <code>control\@$gEmailDomain</code>.
 177
 178 <p>In case you are reading this as a plain text file or via email: an
 179 HTML version is available via the $gBug system main contents page
 180 <code>http://$gWebDomain/</code>.
 181
 182 <hr>
 183
 184 <p>Other pages:
 185 <ul>
 186   <li><a href="./">$gBug tracking system main contents page.</a>
 187   <li><a href="Reporting.html">Instructions for reporting $gBugs.</a>
 188   <li><a href="Access.html">Accessing the $gBug tracking logs other than by WWW.</a>
 189   <li><a href="Developer.html">Developers' information regarding the $gBug processing system.</a>
 190   <li><a href="server-control.html">Developers' information - $gBug manipulation using the email control interface.</a>
 191   <li><a href="server-refcard.html">Mailservers' reference card.</a>
 192   <li><a href="db/ix/full.html">Full list of outstanding and recent $gBug reports.</a>
 193   <li><a href="db/ix/packages.html">Packages with $gBug reports.</a>
 194   <li><a href="db/ix/maintainers.html">Maintainers of packages with $gBug reports.</a>
 195 $gHTMLOtherPageList
 196 </ul>
 197
 198 $gHTMLTail
 199
 200 HTML_END