1.\" $OpenBSD: sendbug.1,v 1.17 2008/12/14 07:46:24 ray Exp $ 2.\" 3.\" Written by Raymond Lai <ray@cyth.net>. 4.\" Public domain. 5.\" 6.Dd $Mdocdate: December 14 2008 $ 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 DPV 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 P 66Generate and print the template with system information filled out. 67.It Fl V 68Print the version number. 69.El 70.Sh ENVIRONMENT 71.Bl -tag -width Ds 72.It Ev EDITOR , VISUAL 73Specifies an editor to use. 74If both 75.Ev EDITOR 76and 77.Ev VISUAL 78are set, 79.Ev VISUAL 80takes precedence. 81If neither 82.Ev EDITOR 83nor 84.Ev VISUAL 85are set, 86the default is 87.Xr vi 1 . 88.It Ev PR_FORM 89Filename of PR form to use instead of using the built-in form. 90Such a PR form can be partially pre-completed to make the 91process faster. 92.It Ev TMPDIR 93Specifies a directory for temporary files to be created. 94The default is 95.Pa /tmp . 96.El 97.Sh FILES 98.Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact 99.It Pa /tmp/p.XXXXXXXXXX 100temporary PR report 101.El 102.Sh SEE ALSO 103.Xr crash 8 , 104.Xr dmesg 8 105.Sh AUTHORS 106.Nm 107was written from scratch for the public domain by 108.An Ray Lai Aq ray@cyth.net . 109.Sh CAVEATS 110The content of the PR is not confidential; it is sent out to a public 111mailing list. 112Sensitive, security related issues should be sent via email to 113.Aq security@OpenBSD.org . 114