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