Return to sendbug.1 CVS log

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

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

1.17    ! ray         1: .\" $OpenBSD: sendbug.1,v 1.16 2007/05/31 19:20:16 jmc Exp $
1.1       ray         2: .\"
                      3: .\" Written by Raymond Lai <ray@cyth.net>.
                      4: .\" Public domain.
                      5: .\"
1.17    ! ray         6: .Dd $Mdocdate: May 31 2007 $
1.1       ray         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.17    ! ray        15: .Op Fl DPV
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,
1.15      jmc        24: already filled in,
                     25: and a
                     26: .Xr dmesg 8
                     27: attached.
1.12      jmc        28: Fields enclosed in
                     29: .Sq \*(Lt\*(Gt
                     30: should be completed by the user.
1.1       ray        31: .Pp
1.12      jmc        32: Once the PR is filled out,
                     33: the user exits the editor and is presented with a choice:
                     34: a)bort, e)dit, or s)end.
                     35: If abort is selected,
1.6       ray        36: the report is not deleted and the pathname of the report is printed.
1.12      jmc        37: If edit is selected,
                     38: the user is given a chance to re-edit the report.
                     39: .Pp
                     40: If send is selected,
                     41: the report is mailed to the bugs database,
                     42: with a Cc to the author.
                     43: An auto-generated reply will be sent
                     44: confirming the mail has been received.
                     45: Any follow up mail to the PR
                     46: should keep the same mail subject.
1.10      jmc        47: .Pp
1.12      jmc        48: The bugs database can be queried using the online bug tracking system
                     49: available at
                     50: .Pa http://www.openbsd.org/query-pr.html .
                     51: This allows users to search for PRs based on either PR number
                     52: or content.
1.2       deraadt    53: .Pp
                     54: The options are as follows:
                     55: .Bl -tag -width Ds
1.13      ray        56: .It Fl D
1.15      jmc        57: Do not attach a
1.13      ray        58: .Xr dmesg 8
                     59: to report.
                     60: The
                     61: .Xr dmesg 8
                     62: output is very helpful in reports,
                     63: but may contain sensitive information about the sender.
                     64: This flag helps protect users' privacy in those cases.
1.2       deraadt    65: .It Fl P
1.6       ray        66: Generate and print the template with system information filled out.
1.2       deraadt    67: .It Fl V
1.6       ray        68: Print the version number.
1.2       deraadt    69: .El
1.1       ray        70: .Sh ENVIRONMENT
                     71: .Bl -tag -width Ds
1.9       ray        72: .It Ev EDITOR , VISUAL
1.1       ray        73: Specifies an editor to use.
1.9       ray        74: If both
1.1       ray        75: .Ev EDITOR
1.9       ray        76: and
                     77: .Ev VISUAL
                     78: are set,
                     79: .Ev VISUAL
                     80: takes precedence.
                     81: If neither
                     82: .Ev EDITOR
                     83: nor
                     84: .Ev VISUAL
                     85: are set,
1.1       ray        86: the default is
                     87: .Xr vi 1 .
1.4       ray        88: .It Ev PR_FORM
                     89: Filename of PR form to use instead of using the built-in form.
                     90: Such a PR form can be partially pre-completed to make the
                     91: process faster.
1.1       ray        92: .It Ev TMPDIR
                     93: Specifies a directory for temporary files to be created.
                     94: The default is
                     95: .Pa /tmp .
                     96: .El
1.7       ray        97: .Sh FILES
                     98: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
                     99: .It Pa /tmp/p.XXXXXXXXXX
                    100: temporary PR report
1.8       jmc       101: .El
1.11      jmc       102: .Sh SEE ALSO
1.14      jmc       103: .Xr crash 8 ,
                    104: .Xr dmesg 8
1.1       ray       105: .Sh AUTHORS
                    106: .Nm
                    107: was written from scratch for the public domain by
                    108: .An Ray Lai Aq ray@cyth.net .
1.12      jmc       109: .Sh CAVEATS
                    110: The content of the PR is not confidential; it is sent out to a public
                    111: mailing list.
                    112: Sensitive, security related issues should be sent via email to
                    113: .Aq security@OpenBSD.org .