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