OpenBSD-4.6/usr.bin/sendbug/sendbug.1

.\" $OpenBSD: sendbug.1,v 1.19 2009/06/10 06:46:53 jmc Exp $
.\"
.\" Written by Raymond Lai <ray@cyth.net>.
.\" Public domain.
.\"
.Dd $Mdocdate: June 10 2009 $
.Dt SENDBUG 1
.Os
.Sh NAME
.Nm sendbug
.Nd report a bug in
.Ox
.Sh SYNOPSIS
.Nm
.Op Fl DEPV
.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 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 \*(Lt\*(Gt
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.
An auto-generated reply will be sent
confirming the mail has been received.
Any follow up mail to the PR
should keep the same mail subject.
.Pp
The bugs database can be queried using the online bug tracking system
available at
.Pa http://www.openbsd.org/query-pr.html .
This allows users to search for PRs based on either PR number
or content.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl D
Do not attach
.Xr dmesg 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.
.It Fl V
Print the version number.
.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.
.It Ev TMPDIR
Specifies a directory for temporary files to be created.
The default is
.Pa /tmp .
.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 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 security@OpenBSD.org .