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