html/server-request.html.in

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