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