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