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