1.\" $OpenBSD: sendbug.1,v 1.24 2014/03/23 22:58:18 bcallah Exp $ 2.\" 3.\" Written by Raymond Lai <ray@cyth.net>. 4.\" Public domain. 5.\" 6.Dd $Mdocdate: March 23 2014 $ 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 status of bug reports can be followed by checking the 57.Mt bugs@openbsd.org 58mailing list archive available at 59.Lk http://marc.info/?l=openbsd-bugs . 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 usbdevs 8 , 67.Xr pcidump 8 , 68and 69.Xr acpidump 8 70output to the report. 71This information is very helpful in reports, 72but may contain sensitive information about the sender. 73This flag helps protect users' privacy in those cases. 74.It Fl E 75The 76.Xr acpidump 8 77output includes base64 encoded files. 78This flag causes 79.Nm 80to read a PR from the standard input, decode the files, 81and write them into the current directory. 82.It Fl P 83Generate and print the template with system information filled out. 84.It Fl V 85Print the version number. 86.El 87.Sh ENVIRONMENT 88.Bl -tag -width Ds 89.It Ev EDITOR , VISUAL 90Specifies an editor to use. 91If both 92.Ev EDITOR 93and 94.Ev VISUAL 95are set, 96.Ev VISUAL 97takes precedence. 98If neither 99.Ev EDITOR 100nor 101.Ev VISUAL 102are set, 103the default is 104.Xr vi 1 . 105.It Ev PR_FORM 106Filename of PR form to use instead of using the built-in form. 107Such a PR form can be partially pre-completed to make the 108process faster. 109.It Ev TMPDIR 110Specifies a directory for temporary files to be created. 111The default is 112.Pa /tmp . 113.El 114.Sh FILES 115.Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact 116.It Pa /tmp/p.XXXXXXXXXX 117temporary PR report 118.El 119.Sh SEE ALSO 120.Xr crash 8 , 121.Xr dmesg 8 122.Sh AUTHORS 123.Nm 124was written from scratch for the public domain by 125.An Ray Lai Aq Mt ray@cyth.net . 126.Sh CAVEATS 127The content of the PR is not confidential; it is sent out to a public 128mailing list. 129Sensitive, security related issues should be sent via email to 130.Aq Mt security@OpenBSD.org . 131