html/server-control.html.in

   1 $gControlHtml = <<HTML_END
   2 <html><head>
   3 <html><head>
   4 <title>$gProject $gBug system - control mail server commands</title>
   5 <link rev="made" href="mailto:$gMaintainerEmail">
   6 </head><body>
   7 <h1>Introduction to the $gBug control and manipulation mailserver</h1>
   8
   9 In addition to the mailserver on <code>request\@$gEmailDomain</code>
  10 which allows the retrieval of $gBug data and documentation by email,
  11 there is another server on <code>control\@$gEmailDomain</code> which
  12 also allows $gBug reports to be manipulated in various ways.
  13 <p>
  14
  15 The control server works just like the request server, except that it
  16 has some additional commands; in fact, it's the same program.  The two
  17 addresses are only separated to avoid users making mistakes and
  18 causing problems while merely trying to request information.
  19 <p>
  20
  21 Please see the
  22 <A href="server-request.html#introduction">introduction to
  23 the request server</A>
  24 available on the World Wide Web, in the file
  25 <code>bug-maint-mailcontrol.txt</code>, or by sending
  26 <code>help</code> to either mailserver, for details of the basics of
  27 operating the mailservers and the common commands available when
  28 mailing either address.
  29 <p>
  30
  31 The <A href="server-refcard.html">reference card</A> for the
  32 mailservers is available via the WWW, in
  33 <code>bug-mailserver-refcard.txt</code> or by email using the
  34 <code>refcard</code> command).
  35
  36 <h1>Commands available only at the control mailserver</h1>
  37
  38 <dl>
  39
  40 <dt><code>close</code> <var>bugnumber</var>
  41 <dd>
  42
  43 Close $gBug report #<var>bugnumber</var>.
  44 <p>
  45
  46 A notification is sent to the user who reported the $gBug, but (in
  47 contrast to mailing <var>bugnumber</var><code>-done@$gEmailDomain</code>) the
  48 text of the mail which caused the $gBug to be closed is <em>not</em>
  49 included in that notification.  The maintainer who closes a report
  50 should ensure, probably by sending a separate message, that the user
  51 who reported the $gBug knows why it is being closed.
  52
  53 <dt><code>reassign</code> <var>bugnumber</var> <var>package</var>
  54 <dd>
  55
  56 Records that $gBug #<var>$gBugnumber</var> is a $gBug in <var>package</var>.
  57 This can be used to set the package if the user forgot the
  58 pseudo-header, or to change an earlier assignment.  No notifications
  59 are sent to anyone (other than the usual information in the processing
  60 transcript).
  61
  62 <dt><code>reopen</code> <var>bugnumber</var>
  63  [ <var>originator-address</var> | <code>=</code> | <code>!</code> ]
  64 <dd>
  65
  66 Reopens #<var>bugnumber</var> if it is closed.
  67 <p>
  68
  69 By default, or if you specify <code>=</code>, the original submitter is
  70 still as the originator of the report, so that they will get the ack
  71 when it is closed again.
  72 <p>
  73
  74 If you supply an <var>originator-address</var> the originator will be
  75 set to the address you supply.  If you wish to become the new
  76 originator of the reopened report you can use the <code>!</code>
  77 shorthand or specify your own email address.
  78 <p>
  79
  80 It is usually a good idea to tell the person who is about to be
  81 recorded as the originator that you're reopening the report, so that
  82 they will know to expect the ack which they'll get when it is closed
  83 again.
  84 <p>
  85
  86 If the $gBug is not closed then reopen won't do anything, not even
  87 change the originator.  There is no way to change the originator of an
  88 open $gBug report (this is deliberate, so that you can't have a $gBug be
  89 closed and then deleted $gRemoveAge days later without someone being told about
  90 it).
  91
  92 <dt><code>forwarded</code> <var>bugnumber</var> <var>address</var>
  93 <dd>
  94
  95 Notes that <var>bugnumber</var> has been forwarded to the upstream
  96 maintainer at <var>address</var>.  This does not actually forward the
  97 report.  This can be used to change an existing incorrect forwarded-to
  98 address, or to record a new one for a $gBug that wasn't previously noted
  99 as having been forwarded.
 100
 101 <dt><code>notforwarded</code> <var>bugnumber</var>
 102 <dd>
 103
 104 Forgets any idea that <var>bugnumber</var> has been forwarded to any
 105 upstream maintainer.  If the $gBug was not recorded as having been
 106 forwarded then this will do nothing.
 107
 108 <dt><code>retitle</code> <var>bugnumber</var> <var>new-title</var>
 109 <dd>
 110
 111 Changes the title of a $gBug report to that specified (the default is
 112 the <code>Subject</code> mail header from the original report.
 113 <p>
 114
 115 Unlike most of the other $gBug-manipulation commands when used on one of
 116 a set of merged reports this will change the title of only the
 117 individual $gBug requested, and not all those with which it is merged.
 118
 119 <dt><code>severity</code> <var>bugnumber</var> <var>severity</var>
 120 <dd>
 121
 122 Set the severity level for $gBug report #<var>bugnumber</var> to
 123 <var>severity</var>.  No notification is sent to the user who reported
 124 the $gBug.
 125 <p>
 126
 127 For <A href="Developer.html#severities">their meanings</A> please
 128 consult the general developers' documentation for the $gBug system.
 129
 130 <dt><code>merge</code> <var>bugnumber</var> <var>bugnumber</var> ...
 131 <dd>
 132
 133 Merges two or more $gBug reports.  When reports are merged opening,
 134 closing, marking or unmarking as forwarded and reassigning any of the
 135 $gBugs to a new package will have an identical effect on all of the
 136 merged reports.
 137 <p>
 138
 139 Before $gBugs can be merged they must be in exactly the same state:
 140 either all open or all closed, with the same forwarded-to upstream
 141 author address or all not marked as forwarded, and all assigned to the
 142 same package or package(s) (an exact string comparison is done on the
 143 package to which the $gBug is assigned).  If they don't start out in the
 144 same state you should use <code>reassign</code>, <code>reopen</code>
 145 and so forth to make sure that they are before using
 146 <code>merge</code>.
 147 <p>
 148
 149 If any of the $gBugs listed in a <code>merge</code> command is already
 150 merged with another $gBug then all the reports merged with any of the
 151 ones listed will all be merged together.  Merger is like equality: it
 152 is reflexive, transitive and symmetric.
 153 <p>
 154
 155 Merging reports causes a note to appear on each report's logs; on the
 156 WWW pages this is includes links to the other $gBugs.
 157 <p>
 158
 159 Merged reports are all expired simultaneously, and only when all of
 160 the reports each separately meet the criteria for expiry.
 161
 162 <dt><code>unmerge</code> <var>bugnumber</var>
 163 <dd>
 164
 165 Disconnects a $gBug report from any other reports with which it may have
 166 been merged.  If the report listed is merged with several others then
 167 they are all left merged with each other; only their associations with
 168 the $gBug explicitly named are removed.
 169 <p>
 170
 171 If many $gBug reports are merged and you wish to split them into two
 172 separate groups of merged reports you must unmerge each report in one
 173 of the new groups separately and then merge them into the required new
 174 group.
 175 <p>
 176
 177 You can only unmerge one report with each <code>unmerge</code>
 178 command; if you want to disconnect more than one $gBug simply include
 179 several <code>unmerge</code> commands in your message.
 180
 181 </dl>
 182
 183 <hr>
 184 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'
 190 information regarding the $gBug processing system.</A>
 191 <li><A href="server-request.html">Fundamentals of the mailserver
 192 and commands for retrieving $gBugs.</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