[BACK]Return to sendbug.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / sendbug

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

1.23    ! schwarze    1: .\" $OpenBSD: sendbug.1,v 1.22 2013/07/07 18:17:50 jmc Exp $
1.1       ray         2: .\"
                      3: .\" Written by Raymond Lai <ray@cyth.net>.
                      4: .\" Public domain.
                      5: .\"
1.23    ! schwarze    6: .Dd $Mdocdate: July 7 2013 $
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.18      ray        15: .Op Fl DEPV
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
1.18      ray        22: with some system information already filled in,
1.12      jmc        23: such as machine architecture,
1.18      ray        24: .Xr dmesg 8 ,
1.20      sthen      25: .Xr usbdevs 8 ,
1.18      ray        26: .Xr pcidump 8 ,
                     27: and
                     28: .Xr acpidump 8 .
                     29: The
                     30: .Xr pcidump 8
                     31: and
                     32: .Xr acpidump 8
                     33: output are important for ACPI development and can only be included if
                     34: .Nm
                     35: is run as root.
                     36: .Pp
1.12      jmc        37: Fields enclosed in
                     38: .Sq \*(Lt\*(Gt
                     39: should be completed by the user.
                     40: Once the PR is filled out,
                     41: the user exits the editor and is presented with a choice:
                     42: a)bort, e)dit, or s)end.
                     43: If abort is selected,
1.6       ray        44: the report is not deleted and the pathname of the report is printed.
1.12      jmc        45: If edit is selected,
                     46: the user is given a chance to re-edit the report.
                     47: .Pp
                     48: If send is selected,
                     49: the report is mailed to the bugs database,
                     50: with a Cc to the author.
                     51: An auto-generated reply will be sent
                     52: confirming the mail has been received.
                     53: Any follow up mail to the PR
                     54: should keep the same mail subject.
1.10      jmc        55: .Pp
1.22      jmc        56: The status of bug reports can be followed by checking the
                     57: .Mt bugs@openbsd.org
                     58: mailing list archive available at
1.21      schwarze   59: .Lk http://www.openbsd.org/query-pr.html .
1.2       deraadt    60: .Pp
                     61: The options are as follows:
                     62: .Bl -tag -width Ds
1.13      ray        63: .It Fl D
1.18      ray        64: Do not attach
                     65: .Xr dmesg 8 ,
1.20      sthen      66: .Xr usbdevs 8 ,
1.18      ray        67: .Xr pcidump 8 ,
                     68: and
                     69: .Xr acpidump 8
1.19      jmc        70: output to the report.
1.18      ray        71: This information is very helpful in reports,
1.13      ray        72: but may contain sensitive information about the sender.
                     73: This flag helps protect users' privacy in those cases.
1.18      ray        74: .It Fl E
                     75: The
                     76: .Xr acpidump 8
                     77: output includes base64 encoded files.
                     78: This flag causes
                     79: .Nm
                     80: to read a PR from the standard input, decode the files,
                     81: and write them into the current directory.
1.2       deraadt    82: .It Fl P
1.6       ray        83: Generate and print the template with system information filled out.
1.2       deraadt    84: .It Fl V
1.6       ray        85: Print the version number.
1.2       deraadt    86: .El
1.1       ray        87: .Sh ENVIRONMENT
                     88: .Bl -tag -width Ds
1.9       ray        89: .It Ev EDITOR , VISUAL
1.1       ray        90: Specifies an editor to use.
1.9       ray        91: If both
1.1       ray        92: .Ev EDITOR
1.9       ray        93: and
                     94: .Ev VISUAL
                     95: are set,
                     96: .Ev VISUAL
                     97: takes precedence.
                     98: If neither
                     99: .Ev EDITOR
                    100: nor
                    101: .Ev VISUAL
                    102: are set,
1.1       ray       103: the default is
                    104: .Xr vi 1 .
1.4       ray       105: .It Ev PR_FORM
                    106: Filename of PR form to use instead of using the built-in form.
                    107: Such a PR form can be partially pre-completed to make the
                    108: process faster.
1.1       ray       109: .It Ev TMPDIR
                    110: Specifies a directory for temporary files to be created.
                    111: The default is
                    112: .Pa /tmp .
                    113: .El
1.7       ray       114: .Sh FILES
                    115: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
                    116: .It Pa /tmp/p.XXXXXXXXXX
                    117: temporary PR report
1.8       jmc       118: .El
1.11      jmc       119: .Sh SEE ALSO
1.14      jmc       120: .Xr crash 8 ,
1.19      jmc       121: .Xr dmesg 8
1.1       ray       122: .Sh AUTHORS
                    123: .Nm
                    124: was written from scratch for the public domain by
1.23    ! schwarze  125: .An Ray Lai Aq Mt ray@cyth.net .
1.12      jmc       126: .Sh CAVEATS
                    127: The content of the PR is not confidential; it is sent out to a public
                    128: mailing list.
                    129: Sensitive, security related issues should be sent via email to
1.23    ! schwarze  130: .Aq Mt security@OpenBSD.org .