diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
| commit | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch) | |
| tree | 9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man1/sendbug.1 | |
| parent | 160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff) | |
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man1/sendbug.1')
| -rw-r--r-- | static/openbsd/man1/sendbug.1 | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/static/openbsd/man1/sendbug.1 b/static/openbsd/man1/sendbug.1 new file mode 100644 index 00000000..f4ed15b2 --- /dev/null +++ b/static/openbsd/man1/sendbug.1 @@ -0,0 +1,121 @@ +.\" $OpenBSD: sendbug.1,v 1.29 2022/02/18 10:24:32 jsg Exp $ +.\" +.\" Written by Raymond Lai <ray@cyth.net>. +.\" Public domain. +.\" +.Dd $Mdocdate: February 18 2022 $ +.Dt SENDBUG 1 +.Os +.Sh NAME +.Nm sendbug +.Nd report a bug in OpenBSD +.Sh SYNOPSIS +.Nm +.Op Fl DEP +.Sh DESCRIPTION +.Nm +is used to submit problem reports (PRs) to the +.Ox +bugs database. +A template PR is opened in a text editor +with some system information already filled in, +such as machine architecture, +.Xr dmesg 8 , +.Xr usbdevs 8 , +.Xr pcidump 8 , +and +.Xr acpidump 8 . +The +.Xr pcidump 8 +and +.Xr acpidump 8 +output are important for ACPI development and can only be included if +.Nm +is run as root. +.Pp +Fields enclosed in +.Sq <> +should be completed by the user. +Once the PR is filled out, +the user exits the editor and is presented with a choice: +a)bort, e)dit, or s)end. +If abort is selected, +the report is not deleted and the pathname of the report is printed. +If edit is selected, +the user is given a chance to re-edit the report. +.Pp +If send is selected, +the report is mailed to the bugs database, +with a Cc to the author. +Any follow up mail to the PR +should keep the same mail subject. +.Pp +The status of bug reports can be followed by checking the +.Mt bugs@openbsd.org +mailing list archive available at +.Lk https://marc.info/?l=openbsd-bugs . +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl D +Do not attach +.Xr dmesg 8 , +.Xr usbdevs 8 , +.Xr pcidump 8 , +and +.Xr acpidump 8 +output to the report. +This information is very helpful in reports, +but may contain sensitive information about the sender. +This flag helps protect users' privacy in those cases. +.It Fl E +The +.Xr acpidump 8 +output includes base64 encoded files. +This flag causes +.Nm +to read a PR from the standard input, decode the files, +and write them into the current directory. +.It Fl P +Generate and print the template with system information filled out. +.El +.Sh ENVIRONMENT +.Bl -tag -width Ds +.It Ev EDITOR , VISUAL +Specifies an editor to use. +If both +.Ev EDITOR +and +.Ev VISUAL +are set, +.Ev VISUAL +takes precedence. +If neither +.Ev EDITOR +nor +.Ev VISUAL +are set, +the default is +.Xr vi 1 . +.It Ev PR_FORM +Filename of PR form to use instead of using the built-in form. +Such a PR form can be partially pre-completed to make the +process faster. +.El +.Sh FILES +.Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact +.It Pa /tmp/p.XXXXXXXXXX +temporary PR report +.El +.Sh SEE ALSO +.Xr crash 8 , +.Xr dmesg 8 +.Sh AUTHORS +.Nm +was written from scratch for the public domain by +.An Ray Lai Aq Mt ray@cyth.net . +.Sh CAVEATS +The content of the PR is not confidential; it is sent out to a public +mailing list. +Sensitive, security related issues should be sent via email to +.Aq Mt security@OpenBSD.org . |
