xref: /openbsd-src/usr.bin/sendbug/sendbug.1 (revision d905fc10a3527c993c262ab7a5c86ba8232b3bdc)
1*d905fc10Sjsg.\" $OpenBSD: sendbug.1,v 1.29 2022/02/18 10:24:32 jsg Exp $
25ae6585fSray.\"
35ae6585fSray.\" Written by Raymond Lai <ray@cyth.net>.
45ae6585fSray.\" Public domain.
55ae6585fSray.\"
6*d905fc10Sjsg.Dd $Mdocdate: February 18 2022 $
75ae6585fSray.Dt SENDBUG 1
85ae6585fSray.Os
95ae6585fSray.Sh NAME
105ae6585fSray.Nm sendbug
1149901277Sschwarze.Nd report a bug in OpenBSD
125ae6585fSray.Sh SYNOPSIS
135ae6585fSray.Nm
1423243dd5Sderaadt.Op Fl DEP
155ae6585fSray.Sh DESCRIPTION
165ae6585fSray.Nm
178e0c2ef8Sjmcis used to submit problem reports (PRs) to the
188e0c2ef8Sjmc.Ox
198e0c2ef8Sjmcbugs database.
20b5fc6018SjmcA template PR is opened in a text editor
218ef3815aSraywith some system information already filled in,
22b5fc6018Sjmcsuch as machine architecture,
238ef3815aSray.Xr dmesg 8 ,
24d070c508Ssthen.Xr usbdevs 8 ,
258ef3815aSray.Xr pcidump 8 ,
268ef3815aSrayand
278ef3815aSray.Xr acpidump 8 .
288ef3815aSrayThe
298ef3815aSray.Xr pcidump 8
308ef3815aSrayand
318ef3815aSray.Xr acpidump 8
328ef3815aSrayoutput are important for ACPI development and can only be included if
338ef3815aSray.Nm
348ef3815aSrayis run as root.
358ef3815aSray.Pp
36b5fc6018SjmcFields enclosed in
376b2227a6Sjmc.Sq <>
38b5fc6018Sjmcshould be completed by the user.
39b5fc6018SjmcOnce the PR is filled out,
40b5fc6018Sjmcthe user exits the editor and is presented with a choice:
41b5fc6018Sjmca)bort, e)dit, or s)end.
42b5fc6018SjmcIf abort is selected,
43d0742309Sraythe report is not deleted and the pathname of the report is printed.
44b5fc6018SjmcIf edit is selected,
45b5fc6018Sjmcthe user is given a chance to re-edit the report.
467d5f08c0Sderaadt.Pp
47b5fc6018SjmcIf send is selected,
48b5fc6018Sjmcthe report is mailed to the bugs database,
49b5fc6018Sjmcwith a Cc to the author.
50b5fc6018SjmcAny follow up mail to the PR
51b5fc6018Sjmcshould keep the same mail subject.
52b5fc6018Sjmc.Pp
53b11d99ceSjmcThe status of bug reports can be followed by checking the
54b11d99ceSjmc.Mt bugs@openbsd.org
55b11d99ceSjmcmailing list archive available at
56*d905fc10Sjsg.Lk https://marc.info/?l=openbsd-bugs .
578e0c2ef8Sjmc.Pp
587d5f08c0SderaadtThe options are as follows:
597d5f08c0Sderaadt.Bl -tag -width Ds
607d2774c0Sray.It Fl D
618ef3815aSrayDo not attach
628ef3815aSray.Xr dmesg 8 ,
63d070c508Ssthen.Xr usbdevs 8 ,
648ef3815aSray.Xr pcidump 8 ,
658ef3815aSrayand
668ef3815aSray.Xr acpidump 8
670e5ed449Sjmcoutput to the report.
688ef3815aSrayThis information is very helpful in reports,
697d2774c0Sraybut may contain sensitive information about the sender.
707d2774c0SrayThis flag helps protect users' privacy in those cases.
718ef3815aSray.It Fl E
728ef3815aSrayThe
738ef3815aSray.Xr acpidump 8
748ef3815aSrayoutput includes base64 encoded files.
758ef3815aSrayThis flag causes
768ef3815aSray.Nm
778ef3815aSrayto read a PR from the standard input, decode the files,
788ef3815aSrayand write them into the current directory.
797d5f08c0Sderaadt.It Fl P
80d0742309SrayGenerate and print the template with system information filled out.
817d5f08c0Sderaadt.El
825ae6585fSray.Sh ENVIRONMENT
835ae6585fSray.Bl -tag -width Ds
84c8a426adSray.It Ev EDITOR , VISUAL
855ae6585fSraySpecifies an editor to use.
86c8a426adSrayIf both
875ae6585fSray.Ev EDITOR
88c8a426adSrayand
89c8a426adSray.Ev VISUAL
90c8a426adSrayare set,
91c8a426adSray.Ev VISUAL
92c8a426adSraytakes precedence.
93c8a426adSrayIf neither
94c8a426adSray.Ev EDITOR
95c8a426adSraynor
96c8a426adSray.Ev VISUAL
97c8a426adSrayare set,
985ae6585fSraythe default is
995ae6585fSray.Xr vi 1 .
1004ff3398aSderaadt.It Ev PR_FORM
1014ff3398aSderaadtFilename of PR form to use instead of using the built-in form.
1024ff3398aSderaadtSuch a PR form can be partially pre-completed to make the
1034ff3398aSderaadtprocess faster.
1045ae6585fSray.El
105c52a4b9eSray.Sh FILES
106c52a4b9eSray.Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
107c52a4b9eSray.It Pa /tmp/p.XXXXXXXXXX
108c52a4b9eSraytemporary PR report
109b13d1ac9Sjmc.El
110e622290eSjmc.Sh SEE ALSO
111ba9430b4Sjmc.Xr crash 8 ,
1120e5ed449Sjmc.Xr dmesg 8
1135ae6585fSray.Sh AUTHORS
1145ae6585fSray.Nm
1155ae6585fSraywas written from scratch for the public domain by
11676c04420Sschwarze.An Ray Lai Aq Mt ray@cyth.net .
117b5fc6018Sjmc.Sh CAVEATS
118b5fc6018SjmcThe content of the PR is not confidential; it is sent out to a public
119b5fc6018Sjmcmailing list.
120b5fc6018SjmcSensitive, security related issues should be sent via email to
12176c04420Sschwarze.Aq Mt security@OpenBSD.org .
122