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