Annotation of 43BSDReno/libexec/bugfiler/bugfiler.8, revision 1.1

1.1     ! root        1: .\" Copyright (c) 1983 The Regents of the University of California.
        !             2: .\" All rights reserved.
        !             3: .\"
        !             4: .\" Redistribution and use in source and binary forms are permitted provided
        !             5: .\" that: (1) source distributions retain this entire copyright notice and
        !             6: .\" comment, and (2) distributions including binaries display the following
        !             7: .\" acknowledgement:  ``This product includes software developed by the
        !             8: .\" University of California, Berkeley and its contributors'' in the
        !             9: .\" documentation or other materials provided with the distribution and in
        !            10: .\" all advertising materials mentioning features or use of this software.
        !            11: .\" Neither the name of the University nor the names of its contributors may
        !            12: .\" be used to endorse or promote products derived from this software without
        !            13: .\" specific prior written permission.
        !            14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
        !            15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
        !            16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
        !            17: .\"
        !            18: .\"    @(#)bugfiler.8  6.10 (Berkeley) 6/24/90
        !            19: .\"
        !            20: .TH BUGFILER 8 "June 24, 1990"
        !            21: .UC 5
        !            22: .SH NAME
        !            23: bugfiler \- file bug reports in folders automatically
        !            24: .SH SYNOPSIS
        !            25: .B bugfiler
        !            26: [ -ar ] [-v version]
        !            27: .SH DESCRIPTION
        !            28: \fIBugfiler\fP is a program to automatically intercept, acknowledge,
        !            29: redistribute and store bug reports.  \fIBugfiler\fP is normally invoked
        !            30: by the mail delivery program with a line similar to the following in
        !            31: /etc/aliases.
        !            32: .PP
        !            33: .DT
        !            34:        bugs:   "|bugfiler"
        !            35: .br
        !            36: .PP
        !            37: It should be noted that the login ``bugs'' must exist for the bugfiler
        !            38: to run.  Unless otherwise noted all paths used by \fIbugfiler\fP are
        !            39: relative to the home directory of this login.  \fIBugfiler\fP also
        !            40: expects all of its files and directories to be owned by ``bugs''.
        !            41: .PP
        !            42: For the bug report to be correctly filed, it must contain a line
        !            43: in the following format:
        !            44: .PP
        !            45: .DT
        !            46:        Index:  \fIfolder\fP    \fIversion\fP
        !            47: .br
        !            48: .PP
        !            49: The directories ~bugs/\fIversion\fP and ~bugs/\fIversion\fP/\fIfolder\fP
        !            50: must exist before \fIbugfiler\fP attempts to store the bug report.  Bug
        !            51: reports will be stored in files named by the concatenation of \fIversion,
        !            52: folder,\fP and sequential numbers, i.e. if \fIversion\fP is ``4.3BSD'' and
        !            53: \fIfolder\fP is ``ucb'' the first bug report will be placed in
        !            54: ~bugs/4.3BSD/ucb/1.  If \fIfolder\fP contains more than one component only
        !            55: the first one will be used, e.g. if \fIfolder\fP is ``bin/from.c'' or
        !            56: ``bin/adb/con.c'' it will be treated as if it were simply ``bin''.  The
        !            57: \fI-v\fP flag is provided as a means to override the \fIversion\fP
        !            58: provided within the bug report itself.
        !            59: .PP
        !            60: A mail acknowledgement is automatically sent to the bug report filer unless
        !            61: the \fB-a\fP flag is supplied.  The file ~bugs/\fIversion\fP/bug:ack is
        !            62: appended to this acknowledgement.
        !            63: .PP
        !            64: If the \fB-r\fP flag is not supplied, redistribution of the bug reports
        !            65: is done as specified in the file ~bugs/\fIversion\fP/bug:redist.  This file
        !            66: is in the format of the \fIaliases\fP(5) file, including comments and
        !            67: entries requiring multiple lines, with the single exception that the
        !            68: \fIfolder\fP component of the ``Index:'' line replaces the name to alias.
        !            69: The special folder ``all:'' receives a redistribution of all bug reports
        !            70: sent to this \fIversion\fP.  For example, the \fIbug:redist\fP file
        !            71: .PP
        !            72: .DT
        !            73:        #       bigbug gets a copy of everything
        !            74: .br
        !            75:        all:    bigbug
        !            76: .br
        !            77:        #       ucb folder redistribution list
        !            78: .br
        !            79:        ucb:    karels, [email protected]
        !            80: .br
        !            81:                [email protected]
        !            82: .br
        !            83: .PP
        !            84: will send copies of all bug reports with ``ucb'' as the \fIfolder\fP
        !            85: to bigbug, karels, kjd, and ra.
        !            86: .PP
        !            87: Reports that cannot be filed, due to an invalid ``Index:'' line or
        !            88: some other error, are placed in the directory ~bugs/errors.  The
        !            89: \fIbugfiler\fP maintainer should correct these bug reports and then
        !            90: run \fIbugfiler\fP, with the corrected report as its standard input,
        !            91: as bug reports with errors are neither acknowledged or redistributed.
        !            92: All reports that \fIbugfiler\fP handles are logged in ~bugs/log.
        !            93: .PP
        !            94: Valid bugs are also logged in the file ~bugs/\fIversion\fP/summary.
        !            95: This file has an entry for each bug report for \fIversion\fP in the
        !            96: format:
        !            97: .PP
        !            98: .DT
        !            99:        Filename                Date
        !           100: .br
        !           101:                Subject:
        !           102: .br
        !           103:                Index:
        !           104: .br
        !           105:                Owner:  Bugs Bunny
        !           106: .br
        !           107:                Status: Received
        !           108: .br
        !           109: .PP
        !           110: \fIFilename\fP is the concatenation of \fIversion, folder,\fP and a number
        !           111: as described above.  \fIDate\fP is the date as reported by the system
        !           112: clock, using ctime(3).  The \fISubject:\fP and \fIIndex:\fP lines are
        !           113: copies of the ``Subject:'' and ``Index:'' lines contained in the bug
        !           114: report.  The \fIOwner\fP and \fIStatus\fP fields are intended to provide a
        !           115: rudimentary method of tracking the status of bug reports.
        !           116: .PP
        !           117: The file ~bugs/bug:lock is the focus of all locking for \fIbugfiler.\fP
        !           118: If you wish to manipulate any of the log or error files, rename or remove
        !           119: it and \fIbugfiler\fP will treat all bug reports that it receives as if
        !           120: they were incorrectly formatted, i.e. it will place them in the directory
        !           121: ~bugs/errors, for later recovery by the \fIbugfiler\fP maintainer.
        !           122: Obviously, this file must be created when you first install \fIbugfiler\fP.
        !           123: .PP
        !           124: All errors that occur before ~bugs/log is found are logged into the system
        !           125: log file, using
        !           126: .IR syslog (8).
        !           127: .SH FILES
        !           128: .br
        !           129: .TP 25
        !           130: ~bugs/bug:ack
        !           131: the acknowledgement message
        !           132: .TP 25
        !           133: ~bugs/bug:redist
        !           134: the redistribution list
        !           135: .TP 25
        !           136: ~bugs/bug:lock
        !           137: the locking file
        !           138: .TP 25
        !           139: ~bugs/errors/BUG_??????
        !           140: bug reports with format errors
        !           141: .TP 25
        !           142: ~bugs/log
        !           143: the log file
        !           144: .TP 25
        !           145: ~bugs/folder/summary
        !           146: the summary files
        !           147: .TP 25
        !           148: /usr/sbin/sendmail
        !           149: the mail delivery program
        !           150: .TP 25
        !           151: /usr/share/misc/bugformat
        !           152: a sample bug report format
        !           153: .SH "SEE ALSO"
        !           154: sendbug(1), aliases(5), syslog(8)
        !           155: .SH BUGS
        !           156: Since mail can be forwarded in a number of different ways, \fIbugfiler\fP
        !           157: does not recognize forwarded mail and will acknowledge to the forwarder
        !           158: instead of the original sender unless there is a `Reply-To' field in the
        !           159: header.
        !           160: .PP
        !           161: This version of the bugfiler is not compatible with the version
        !           162: released with 4.3BSD in that it doesn't complain to the sender about
        !           163: incorrectly formatted bug reports.
        !           164: Frankly, we got tired of the profanity, not to mention the extended
        !           165: conversations
        !           166: .I bugfiler
        !           167: was holding with
        !           168: .IR vacation (1).

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.