Return to sendbug.1 CVS log

Up to [local] / src / usr.bin / sendbug

Annotation of src/usr.bin/sendbug/sendbug.1, Revision 1.12

1.12    ! jmc         1: .\" $OpenBSD: sendbug.1,v 1.11 2007/03/28 19:34:34 jmc Exp $
1.1       ray         2: .\"
                      3: .\" Written by Raymond Lai <ray@cyth.net>.
                      4: .\" Public domain.
                      5: .\"
                      6: .Dd March 22, 2007
                      7: .Dt SENDBUG 1
                      8: .Os
                      9: .Sh NAME
                     10: .Nm sendbug
                     11: .Nd report a bug in
                     12: .Ox
                     13: .Sh SYNOPSIS
                     14: .Nm
1.5       ray        15: .Op Fl LPV
1.1       ray        16: .Sh DESCRIPTION
                     17: .Nm
1.10      jmc        18: is used to submit problem reports (PRs) to the
                     19: .Ox
                     20: bugs database.
1.12    ! jmc        21: A template PR is opened in a text editor
        !            22: with some system information,
        !            23: such as machine architecture,
        !            24: already filled in.
        !            25: Fields enclosed in
        !            26: .Sq \*(Lt\*(Gt
        !            27: should be completed by the user.
1.1       ray        28: .Pp
1.12    ! jmc        29: Once the PR is filled out,
        !            30: the user exits the editor and is presented with a choice:
        !            31: a)bort, e)dit, or s)end.
        !            32: If abort is selected,
1.6       ray        33: the report is not deleted and the pathname of the report is printed.
1.12    ! jmc        34: If edit is selected,
        !            35: the user is given a chance to re-edit the report.
        !            36: .Pp
        !            37: If send is selected,
        !            38: the report is mailed to the bugs database,
        !            39: with a Cc to the author.
        !            40: An auto-generated reply will be sent
        !            41: confirming the mail has been received.
        !            42: Any follow up mail to the PR
        !            43: should keep the same mail subject.
1.10      jmc        44: .Pp
1.12    ! jmc        45: The bugs database can be queried using the online bug tracking system
        !            46: available at
        !            47: .Pa http://www.openbsd.org/query-pr.html .
        !            48: This allows users to search for PRs based on either PR number
        !            49: or content.
1.2       deraadt    50: .Pp
                     51: The options are as follows:
                     52: .Bl -tag -width Ds
                     53: .It Fl L
1.6       ray        54: Print the list of available categories.
1.2       deraadt    55: .It Fl P
1.6       ray        56: Generate and print the template with system information filled out.
1.2       deraadt    57: .It Fl V
1.6       ray        58: Print the version number.
1.2       deraadt    59: .El
1.1       ray        60: .Sh ENVIRONMENT
                     61: .Bl -tag -width Ds
1.9       ray        62: .It Ev EDITOR , VISUAL
1.1       ray        63: Specifies an editor to use.
1.9       ray        64: If both
1.1       ray        65: .Ev EDITOR
1.9       ray        66: and
                     67: .Ev VISUAL
                     68: are set,
                     69: .Ev VISUAL
                     70: takes precedence.
                     71: If neither
                     72: .Ev EDITOR
                     73: nor
                     74: .Ev VISUAL
                     75: are set,
1.1       ray        76: the default is
                     77: .Xr vi 1 .
1.4       ray        78: .It Ev PR_FORM
                     79: Filename of PR form to use instead of using the built-in form.
                     80: Such a PR form can be partially pre-completed to make the
                     81: process faster.
1.1       ray        82: .It Ev TMPDIR
                     83: Specifies a directory for temporary files to be created.
                     84: The default is
                     85: .Pa /tmp .
                     86: .El
1.7       ray        87: .Sh FILES
                     88: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
                     89: .It Pa /tmp/p.XXXXXXXXXX
                     90: temporary PR report
1.8       jmc        91: .El
1.11      jmc        92: .Sh SEE ALSO
                     93: .Xr crash 8
1.1       ray        94: .Sh AUTHORS
                     95: .Nm
                     96: was written from scratch for the public domain by
                     97: .An Ray Lai Aq ray@cyth.net .
1.12    ! jmc        98: .Sh CAVEATS
        !            99: The content of the PR is not confidential; it is sent out to a public
        !           100: mailing list.
        !           101: Sensitive, security related issues should be sent via email to
        !           102: .Aq security@OpenBSD.org .