4.4BSD/usr/share/man/cat8/bugfiler.0

BUGFILER(8)               BSD System Manager's Manual              BUGFILER(8)

NNAAMMEE
     bbuuggffiilleerr - file bug reports in folders automatically

SSYYNNOOPPSSIISS
     bbuuggffiilleerr [--aarr] [--vv _v_e_r_s_i_o_n]

DDEESSCCRRIIPPTTIIOONN
     BBuuggffiilleerr is a program to automatically intercept, acknowledge, redis-
     tribute and store bug reports.  BBuuggffiilleerr is normally invoked by the mail
     delivery program with a line similar to the following in _/_e_t_c_/_a_l_i_a_s_e_s.

           bugs:   "|bugfiler"

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

     Available options.

     --aa      Do not send automatic mail acknowledgement to the bug report fil-
             er.  (The default is to send the acknowledgement with the file
             _~_b_u_g_s_/_v_e_r_s_i_o_n_/_b_u_g_:_a_c_k appended).

     --rr      Do not redistribute.

     --vv _v_e_r_s_i_o_n
             Override the _v_e_r_s_i_o_n provided within the bug report itself.

     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 _~_b_u_g_s_/_v_e_r_s_i_o_n and _~_b_u_g_s_/_v_e_r_s_i_o_n_/_f_o_l_d_e_r must exist before
     bbuuggffiilleerr 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 num-
     bers, i.e. if _v_e_r_s_i_o_n is ``4.3 BSD'' and _f_o_l_d_e_r is ``ucb'' the first bug
     report will be placed in _~_b_u_g_s_/_4_._3_B_S_D_/_u_c_b_/_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 sim-
     ply ``bin''.

     If the --rr flag is not supplied, redistribution of the bug reports is done
     as specified in the file _~_b_u_g_s_/_v_e_r_s_i_o_n_/_b_u_g_:_r_e_d_i_s_t. This file is in the
     format of the aliases(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

           #       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 _~_b_u_g_s_/_e_r_r_o_r_s. The bbuuggffiilleerr main-
     tainer should correct these bug reports and then run bbuuggffiilleerr, with the
     corrected report as its standard input, as bug reports with errors are
     neither acknowledged or redistributed.  All reports that bbuuggffiilleerr handles
     are logged in _~_b_u_g_s_/_l_o_g_.

     Valid bugs are also logged in the file _~_b_u_g_s_/_v_e_r_s_i_o_n_/_s_u_m_m_a_r_y_. 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

     Filename is the concatenation of _v_e_r_s_i_o_n, _f_o_l_d_e_r, and a number as de-
     scribed above.  Date is the date as reported by the system clock, using
     ctime(3).  The Subject: and Index: lines are The ``Subject:'' and
     ``Index:'' lines are copies of the ``Subject:'' and ``index:'' lines con-
     tained 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 _~_b_u_g_s_/_b_u_g_:_l_o_c_k is the focus of all locking for bbuuggffiilleerr. If you
     wish to manipulate any of the log or error files, rename or remove it and
     bbuuggffiilleerr will treat all bug reports that it receives as if they were in-
     correctly formatted, i.e. it will place them in the directory
     _~_b_u_g_s_/_e_r_r_o_r_s, for later recovery by the bbuuggffiilleerr maintainer.  Obviously,
     this file must be created when you first install bbuuggffiilleerr.

     All errors that occur before _~_b_u_g_s_/_l_o_g is found are logged into the sys-
     tem log file, using syslog(8).

FFIILLEESS
     ~bugs/bug:ack                the acknowledgement message
     ~bugs/bug:redist             the redistribution list
     ~bugs/bug:lock               the locking file
     ~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, bbuuggffiilleerr does
     not recognize forwarded mail and will acknowledge to the forwarder in-
     stead of the original sender unless there is a ``Reply-To'' field in the
     header.

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

HHIISSTTOORRYY
     The bbuuggffiilleerr command appeared in 4.2BSD.

4.2 Berkeley Distribution        June 4, 1993                                2