![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to bugfiler.8 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [CSRG BSD Unix] / 43BSDTahoe / man / man8|
Return to bugfiler.8 CVS log | Up to [CSRG BSD Unix] / 43BSDTahoe / man / man8 |
1.1 root 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: .\"
5: .\" @(#)bugfiler.8 6.8 (Berkeley) 11/23/87
6: .\"
7: .TH BUGFILER 8 "November 23, 1987"
8: .UC 5
9: .SH NAME
10: bugfiler \- file bug reports in folders automatically
11: .SH SYNOPSIS
12: .B bugfiler
13: [ -ar ] [-v version]
14: .SH DESCRIPTION
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.
19: .PP
20: .DT
21: bugs: "|bugfiler"
22: .br
23: .PP
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''.
28: .PP
29: For the bug report to be correctly filed, it must contain a line
30: in the following format:
31: .PP
32: .DT
33: Index: \fIfolder\fP \fIversion\fP
34: .br
35: .PP
36: The directories ~bugs/\fIversion\fP and ~bugs/\fIversion\fP/\fIfolder\fP
37: must exist before \fIbugfiler\fP attempts to store the bug report. Bug
38: reports will be stored in files named by the concatenation of \fIversion,
39: folder,\fP and sequential numbers, i.e. if \fIversion\fP is ``4.3BSD'' and
40: \fIfolder\fP is ``ucb'' the first bug report will be placed in
41: ~bugs/4.3BSD/ucb/1. If \fIfolder\fP contains more than one component only
42: the first one will be used, e.g. if \fIfolder\fP is ``bin/from.c'' or
43: ``bin/adb/con.c'' it will be treated as if it were simply ``bin''. The
44: \fI-v\fP flag is provided as a means to override the \fIversion\fP
45: provided within the bug report itself.
46: .PP
47: A mail acknowledgement is automatically sent to the bug report filer unless
48: the \fB-a\fP flag is supplied. The file ~bugs/\fIversion\fP/bug:ack is
49: appended to this acknowledgement.
50: .PP
51: If the \fB-r\fP flag is not supplied, redistribution of the bug reports
52: is done as specified in the file ~bugs/\fIversion\fP/bug:redist. This file
53: is in the format of the \fIaliases\fP(5) file, including comments and
54: entries requiring multiple lines, with the single exception that the
55: \fIfolder\fP component of the ``Index:'' line replaces the name to alias.
56: The special folder ``all:'' receives a redistribution of all bug reports
57: sent to this \fIversion\fP. For example, the \fIbug:redist\fP file
58: .PP
59: .DT
60: # bigbug gets a copy of everything
61: .br
62: all: bigbug
63: .br
64: # ucb folder redistribution list
65: .br
66: ucb: karels, [email protected]
67: .br
68: [email protected]
69: .br
70: .PP
71: will send copies of all bug reports with ``ucb'' as the \fIfolder\fP
72: to bigbug, karels, kjd, and ra.
73: .PP
74: Reports that cannot be filed, due to an invalid ``Index:'' line or
75: some other error, are placed in the directory ~bugs/errors. The
76: \fIbugfiler\fP maintainer should correct these bug reports and then
77: run \fIbugfiler\fP, with the corrected report as its standard input,
78: as bug reports with errors are neither acknowledged or redistributed.
79: All reports that \fIbugfiler\fP handles are logged in ~bugs/log.
80: .PP
81: Valid bugs are also logged in the file ~bugs/\fIversion\fP/summary.
82: This file has an entry for each bug report for \fIversion\fP in the
83: format:
84: .PP
85: .DT
86: Filename Date
87: .br
88: Subject:
89: .br
90: Index:
91: .br
92: Owner: Bugs Bunny
93: .br
94: Status: Received
95: .br
96: .PP
97: \fIFilename\fP is the concatenation of \fIversion, folder,\fP and a number
98: as described above. \fIDate\fP is the date as reported by the system
99: clock, using ctime(3). The \fISubject:\fP and \fIIndex:\fP lines are
100: copies of the ``Subject:'' and ``Index:'' lines contained in the bug
101: report. The \fIOwner\fP and \fIStatus\fP fields are intended to provide a
102: rudimentary method of tracking the status of bug reports.
103: .PP
104: The file ~bugs/bug:lock is the focus of all locking for \fIbugfiler.\fP
105: If you wish to manipulate any of the log or error files, rename or remove
106: it and \fIbugfiler\fP will treat all bug reports that it receives as if
107: they were incorrectly formatted, i.e. it will place them in the directory
108: ~bugs/errors, for later recovery by the \fIbugfiler\fP maintainer.
109: Obviously, this file must be created when you first install \fIbugfiler\fP.
110: .PP
111: All errors that occur before ~bugs/log is found are logged into the system
112: log file, using
113: .IR syslog (8).
114: .SH FILES
115: .br
116: .TP 25
117: ~bugs/bug:ack
118: the acknowledgement message
119: .TP 25
120: ~bugs/bug:redist
121: the redistribution list
122: .TP 25
123: ~bugs/bug:lock
124: the locking file
125: .TP 25
126: ~bugs/errors/BUG_??????
127: bug reports with format errors
128: .TP 25
129: ~bugs/log
130: the log file
131: .TP 25
132: ~bugs/folder/summary
133: the summary files
134: .TP 25
135: /usr/lib/sendmail
136: the mail delivery program
137: .TP 25
138: /usr/lib/bugformat
139: a sample bug report format
140: .SH "SEE ALSO"
141: sendbug(1), aliases(5), syslog(8)
142: .SH BUGS
143: Since mail can be forwarded in a number of different ways, \fIbugfiler\fP
144: does not recognize forwarded mail and will acknowledge to the forwarder
145: instead of the original sender unless there is a `Reply-To' field in the
146: header.
147: .PP
148: This version of the bugfiler is not compatible with the version
149: released with 4.3BSD in that it doesn't complain to the sender about
150: incorrectly formatted bug reports.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.