| 1 | .\" Copyright (c) 1983 The Regents of the University of California. |
| 2 | .\" All rights reserved. |
| 3 | .\" |
| 4 | .\" Redistribution and use in source and binary forms are permitted |
| 5 | .\" provided that the above copyright notice and this paragraph are |
| 6 | .\" duplicated in all such forms and that any documentation, |
| 7 | .\" advertising materials, and other materials related to such |
| 8 | .\" distribution and use acknowledge that the software was developed |
| 9 | .\" by the University of California, Berkeley. The name of the |
| 10 | .\" University may not be used to endorse or promote products derived |
| 11 | .\" from this software without specific prior written permission. |
| 12 | .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR |
| 13 | .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED |
| 14 | .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
| 15 | .\" |
| 16 | .\" @(#)bugfiler.8 6.9 (Berkeley) %G% |
| 17 | .\" |
| 18 | .TH BUGFILER 8 "" |
| 19 | .UC 5 |
| 20 | .SH NAME |
| 21 | bugfiler \- file bug reports in folders automatically |
| 22 | .SH SYNOPSIS |
| 23 | .B bugfiler |
| 24 | [ -ar ] [-v version] |
| 25 | .SH DESCRIPTION |
| 26 | \fIBugfiler\fP is a program to automatically intercept, acknowledge, |
| 27 | redistribute and store bug reports. \fIBugfiler\fP is normally invoked |
| 28 | by the mail delivery program with a line similar to the following in |
| 29 | /usr/lib/aliases. |
| 30 | .PP |
| 31 | .DT |
| 32 | bugs: "|bugfiler" |
| 33 | .br |
| 34 | .PP |
| 35 | It should be noted that the login ``bugs'' must exist for the bugfiler |
| 36 | to run. Unless otherwise noted all paths used by \fIbugfiler\fP are |
| 37 | relative to the home directory of this login. \fIBugfiler\fP also |
| 38 | expects all of its files and directories to be owned by ``bugs''. |
| 39 | .PP |
| 40 | For the bug report to be correctly filed, it must contain a line |
| 41 | in the following format: |
| 42 | .PP |
| 43 | .DT |
| 44 | Index: \fIfolder\fP \fIversion\fP |
| 45 | .br |
| 46 | .PP |
| 47 | The directories ~bugs/\fIversion\fP and ~bugs/\fIversion\fP/\fIfolder\fP |
| 48 | must exist before \fIbugfiler\fP attempts to store the bug report. Bug |
| 49 | reports will be stored in files named by the concatenation of \fIversion, |
| 50 | folder,\fP and sequential numbers, i.e. if \fIversion\fP is ``4.3BSD'' and |
| 51 | \fIfolder\fP is ``ucb'' the first bug report will be placed in |
| 52 | ~bugs/4.3BSD/ucb/1. If \fIfolder\fP contains more than one component only |
| 53 | the first one will be used, e.g. if \fIfolder\fP is ``bin/from.c'' or |
| 54 | ``bin/adb/con.c'' it will be treated as if it were simply ``bin''. The |
| 55 | \fI-v\fP flag is provided as a means to override the \fIversion\fP |
| 56 | provided within the bug report itself. |
| 57 | .PP |
| 58 | A mail acknowledgement is automatically sent to the bug report filer unless |
| 59 | the \fB-a\fP flag is supplied. The file ~bugs/\fIversion\fP/bug:ack is |
| 60 | appended to this acknowledgement. |
| 61 | .PP |
| 62 | If the \fB-r\fP flag is not supplied, redistribution of the bug reports |
| 63 | is done as specified in the file ~bugs/\fIversion\fP/bug:redist. This file |
| 64 | is in the format of the \fIaliases\fP(5) file, including comments and |
| 65 | entries requiring multiple lines, with the single exception that the |
| 66 | \fIfolder\fP component of the ``Index:'' line replaces the name to alias. |
| 67 | The special folder ``all:'' receives a redistribution of all bug reports |
| 68 | sent to this \fIversion\fP. For example, the \fIbug:redist\fP file |
| 69 | .PP |
| 70 | .DT |
| 71 | # bigbug gets a copy of everything |
| 72 | .br |
| 73 | all: bigbug |
| 74 | .br |
| 75 | # ucb folder redistribution list |
| 76 | .br |
| 77 | ucb: karels, kjd@coke.berkeley.edu |
| 78 | .br |
| 79 | ra@beno.css.gov |
| 80 | .br |
| 81 | .PP |
| 82 | will send copies of all bug reports with ``ucb'' as the \fIfolder\fP |
| 83 | to bigbug, karels, kjd, and ra. |
| 84 | .PP |
| 85 | Reports that cannot be filed, due to an invalid ``Index:'' line or |
| 86 | some other error, are placed in the directory ~bugs/errors. The |
| 87 | \fIbugfiler\fP maintainer should correct these bug reports and then |
| 88 | run \fIbugfiler\fP, with the corrected report as its standard input, |
| 89 | as bug reports with errors are neither acknowledged or redistributed. |
| 90 | All reports that \fIbugfiler\fP handles are logged in ~bugs/log. |
| 91 | .PP |
| 92 | Valid bugs are also logged in the file ~bugs/\fIversion\fP/summary. |
| 93 | This file has an entry for each bug report for \fIversion\fP in the |
| 94 | format: |
| 95 | .PP |
| 96 | .DT |
| 97 | Filename Date |
| 98 | .br |
| 99 | Subject: |
| 100 | .br |
| 101 | Index: |
| 102 | .br |
| 103 | Owner: Bugs Bunny |
| 104 | .br |
| 105 | Status: Received |
| 106 | .br |
| 107 | .PP |
| 108 | \fIFilename\fP is the concatenation of \fIversion, folder,\fP and a number |
| 109 | as described above. \fIDate\fP is the date as reported by the system |
| 110 | clock, using ctime(3). The \fISubject:\fP and \fIIndex:\fP lines are |
| 111 | copies of the ``Subject:'' and ``Index:'' lines contained in the bug |
| 112 | report. The \fIOwner\fP and \fIStatus\fP fields are intended to provide a |
| 113 | rudimentary method of tracking the status of bug reports. |
| 114 | .PP |
| 115 | The file ~bugs/bug:lock is the focus of all locking for \fIbugfiler.\fP |
| 116 | If you wish to manipulate any of the log or error files, rename or remove |
| 117 | it and \fIbugfiler\fP will treat all bug reports that it receives as if |
| 118 | they were incorrectly formatted, i.e. it will place them in the directory |
| 119 | ~bugs/errors, for later recovery by the \fIbugfiler\fP maintainer. |
| 120 | Obviously, this file must be created when you first install \fIbugfiler\fP. |
| 121 | .PP |
| 122 | All errors that occur before ~bugs/log is found are logged into the system |
| 123 | log file, using |
| 124 | .IR syslog (8). |
| 125 | .SH FILES |
| 126 | .br |
| 127 | .TP 25 |
| 128 | ~bugs/bug:ack |
| 129 | the acknowledgement message |
| 130 | .TP 25 |
| 131 | ~bugs/bug:redist |
| 132 | the redistribution list |
| 133 | .TP 25 |
| 134 | ~bugs/bug:lock |
| 135 | the locking file |
| 136 | .TP 25 |
| 137 | ~bugs/errors/BUG_?????? |
| 138 | bug reports with format errors |
| 139 | .TP 25 |
| 140 | ~bugs/log |
| 141 | the log file |
| 142 | .TP 25 |
| 143 | ~bugs/folder/summary |
| 144 | the summary files |
| 145 | .TP 25 |
| 146 | /usr/lib/sendmail |
| 147 | the mail delivery program |
| 148 | .TP 25 |
| 149 | /usr/lib/bugformat |
| 150 | a sample bug report format |
| 151 | .SH "SEE ALSO" |
| 152 | sendbug(1), aliases(5), syslog(8) |
| 153 | .SH BUGS |
| 154 | Since mail can be forwarded in a number of different ways, \fIbugfiler\fP |
| 155 | does not recognize forwarded mail and will acknowledge to the forwarder |
| 156 | instead of the original sender unless there is a `Reply-To' field in the |
| 157 | header. |
| 158 | .PP |
| 159 | This version of the bugfiler is not compatible with the version |
| 160 | released with 4.3BSD in that it doesn't complain to the sender about |
| 161 | incorrectly formatted bug reports. |
| 162 | Frankly, we got tired of the profanity, not to mention the extended |
| 163 | conversations |
| 164 | .I bugfiler |
| 165 | was holding with |
| 166 | .IR vacation (1). |