Commit | Line | Data |
---|---|---|
15637ed4 RG |
1 | .\" Copyright (c) 1983, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms, with or without | |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
31 | .\" | |
32 | .\" @(#)bugfiler.8 6.11 (Berkeley) 3/16/91 | |
33 | .\" | |
34 | .Dd March 16, 1991 | |
35 | .Dt BUGFILER 8 | |
36 | .Os BSD 4.2 | |
37 | .Sh NAME | |
38 | .Nm bugfiler | |
39 | .Nd file bug reports in folders automatically | |
40 | .Sh SYNOPSIS | |
41 | .Nm bugfiler | |
42 | .Op Fl ar | |
43 | .Op Fl v Ar version | |
44 | .Sh DESCRIPTION | |
45 | .Nm Bugfiler | |
46 | is a program to automatically intercept, acknowledge, | |
47 | redistribute and store bug reports. | |
48 | .Nm Bugfiler | |
49 | is normally invoked | |
50 | by the mail delivery program with a line similar to the following in | |
51 | .Pa /etc/aliases . | |
52 | .Bd -literal -offset indent | |
53 | bugs: "|bugfiler" | |
54 | .Ed | |
55 | .Pp | |
56 | It should be noted that the login | |
57 | .Dq bugs | |
58 | must exist for the bugfiler | |
59 | to run. Unless otherwise noted all paths used by | |
60 | .Nm bugfiler | |
61 | are | |
62 | relative to the home directory of this login. | |
63 | .Nm Bugfiler | |
64 | also | |
65 | expects all of its files and directories to be owned by | |
66 | .Dq bugs . | |
67 | .Pp | |
68 | Available options. | |
69 | .Bl -tag -width Ds | |
70 | .It Fl a | |
71 | Do not send automatic mail acknowledgement to the bug report filer. | |
72 | (The default is to send the acknowledgement with the file | |
73 | .Pa ~bugs/version/bug:ack | |
74 | appended). | |
75 | .It Fl r | |
76 | Do not redistribute. | |
77 | .It Fl v Ar version | |
78 | Override the | |
79 | .Ar version | |
80 | provided within the bug report itself. | |
81 | .El | |
82 | .Pp | |
83 | For the bug report to be correctly filed, it must contain a line | |
84 | in the following format: | |
85 | .Pp | |
86 | .Bd -filled -offset indent -compact | |
87 | .Bl -column Index folder | |
88 | .It Index: Ta Em folder Ta Ar version | |
89 | .El | |
90 | .Ed | |
91 | .Pp | |
92 | The directories | |
93 | .Pa ~bugs/ Ns Ar version | |
94 | and | |
95 | .Pa ~bugs/ Ns Ar version/ Ns Em folder | |
96 | must exist before | |
97 | .Nm bugfiler | |
98 | attempts to store the bug report. Bug | |
99 | reports will be stored in files named by the concatenation of | |
100 | .Ar version , | |
101 | .Em folder , | |
102 | and sequential numbers, i.e. if | |
103 | .Ar version | |
104 | is | |
105 | .Dq 4.3 Tn BSD | |
106 | and | |
107 | .Em folder | |
108 | is | |
109 | .Dq ucb | |
110 | the first bug report will be placed in | |
111 | .Pa ~bugs/4.3BSD/ucb/1 . | |
112 | If | |
113 | .Em folder | |
114 | contains more than one component only | |
115 | the first one will be used, e.g. if | |
116 | .Em folder | |
117 | is | |
118 | .Dq bin/from.c | |
119 | or | |
120 | .Dq bin/adb/con.c | |
121 | it will be treated as if it were simply | |
122 | .Dq bin . | |
123 | .Pp | |
124 | .Pp | |
125 | If the | |
126 | .Fl r | |
127 | flag is not supplied, redistribution of the bug reports | |
128 | is done as specified in the file | |
129 | .Pa ~bugs/version/bug:redist . | |
130 | This file | |
131 | is in the format of the | |
132 | .Xr aliases 5 | |
133 | file, including comments and | |
134 | entries requiring multiple lines, with the single exception that the | |
135 | .Em folder | |
136 | component of the | |
137 | .Dq Index: | |
138 | line replaces the name to alias. | |
139 | The special folder | |
140 | .Dq all: | |
141 | receives a redistribution of all bug reports | |
142 | sent to this | |
143 | .Ar version . | |
144 | For example, the | |
145 | .Pa bug:redist | |
146 | file | |
147 | .Pp | |
148 | .Bd -literal -offset indent -compact | |
149 | # bigbug gets a copy of everything | |
150 | all: bigbug | |
151 | # ucb folder redistribution list | |
152 | ucb: karels, kjd@coke.berkeley.edu | |
153 | ra@beno.css.gov | |
154 | .Ed | |
155 | .Pp | |
156 | will send copies of all bug reports with | |
157 | .Dq ucb | |
158 | as the | |
159 | .Em folder | |
160 | to bigbug, karels, kjd, and ra. | |
161 | .Pp | |
162 | Reports that cannot be filed, due to an invalid | |
163 | .Dq Index: | |
164 | line or | |
165 | some other error, are placed in the directory | |
166 | .Pa ~bugs/errors . | |
167 | The | |
168 | .Nm bugfiler | |
169 | maintainer should correct these bug reports and then | |
170 | run | |
171 | .Nm bugfiler , | |
172 | with the corrected report as its standard input, | |
173 | as bug reports with errors are neither acknowledged or redistributed. | |
174 | All reports that | |
175 | .Nm bugfiler | |
176 | handles are logged in | |
177 | .Pa ~bugs/log. | |
178 | .Pp | |
179 | Valid bugs are also logged in the file | |
180 | .Pa ~bugs/version/summary. | |
181 | This file has an entry for each bug report for | |
182 | .Ar version | |
183 | in the | |
184 | format: | |
185 | .Pp | |
186 | .Bd -literal -offset indent -compact | |
187 | Filename Date | |
188 | Subject: | |
189 | Index: | |
190 | Owner: Bugs Bunny | |
191 | Status: Received | |
192 | .Ed | |
193 | .Pp | |
194 | .Li Filename | |
195 | is the concatenation of | |
196 | .Ar version , | |
197 | .Em folder , | |
198 | and a number | |
199 | as described above. | |
200 | .Xr Date | |
201 | is the date as reported by the system | |
202 | clock, using | |
203 | .Xr ctime 3 . | |
204 | .Li The Subject: | |
205 | and | |
206 | .Li Index: | |
207 | lines are | |
208 | The | |
209 | .Dq Subject: | |
210 | and | |
211 | .Dq Index: | |
212 | lines are | |
213 | copies of the | |
214 | .Dq Subject: | |
215 | and | |
216 | .Dq index: | |
217 | lines contained in the bug | |
218 | report. The | |
219 | .Li Owner | |
220 | and | |
221 | .Li Status | |
222 | fields are intended to provide a | |
223 | rudimentary method of tracking the status of bug reports. | |
224 | .Pp | |
225 | The file | |
226 | .Pa ~bugs/bug:lock | |
227 | is the focus of all locking for | |
228 | .Nm bugfiler . | |
229 | If you wish to manipulate any of the log or error files, rename or remove | |
230 | it and | |
231 | .Nm bugfiler | |
232 | will treat all bug reports that it receives as if | |
233 | they were incorrectly formatted, i.e. it will place them in the directory | |
234 | .Pa ~bugs/errors , | |
235 | for later recovery by the | |
236 | .Nm bugfiler | |
237 | maintainer. | |
238 | Obviously, this file must be created when you first install | |
239 | .Nm bugfiler . | |
240 | .Pp | |
241 | All errors that occur before | |
242 | .Pa ~bugs/log | |
243 | is found are logged into the system | |
244 | log file, using | |
245 | .Xr syslog 8 . | |
246 | .Sh FILES | |
247 | .Bl -tag -width /usr/share/misc/bugformatxx -compact | |
248 | .It Pa ~bugs/bug:ack | |
249 | the acknowledgement message | |
250 | .It Pa ~bugs/bug:redist | |
251 | the redistribution list | |
252 | .It Pa ~bugs/bug:lock | |
253 | the locking file | |
254 | .It Pa ~bugs/errors/BUG_?????? | |
255 | bug reports with format errors | |
256 | .It Pa ~bugs/log | |
257 | the log file | |
258 | .It Pa ~bugs/folder/summary | |
259 | the summary files | |
260 | .It Pa /usr/sbin/sendmail | |
261 | the mail delivery program | |
262 | .It Pa /usr/share/misc/bugformat | |
263 | a sample bug report format | |
264 | .El | |
265 | .Sh SEE ALSO | |
266 | .Xr sendbug 1 , | |
267 | .Xr aliases 5 , | |
268 | .Xr syslog 8 | |
269 | .Sh BUGS | |
270 | Since mail can be forwarded in a number of different ways, | |
271 | .Nm bugfiler | |
272 | does not recognize forwarded mail and will acknowledge to the forwarder | |
273 | instead of the original sender unless there is a | |
274 | .Dq Reply-To | |
275 | field in the | |
276 | header. | |
277 | .Pp | |
278 | This version of | |
279 | .Nm bugfiler | |
280 | is not compatible with the version | |
281 | released with | |
282 | .Bx 4.3 | |
283 | in that it doesn't complain to the sender about | |
284 | incorrectly formatted bug reports. | |
285 | Frankly, we got tired of the profanity, not to mention the extended | |
286 | conversations | |
287 | .Nm bugfiler | |
288 | was holding with | |
289 | .Xr vacation 1 . | |
290 | .Sh HISTORY | |
291 | The | |
292 | .Nm | |
293 | command appeared in | |
294 | .Bx 4.2 . |