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