version #2, -v flag, remove home_dir, redist per folder

SCCS-vsn: libexec/bugfiler/bugfiler.8 6.5

diff --git a/usr/src/libexec/bugfiler/bugfiler.8 b/usr/src/libexec/bugfiler/bugfiler.8
index a62371e..3370f28 100644 (file)
--- a/usr/src/libexec/bugfiler/bugfiler.8
+++ b/usr/src/libexec/bugfiler/bugfiler.8
@@ -2,7 +2,7 @@
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"

-.\"    @(#)bugfiler.8  6.4 (Berkeley) %G%
+.\"    @(#)bugfiler.8  6.5 (Berkeley) %G%

 .\"
 .TH BUGFILER 8 ""
 .UC 5
 .\"
 .TH BUGFILER 8 ""
 .UC 5


@@ -10,7 +10,7 @@
 bugfiler \- file bug reports in folders automatically
 .SH SYNOPSIS
 .B bugfiler
 bugfiler \- file bug reports in folders automatically
 .SH SYNOPSIS
 .B bugfiler

-[ -ar ] [ home_dir ]
+[ -ar ] [-v version]

 .SH DESCRIPTION
 \fIBugfiler\fP is a program to automatically intercept, acknowledge,
 redistribute and store bug reports.  \fIBugfiler\fP is normally invoked
 .SH DESCRIPTION
 \fIBugfiler\fP is a program to automatically intercept, acknowledge,
 redistribute and store bug reports.  \fIBugfiler\fP is normally invoked


@@ -18,43 +18,43 @@ by the mail delivery program with a line similar to the following in
 /usr/lib/aliases.
 .PP
 .DT
 /usr/lib/aliases.
 .PP
 .DT

-       bugs:   "|bugfiler /usr/bugs/mail"
+       bugs:   "|bugfiler"

 .br
 .PP
 .br
 .PP

-All file paths in this man page that use \fIhome_dir\fP reference
-the optional \fIhome_dir\fP argument, or, if that is not supplied, the
-home directory of the login "bugs".  In either case, the login "bugs"
-must exist, as \fIbugfiler\fP expects its files and directories to
-be owned by "bugs".
+It should be noted that the login ``bugs'' must exist for the bugfiler
+to run.  Unless otherwise noted all paths used by \fIbugfiler\fP are
+relative to the home directory of this login.  \fIBugfiler\fP also
+expects all of its files and directories to be owned by ``bugs''.

 .PP
 A mail acknowledgement is automatically sent to the bug report filer
 .PP
 A mail acknowledgement is automatically sent to the bug report filer

-unless the \fB-a\fP flag is supplied.  If the file \fIhome_dir\fP/.ack
-exists, it is appended to this acknowledgement.
+unless the \fB-a\fP flag is supplied.  The file ~bugs/bug:ack is appended
+to this acknowledgement.

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

-       Index:  \fIfolder\fP    \fIsystem\fP
+       Index:  \fIfolder\fP    \fIversion\fP

 .br
 .PP
 .br
 .PP

-The directories \fIhome_dir\fP/system and \fIhome_dir\fP/system/folder
+The directories ~bugs/\fIversion\fP and ~bugs/\fIversion\fP/\fIfolder\fP

 must exist before \fIbugfiler\fP attempts to store the bug report.  Bug
 must exist before \fIbugfiler\fP attempts to store the bug report.  Bug

-reports will be stored in files named by the concatenation of
-\fIsystem, folder,\fP and sequential numbers, e.g., if \fIsystem\fP
-is "4.3BSD" and \fIfolder\fP is "ucb" the first bug report will
-be placed in \fIhome_dir\fP/4.3BSD/ucb/1.  To maintain backward
-compatibility, if \fIfolder\fP contains more than one component only
-the first one will be used, e.g. if \fIfolder\fP is "bin/from.c" or
-"bin/adb/con.c" it will be treated as if it were just "bin".
+reports will be stored in files named by the concatenation of \fIversion,
+folder,\fP and sequential numbers, i.e. if \fIversion\fP is ``4.3BSD'' and
+\fIfolder\fP is ``ucb'' the first bug report will be placed in
+~bugs/4.3BSD/ucb/1.  If \fIfolder\fP contains more than one component only
+the first one will be used, e.g. if \fIfolder\fP is ``bin/from.c'' or
+``bin/adb/con.c'' it will be treated as if it were simply ``bin''.  The
+\fI-v\fP flag is provided as a means to override the \fIversion\fP
+provided within the bug report itself.

 .PP
 If the \fB-r\fP flag is not supplied, redistribution of the bug reports
 .PP
 If the \fB-r\fP flag is not supplied, redistribution of the bug reports

-is done as specified in the file \fIhome_dir\fP/.redist.  This file is
-in the format of the
+is done as specified in the file ~bugs/\fIversion\fP/bug:redist.  This file
+is in the format of the

 .IR aliases (5)
 file, including comments and entries requiring multiple lines, with
 .IR aliases (5)
 file, including comments and entries requiring multiple lines, with

-the single exception that the \fIfolder\fP component of the "Index:"
-line replaces the name to alias.  For example, the \fI.redist\fP file
+the single exception that the \fIfolder\fP component of the ``Index:''
+line replaces the name to alias.  For example, the \fIbug:redist\fP file

 .PP
 .DT
        #       ucb folder redistribution list
 .PP
 .DT
        #       ucb folder redistribution list


@@ -64,19 +64,19 @@ line replaces the name to alias.  For example, the \fI.redist\fP file
                ra@beno.css.gov
 .br
 .PP
                ra@beno.css.gov
 .br
 .PP

-will send copies of all bug reports with "ucb" as the \fIfolder\fP
-to the logins karels, kjd, and ra.
+will send copies of all bug reports with ``ucb'' as the \fIfolder\fP
+to karels, kjd, and ra.

 .PP
 .PP

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

 .PP
 .PP

-Valid reports are also entered in the file
-\fIhome_dir/folder\fP/summary.  This file has an entry for each bug
-report in the \fIfolder\fP in the format:
+Valid bugs are also logged in the file ~bugs/\fIversion\fP/summary.
+This file has an entry for each bug report for \fIversion\fP in the
+format:

 .PP
 .DT
        Filename                Date
 .PP
 .DT
        Filename                Date


@@ -90,40 +90,48 @@ report in the \fIfolder\fP in the format:
                Status: Received
 .br
 .PP
                Status: Received
 .br
 .PP

-"Filename" is the concatenation of \fIsystem, folder,\fP 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.
-.PP
-The file \fIhome_dir\fP/bug:lock is the focus of all locking for
-\fIbugfiler.\fP  If you wish to manipulate any of the log or error
-files, remove it and \fIbugfiler\fP will treat all bug reports that
-it receives as if they were incorrectly formatted and place them
-in the directory \fIhome_dir\fP/errors, where they can be recovered by
-the \fIbugfiler\fP maintainer.
-.PP
-All errors that occur before \fIhome_dir\fP/log is found are logged
-into the system log file, using
+\fIFilename\fP is the concatenation of \fIversion, folder,\fP and a number
+as described above.  \fIDate\fP is the date as reported by the system
+clock, using ctime(3).  The \fISubject:\fP and \fIIndex:\fP lines are
+copies of the ``Subject:'' and ``Index:'' lines contained in the bug
+report.  The \fIOwner\fP and \fIStatus\fP fields are intended to provide a
+rudimentary method of tracking the status of bug reports.
+.PP
+The file ~bugs/bug:lock is the focus of all locking for \fIbugfiler.\fP
+If you wish to manipulate any of the log or error files, remove it and
+\fIbugfiler\fP 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,
+where they should recovered by the \fIbugfiler\fP maintainer.
+.PP
+All errors that occur before ~bugs/log is found are logged into the system
+log file, using

 .IR syslog (8).
 .SH FILES
 .IR syslog (8).
 .SH FILES

-.ta 3.0i
-home_dir/.ack                  the message sent in acknowledgement
-.br
-home_dir/.redist               the redistribution list
-.br
-home_dir/bug:lock              the locking file
-.br
-home_dir/errors/BUG_??????     bug reports with format errors

 .br
 .br

-home_dir/log                   the log file
-.br
-home_dir/folder/summary                the summary files
-.br
-/usr/lib/sendmail              the mail delivery program
-.br
-/usr/lib/bugformat             a sample bug report format
+.TP 25
+~bugs/bug:ack
+the acknowledgement message
+.TP 25
+~bugs/bug:redist
+the redistribution list
+.TP 25
+~bugs/bug:lock
+the locking file
+.TP 25
+~bugs/errors/BUG_??????
+bug reports with format errors
+.TP 25
+~bugs/log
+the log file
+.TP 25
+~bugs/folder/summary
+the summary files
+.TP 25
+/usr/lib/sendmail
+the mail delivery program
+.TP 25
+/usr/lib/bugformat
+a sample bug report format

 .SH "SEE ALSO"
 sendbug(1), aliases(5), syslog(8)
 .SH BUGS
 .SH "SEE ALSO"
 sendbug(1), aliases(5), syslog(8)
 .SH BUGS


@@ -132,9 +140,6 @@ 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.
 .PP
 instead of the original sender unless there is a `Reply-To' field in the
 header.
 .PP

-Duplicate messages should be recognized and handled in some
-reasonable fashion.
-.PP

 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.
 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.