1.\" $OpenBSD: sendbug.1,v 1.19 2009/06/10 06:46:53 jmc Exp $ 2.\" 3.\" Written by Raymond Lai <ray@cyth.net>. 4.\" Public domain. 5.\" 6.Dd $Mdocdate: June 10 2009 $ 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 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 \*(Lt\*(Gt 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. 50An auto-generated reply will be sent 51confirming the mail has been received. 52Any follow up mail to the PR 53should keep the same mail subject. 54.Pp 55The bugs database can be queried using the online bug tracking system 56available at 57.Pa http://www.openbsd.org/query-pr.html . 58This allows users to search for PRs based on either PR number 59or content. 60.Pp 61The options are as follows: 62.Bl -tag -width Ds 63.It Fl D 64Do not attach 65.Xr dmesg 8 , 66.Xr pcidump 8 , 67and 68.Xr acpidump 8 69output to the report. 70This information is very helpful in reports, 71but may contain sensitive information about the sender. 72This flag helps protect users' privacy in those cases. 73.It Fl E 74The 75.Xr acpidump 8 76output includes base64 encoded files. 77This flag causes 78.Nm 79to read a PR from the standard input, decode the files, 80and write them into the current directory. 81.It Fl P 82Generate and print the template with system information filled out. 83.It Fl V 84Print the version number. 85.El 86.Sh ENVIRONMENT 87.Bl -tag -width Ds 88.It Ev EDITOR , VISUAL 89Specifies an editor to use. 90If both 91.Ev EDITOR 92and 93.Ev VISUAL 94are set, 95.Ev VISUAL 96takes precedence. 97If neither 98.Ev EDITOR 99nor 100.Ev VISUAL 101are set, 102the default is 103.Xr vi 1 . 104.It Ev PR_FORM 105Filename of PR form to use instead of using the built-in form. 106Such a PR form can be partially pre-completed to make the 107process faster. 108.It Ev TMPDIR 109Specifies a directory for temporary files to be created. 110The default is 111.Pa /tmp . 112.El 113.Sh FILES 114.Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact 115.It Pa /tmp/p.XXXXXXXXXX 116temporary PR report 117.El 118.Sh SEE ALSO 119.Xr crash 8 , 120.Xr dmesg 8 121.Sh AUTHORS 122.Nm 123was written from scratch for the public domain by 124.An Ray Lai Aq ray@cyth.net . 125.Sh CAVEATS 126The content of the PR is not confidential; it is sent out to a public 127mailing list. 128Sensitive, security related issues should be sent via email to 129.Aq security@OpenBSD.org . 130