[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.26

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