Annotation of src/usr.bin/sendbug/sendbug.1, Revision 1.16
1.16 ! jmc 1: .\" $OpenBSD: sendbug.1,v 1.15 2007/04/13 20:39:09 jmc Exp $
1.1 ray 2: .\"
3: .\" Written by Raymond Lai <ray@cyth.net>.
4: .\" Public domain.
5: .\"
1.16 ! jmc 6: .Dd $Mdocdate$
1.1 ray 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
1.13 ray 15: .Op Fl DLPV
1.1 ray 16: .Sh DESCRIPTION
17: .Nm
1.10 jmc 18: is used to submit problem reports (PRs) to the
19: .Ox
20: bugs database.
1.12 jmc 21: A template PR is opened in a text editor
22: with some system information,
23: such as machine architecture,
1.15 jmc 24: already filled in,
25: and a
26: .Xr dmesg 8
27: attached.
1.12 jmc 28: Fields enclosed in
29: .Sq \*(Lt\*(Gt
30: should be completed by the user.
1.1 ray 31: .Pp
1.12 jmc 32: Once the PR is filled out,
33: the user exits the editor and is presented with a choice:
34: a)bort, e)dit, or s)end.
35: If abort is selected,
1.6 ray 36: the report is not deleted and the pathname of the report is printed.
1.12 jmc 37: If edit is selected,
38: the user is given a chance to re-edit the report.
39: .Pp
40: If send is selected,
41: the report is mailed to the bugs database,
42: with a Cc to the author.
43: An auto-generated reply will be sent
44: confirming the mail has been received.
45: Any follow up mail to the PR
46: should keep the same mail subject.
1.10 jmc 47: .Pp
1.12 jmc 48: The bugs database can be queried using the online bug tracking system
49: available at
50: .Pa http://www.openbsd.org/query-pr.html .
51: This allows users to search for PRs based on either PR number
52: or content.
1.2 deraadt 53: .Pp
54: The options are as follows:
55: .Bl -tag -width Ds
1.13 ray 56: .It Fl D
1.15 jmc 57: Do not attach a
1.13 ray 58: .Xr dmesg 8
59: to report.
60: The
61: .Xr dmesg 8
62: output is very helpful in reports,
63: but may contain sensitive information about the sender.
64: This flag helps protect users' privacy in those cases.
1.2 deraadt 65: .It Fl L
1.6 ray 66: Print the list of available categories.
1.2 deraadt 67: .It Fl P
1.6 ray 68: Generate and print the template with system information filled out.
1.2 deraadt 69: .It Fl V
1.6 ray 70: Print the version number.
1.2 deraadt 71: .El
1.1 ray 72: .Sh ENVIRONMENT
73: .Bl -tag -width Ds
1.9 ray 74: .It Ev EDITOR , VISUAL
1.1 ray 75: Specifies an editor to use.
1.9 ray 76: If both
1.1 ray 77: .Ev EDITOR
1.9 ray 78: and
79: .Ev VISUAL
80: are set,
81: .Ev VISUAL
82: takes precedence.
83: If neither
84: .Ev EDITOR
85: nor
86: .Ev VISUAL
87: are set,
1.1 ray 88: the default is
89: .Xr vi 1 .
1.4 ray 90: .It Ev PR_FORM
91: Filename of PR form to use instead of using the built-in form.
92: Such a PR form can be partially pre-completed to make the
93: process faster.
1.1 ray 94: .It Ev TMPDIR
95: Specifies a directory for temporary files to be created.
96: The default is
97: .Pa /tmp .
98: .El
1.7 ray 99: .Sh FILES
100: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
101: .It Pa /tmp/p.XXXXXXXXXX
102: temporary PR report
1.8 jmc 103: .El
1.11 jmc 104: .Sh SEE ALSO
1.14 jmc 105: .Xr crash 8 ,
106: .Xr dmesg 8
1.1 ray 107: .Sh AUTHORS
108: .Nm
109: was written from scratch for the public domain by
110: .An Ray Lai Aq ray@cyth.net .
1.12 jmc 111: .Sh CAVEATS
112: The content of the PR is not confidential; it is sent out to a public
113: mailing list.
114: Sensitive, security related issues should be sent via email to
115: .Aq security@OpenBSD.org .