BSD 4_3_Reno development

[unix-history] / usr / share / man / cat8 / bugfiler.0

BUGFILER(8)		      1990		      BUGFILER(8)



N\bNA\bAM\bME\bE
     bugfiler - file bug reports in folders automatically

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     b\bbu\bug\bgf\bfi\bil\ble\ber\br [ -ar ] [-v version]

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     _\bB_\bu_\bg_\bf_\bi_\bl_\be_\br is a program to automatically intercept, ack-
     nowledge, redistribute and store bug reports.  _\bB_\bu_\bg_\bf_\bi_\bl_\be_\br 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 _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br are relative to the home directory of this
     login.  _\bB_\bu_\bg_\bf_\bi_\bl_\be_\br 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:    _\bf_\bo_\bl_\bd_\be_\br    _\bv_\be_\br_\bs_\bi_\bo_\bn

     The directories ~bugs/_\bv_\be_\br_\bs_\bi_\bo_\bn and ~bugs/_\bv_\be_\br_\bs_\bi_\bo_\bn/_\bf_\bo_\bl_\bd_\be_\br must
     exist before _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br attempts to store the bug report.  Bug
     reports will be stored in files named by the concatenation
     of _\bv_\be_\br_\bs_\bi_\bo_\bn, _\bf_\bo_\bl_\bd_\be_\br, and sequential numbers, i.e. if _\bv_\be_\br_\bs_\bi_\bo_\bn
     is ``4.3BSD'' and _\bf_\bo_\bl_\bd_\be_\br is ``ucb'' the first bug report
     will be placed in ~bugs/4.3BSD/ucb/1.  If _\bf_\bo_\bl_\bd_\be_\br contains
     more than one component only the first one will be used,
     e.g. if _\bf_\bo_\bl_\bd_\be_\br is ``bin/from.c'' or ``bin/adb/con.c'' it
     will be treated as if it were simply ``bin''.  The -_\bv flag
     is provided as a means to override the _\bv_\be_\br_\bs_\bi_\bo_\bn provided
     within the bug report itself.

     A mail acknowledgement is automatically sent to the bug
     report filer unless the -\b-a\ba flag is supplied.  The file
     ~bugs/_\bv_\be_\br_\bs_\bi_\bo_\bn/bug:ack is appended to this acknowledgement.

     If the -\b-r\br flag is not supplied, redistribution of the bug
     reports is done as specified in the file
     ~bugs/_\bv_\be_\br_\bs_\bi_\bo_\bn/bug:redist.	This file is in the format of the
     _\ba_\bl_\bi_\ba_\bs_\be_\bs(5) file, including comments and entries requiring
     multiple lines, with the single exception that the _\bf_\bo_\bl_\bd_\be_\br
     component of the ``Index:'' line replaces the name to alias.
     The special folder ``all:'' receives a redistribution of all
     bug reports sent to this _\bv_\be_\br_\bs_\bi_\bo_\bn.	For example, the
     _\bb_\bu_\bg:_\br_\be_\bd_\bi_\bs_\bt 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
     _\bf_\bo_\bl_\bd_\be_\br 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 _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br maintainer should correct these
     bug reports and then run _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br, with the corrected report
     as its standard input, as bug reports with errors are nei-
     ther acknowledged or redistributed.  All reports that _\bb_\bu_\bg_\b-
     _\bf_\bi_\bl_\be_\br handles are logged in ~bugs/log.

     Valid bugs are also logged in the file
     ~bugs/_\bv_\be_\br_\bs_\bi_\bo_\bn/summary.  This file has an entry for each bug
     report for _\bv_\be_\br_\bs_\bi_\bo_\bn in the format:

	  Filename	 Date
	       Subject:
	       Index:
	       Owner:	 Bugs Bunny
	       Status:	 Received

     _\bF_\bi_\bl_\be_\bn_\ba_\bm_\be is the concatenation of _\bv_\be_\br_\bs_\bi_\bo_\bn, _\bf_\bo_\bl_\bd_\be_\br, and a
     number as described above.  _\bD_\ba_\bt_\be is the date as reported by
     the system clock, using ctime(3).	The _\bS_\bu_\bb_\bj_\be_\bc_\bt: and _\bI_\bn_\bd_\be_\bx:
     lines are copies of the ``Subject:'' and ``Index:'' lines
     contained in the bug report.  The _\bO_\bw_\bn_\be_\br and _\bS_\bt_\ba_\bt_\bu_\bs 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 _\bb_\bu_\bg_\b-
     _\bf_\bi_\bl_\be_\br.  If you wish to manipulate any of the log or error
     files, rename or remove it and _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br 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 _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br maintainer.  Obviously,
     this file must be created when you first install _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br.

     All errors that occur before ~bugs/log is found are logged
     into the system log file, using _\bs_\by_\bs_\bl_\bo_\bg(8).

F\bFI\bIL\bLE\bES\bS
     ~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

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     sendbug(1), aliases(5), syslog(8)

B\bBU\bUG\bGS\bS
     Since mail can be forwarded in a number of different ways,
     _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br 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 _\bb_\bu_\bg_\bf_\bi_\bl_\be_\br was holding with _\bv_\ba_\bc_\ba_\bt_\bi_\bo_\bn(1).






























Printed 7/27/90               June				3