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, such as the various auto-acks (you should usually use
  43   <code>send</code> as well, as the interesting messages are not sent by
  44   <code>send-detail</code>).
  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 sytem.
  58
  59 <dt><code>index maint</code> <var>maintainer</var>
  60
  61   <dd>Requests the index pages of $gBugs in the system for all maintainers
  62   containing the string <var>maintainer</var>.  The search term is a
  63   case insensitive substring.  The $gBug index for each matching
  64   maintainer will be sent in a separate message.
  65
  66 <dt><code>index-packages</code>
  67
  68   <dd>Requests the index page giving the list of packages with $gBugs (open
  69   and recently-closed) in the tracking sytem.
  70
  71 <dt><code>index packages</code> <var>package</var>
  72
  73   <dd>Requests the index pages of $gBugs in the system for all packages
  74   containing the string <var>package</var>.  The search term is a case
  75   insensitive substring.  The $gBug index for each matching package will
  76   be sent in a separate message.
  77
  78 <dt><code>send-unmatched</code> [<code>this</code>|<code>0</code>]
  79 <dt><code>send-unmatched</code> <code>last</code>|<code>-1</code>
  80 <dt><code>send-unmatched</code> <code>old</code>|<code>-2</code>
  81
  82   <dd>Requests logs of messages not matched to a particular $gBug report,
  83   for this week, last week and the week before.  (Each week ends on a
  84   Wednesday.)
  85
  86 <dt><code>getinfo</code> <var>filename</var>
  87
  88   <dd>Request a file containing information about package(s) and or
  89   maintainer(s) - the files available are:
  90
  91   <dl compact>
  92   <dt><code>maintainers</code>
  93     <dd>The unified list of packages' maintainers, as used by the tracking
  94     system.
  95
  96     $gCreateMaintainers
  97
  98     <!-- Override file quivilent information -->
  99
 100   <dt><code>pseudo-packages.description</code>
 101   <dt><code>pseudo-packages.maintainers</code>
 102     <dd>List of descriptions and maintainers respectively for
 103     pseudo-packages.
 104   </dl>
 105
 106 <dt><code>refcard</code>
 107
 108   <dd>Requests that the mailservers' reference card be sent in plain ASCII.
 109
 110 <dt><code>help</code>
 111
 112   <dd>Requests that this help document be sent by email in plain ASCII.
 113
 114 <dt><code>quit</code>
 115 <dt><code>stop</code>
 116 <dt><code>thank</code>...
 117 <dt><code>--</code>...
 118
 119   <dd>Stops processing at this point of the message.  After this you may
 120   include any text you like, and it will be ignored.  You can use this
 121   to include longer comments than are suitable for <code>#</code>, for
 122   example for the benefit of human readers of your message (reading it
 123   via the tracking system logs or due to a <code>CC</code> or
 124   <code>BCC</code>).
 125
 126 <dt><code>#</code>...
 127
 128   <dd>One-line comment.  The <code>#</code> must be at the start of the
 129   line.
 130
 131 <dt><code>debug</code> <var>level</var>
 132
 133   <dd>Sets the debugging level to <var>level</var>, which should be a
 134   nonnegative integer.  0 is no debugging; 1 is usually sufficient.  The
 135   debugging output appears in the transcript.  It is not likely to be
 136   useful to general users of the $gBug system.
 137
 138 </dl>
 139
 140 <p>There is a <a href="server-refcard.html">reference card</a> for the
 141 mailservers, available via the WWW, in
 142 <code>bug-mailserver-refcard.txt</code> or by email using the
 143 <code>refcard</code> command (see above).
 144
 145 <p>If you wish to manipulate $gBug reports you should use the
 146 <code>control\@gEmailDomain</code> address, which understands a
 147 <a href="server-control.html">superset of the commands listed
 148 above</a>.  This is described in another document, available on the
 149 <a href="server-control.html">WWW</a>, in the file
 150 <code>bug-maint-mailcontrol.txt</code>, or by
 151 sending <code>help</code> to <code>control\@$gEmailDomain</code>.
 152
 153 <p>In case you are reading this as a plain text file or via email: an
 154 HTML version is available via the $gBug system main contents page
 155 <code>http://$gWebDomain/</code>.
 156
 157 <hr>
 158
 159 <p>Other pages:
 160 <ul>
 161   <li><a href="./">$gBug tracking system main contents page.</a>
 162   <li><a href="Reporting.html">Instructions for reporting $gBugs.</a>
 163   <li><a href="Access.html">Accessing the $gBug tracking logs other than by WWW.</a>
 164   <li><a href="Developer.html">Developers' information regarding the $gBug processing system.</a>
 165   <li><a href="server-control.html">Developers' information - $gBug manipulation using the email control interface.</a>
 166   <li><a href="server-refcard.html">Mailservers' reference card.</a>
 167   <li><a href="db/ix/full.html">Full list of outstanding and recent $gBug reports.</a>
 168   <li><a href="db/ix/packages.html">Packages with $gBug reports.</a>
 169   <li><a href="db/ix/maintainers.html">Maintainers of packages with $gBug reports.</a>
 170 $gHTMLOtherPageList
 171 </ul>
 172
 173 $gHTMLTail
 174
 175 HTML_END