Return to sendbug.1 CVS log

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

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

1.14    ! jmc         1: .\" $OpenBSD: sendbug.1,v 1.13 2007/04/06 01:32:39 ray 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.13      ray        15: .Op Fl DLPV
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
1.13      ray        53: .It Fl D
                     54: Do not attach
                     55: .Xr dmesg 8
                     56: to report.
                     57: The
                     58: .Xr dmesg 8
                     59: output is very helpful in reports,
                     60: but may contain sensitive information about the sender.
                     61: This flag helps protect users' privacy in those cases.
1.2       deraadt    62: .It Fl L
1.6       ray        63: Print the list of available categories.
1.2       deraadt    64: .It Fl P
1.6       ray        65: Generate and print the template with system information filled out.
1.2       deraadt    66: .It Fl V
1.6       ray        67: Print the version number.
1.2       deraadt    68: .El
1.1       ray        69: .Sh ENVIRONMENT
                     70: .Bl -tag -width Ds
1.9       ray        71: .It Ev EDITOR , VISUAL
1.1       ray        72: Specifies an editor to use.
1.9       ray        73: If both
1.1       ray        74: .Ev EDITOR
1.9       ray        75: and
                     76: .Ev VISUAL
                     77: are set,
                     78: .Ev VISUAL
                     79: takes precedence.
                     80: If neither
                     81: .Ev EDITOR
                     82: nor
                     83: .Ev VISUAL
                     84: are set,
1.1       ray        85: the default is
                     86: .Xr vi 1 .
1.4       ray        87: .It Ev PR_FORM
                     88: Filename of PR form to use instead of using the built-in form.
                     89: Such a PR form can be partially pre-completed to make the
                     90: process faster.
1.1       ray        91: .It Ev TMPDIR
                     92: Specifies a directory for temporary files to be created.
                     93: The default is
                     94: .Pa /tmp .
                     95: .El
1.7       ray        96: .Sh FILES
                     97: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
                     98: .It Pa /tmp/p.XXXXXXXXXX
                     99: temporary PR report
1.8       jmc       100: .El
1.11      jmc       101: .Sh SEE ALSO
1.14    ! jmc       102: .Xr crash 8 ,
        !           103: .Xr dmesg 8
1.1       ray       104: .Sh AUTHORS
                    105: .Nm
                    106: was written from scratch for the public domain by
                    107: .An Ray Lai Aq ray@cyth.net .
1.12      jmc       108: .Sh CAVEATS
                    109: The content of the PR is not confidential; it is sent out to a public
                    110: mailing list.
                    111: Sensitive, security related issues should be sent via email to
                    112: .Aq security@OpenBSD.org .