Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)bugfiler.8 6.9 (Berkeley) 10/25/88

C 5 bugfiler - file bug reports in folders automatically bugfiler [ -ar ] [-v version] Bugfiler is a program to automatically intercept, acknowledge, redistribute and store bug reports. Bugfiler is normally invoked by the mail delivery program with a line similar to the following in /usr/lib/aliases.

bugs: "|bugfiler"

It should be noted that the login ``bugs'' must exist for the bugfiler to run. Unless otherwise noted all paths used by bugfiler are relative to the home directory of this login. Bugfiler also expects all of its files and directories to be owned by ``bugs''.

For the bug report to be correctly filed, it must contain a line in the following format:

Index: folder version

The directories ~bugs/version and ~bugs/version/folder must exist before bugfiler attempts to store the bug report. Bug reports will be stored in files named by the concatenation of version, folder, and sequential numbers, i.e. if version is ``4.3BSD'' and folder is ``ucb'' the first bug report will be placed in ~bugs/4.3BSD/ucb/1. If folder contains more than one component only the first one will be used, e.g. if folder is ``bin/from.c'' or ``bin/adb/con.c'' it will be treated as if it were simply ``bin''. The -v flag is provided as a means to override the version provided within the bug report itself.

A mail acknowledgement is automatically sent to the bug report filer unless the -a flag is supplied. The file ~bugs/version/bug:ack is appended to this acknowledgement.

If the -r flag is not supplied, redistribution of the bug reports is done as specified in the file ~bugs/version/bug:redist. This file is in the format of the aliases(5) file, including comments and entries requiring multiple lines, with the single exception that the folder component of the ``Index:'' line replaces the name to alias. The special folder ``all:'' receives a redistribution of all bug reports sent to this version. For example, the bug:redist file

# bigbug gets a copy of everything

all: bigbug

# ucb folder redistribution list

ucb: karels, kjd@coke.berkeley.edu

ra@beno.css.gov

will send copies of all bug reports with ``ucb'' as the folder to bigbug, karels, kjd, and ra.

Reports that cannot be filed, due to an invalid ``Index:'' line or some other error, are placed in the directory ~bugs/errors. The bugfiler maintainer should correct these bug reports and then run bugfiler, with the corrected report as its standard input, as bug reports with errors are neither acknowledged or redistributed. All reports that bugfiler handles are logged in ~bugs/log.

Valid bugs are also logged in the file ~bugs/version/summary. This file has an entry for each bug report for version in the format:

Filename Date

Subject:

Index:

Owner: Bugs Bunny

Status: Received

Filename is the concatenation of version, folder, and a number as described above. Date is the date as reported by the system clock, using ctime(3). The Subject: and Index: lines are copies of the ``Subject:'' and ``Index:'' lines contained in the bug report. The Owner and Status fields are intended to provide a rudimentary method of tracking the status of bug reports.

The file ~bugs/bug:lock is the focus of all locking for bugfiler. If you wish to manipulate any of the log or error files, rename or remove it and bugfiler will treat all bug reports that it receives as if they were incorrectly formatted, i.e. it will place them in the directory ~bugs/errors, for later recovery by the bugfiler maintainer. Obviously, this file must be created when you first install bugfiler.

All errors that occur before ~bugs/log is found are logged into the system log file, using syslog (8).

25 ~bugs/bug:ack the acknowledgement message

25 ~bugs/bug:redist the redistribution list

25 ~bugs/bug:lock the locking file

25 ~bugs/errors/BUG_?????? bug reports with format errors

25 ~bugs/log the log file

25 ~bugs/folder/summary the summary files

25 /usr/lib/sendmail the mail delivery program

25 /usr/lib/bugformat a sample bug report format

sendbug(1), aliases(5), syslog(8) Since mail can be forwarded in a number of different ways, bugfiler does not recognize forwarded mail and will acknowledge to the forwarder instead of the original sender unless there is a `Reply-To' field in the header.

This version of the bugfiler is not compatible with the version released with 4.3BSD in that it doesn't complain to the sender about incorrectly formatted bug reports. Frankly, we got tired of the profanity, not to mention the extended conversations bugfiler was holding with vacation (1).