BUGFILER(8) 1990 BUGFILER(8) NNAAMMEE bugfiler - file bug reports in folders automatically SSYYNNOOPPSSIISS bbuuggffiilleerr [ -ar ] [-v version] DDEESSCCRRIIPPTTIIOONN _B_u_g_f_i_l_e_r is a program to automatically intercept, ack- nowledge, redistribute and store bug reports. _B_u_g_f_i_l_e_r is normally invoked by the mail delivery program with a line similar to the following in /etc/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 _b_u_g_f_i_l_e_r are relative to the home directory of this login. _B_u_g_f_i_l_e_r also expects all of its files and direc- tories to be owned by ``bugs''. For the bug report to be correctly filed, it must contain a line in the following format: Index: _f_o_l_d_e_r _v_e_r_s_i_o_n The directories ~bugs/_v_e_r_s_i_o_n and ~bugs/_v_e_r_s_i_o_n/_f_o_l_d_e_r must exist before _b_u_g_f_i_l_e_r attempts to store the bug report. Bug reports will be stored in files named by the concatenation of _v_e_r_s_i_o_n, _f_o_l_d_e_r, and sequential numbers, i.e. if _v_e_r_s_i_o_n is ``4.3BSD'' and _f_o_l_d_e_r is ``ucb'' the first bug report will be placed in ~bugs/4.3BSD/ucb/1. If _f_o_l_d_e_r contains more than one component only the first one will be used, e.g. if _f_o_l_d_e_r 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 _v_e_r_s_i_o_n provided within the bug report itself. A mail acknowledgement is automatically sent to the bug report filer unless the --aa flag is supplied. The file ~bugs/_v_e_r_s_i_o_n/bug:ack is appended to this acknowledgement. If the --rr flag is not supplied, redistribution of the bug reports is done as specified in the file ~bugs/_v_e_r_s_i_o_n/bug:redist. This file is in the format of the _a_l_i_a_s_e_s(5) file, including comments and entries requiring multiple lines, with the single exception that the _f_o_l_d_e_r component of the ``Index:'' line replaces the name to alias. The special folder ``all:'' receives a redistribution of all bug reports sent to this _v_e_r_s_i_o_n. For example, the _b_u_g:_r_e_d_i_s_t file Printed 7/27/90 June 1 BUGFILER(8) 1990 BUGFILER(8) # 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 _f_o_l_d_e_r 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 _b_u_g_f_i_l_e_r maintainer should correct these bug reports and then run _b_u_g_f_i_l_e_r, with the corrected report as its standard input, as bug reports with errors are nei- ther acknowledged or redistributed. All reports that _b_u_g_- _f_i_l_e_r handles are logged in ~bugs/log. Valid bugs are also logged in the file ~bugs/_v_e_r_s_i_o_n/summary. This file has an entry for each bug report for _v_e_r_s_i_o_n in the format: Filename Date Subject: Index: Owner: Bugs Bunny Status: Received _F_i_l_e_n_a_m_e is the concatenation of _v_e_r_s_i_o_n, _f_o_l_d_e_r, and a number as described above. _D_a_t_e is the date as reported by the system clock, using ctime(3). The _S_u_b_j_e_c_t: and _I_n_d_e_x: lines are copies of the ``Subject:'' and ``Index:'' lines contained in the bug report. The _O_w_n_e_r and _S_t_a_t_u_s 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 _b_u_g_- _f_i_l_e_r. If you wish to manipulate any of the log or error files, rename or remove it and _b_u_g_f_i_l_e_r will treat all bug reports that it receives as if they were incorrectly format- ted, i.e. it will place them in the directory ~bugs/errors, for later recovery by the _b_u_g_f_i_l_e_r maintainer. Obviously, this file must be created when you first install _b_u_g_f_i_l_e_r. All errors that occur before ~bugs/log is found are logged into the system log file, using _s_y_s_l_o_g(8). FFIILLEESS ~bugs/bug:ack the acknowledgement message ~bugs/bug:redist the redistribution list ~bugs/bug:lock the locking file Printed 7/27/90 June 2 BUGFILER(8) 1990 BUGFILER(8) ~bugs/errors/BUG_?????? bug reports with format errors ~bugs/log the log file ~bugs/folder/summary the summary files /usr/sbin/sendmail the mail delivery program /usr/share/misc/bugformat a sample bug report format SSEEEE AALLSSOO sendbug(1), aliases(5), syslog(8) BBUUGGSS Since mail can be forwarded in a number of different ways, _b_u_g_f_i_l_e_r does not recognize forwarded mail and will ack- nowledge 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 ver- sion 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 _b_u_g_f_i_l_e_r was holding with _v_a_c_a_t_i_o_n(1). Printed 7/27/90 June 3