Annotation of src/usr.bin/sendbug/sendbug.1, Revision 1.28
1.28 ! jmc 1: .\" $OpenBSD: sendbug.1,v 1.27 2016/02/18 21:57:26 jmc Exp $
1.1 ray 2: .\"
3: .\" Written by Raymond Lai <ray@cyth.net>.
4: .\" Public domain.
5: .\"
1.28 ! jmc 6: .Dd $Mdocdate: February 18 2016 $
1.1 ray 7: .Dt SENDBUG 1
8: .Os
9: .Sh NAME
10: .Nm sendbug
1.25 schwarze 11: .Nd report a bug in OpenBSD
1.1 ray 12: .Sh SYNOPSIS
13: .Nm
1.26 deraadt 14: .Op Fl DEP
1.1 ray 15: .Sh DESCRIPTION
16: .Nm
1.10 jmc 17: is used to submit problem reports (PRs) to the
18: .Ox
19: bugs database.
1.12 jmc 20: A template PR is opened in a text editor
1.18 ray 21: with some system information already filled in,
1.12 jmc 22: such as machine architecture,
1.18 ray 23: .Xr dmesg 8 ,
1.20 sthen 24: .Xr usbdevs 8 ,
1.18 ray 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
1.28 ! jmc 37: .Sq <>
1.12 jmc 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: Any follow up mail to the PR
51: should keep the same mail subject.
1.10 jmc 52: .Pp
1.22 jmc 53: The status of bug reports can be followed by checking the
54: .Mt bugs@openbsd.org
55: mailing list archive available at
1.24 bcallah 56: .Lk http://marc.info/?l=openbsd-bugs .
1.2 deraadt 57: .Pp
58: The options are as follows:
59: .Bl -tag -width Ds
1.13 ray 60: .It Fl D
1.18 ray 61: Do not attach
62: .Xr dmesg 8 ,
1.20 sthen 63: .Xr usbdevs 8 ,
1.18 ray 64: .Xr pcidump 8 ,
65: and
66: .Xr acpidump 8
1.19 jmc 67: output to the report.
1.18 ray 68: This information is very helpful in reports,
1.13 ray 69: but may contain sensitive information about the sender.
70: This flag helps protect users' privacy in those cases.
1.18 ray 71: .It Fl E
72: The
73: .Xr acpidump 8
74: output includes base64 encoded files.
75: This flag causes
76: .Nm
77: to read a PR from the standard input, decode the files,
78: and write them into the current directory.
1.2 deraadt 79: .It Fl P
1.6 ray 80: Generate and print the template with system information filled out.
1.2 deraadt 81: .El
1.1 ray 82: .Sh ENVIRONMENT
83: .Bl -tag -width Ds
1.9 ray 84: .It Ev EDITOR , VISUAL
1.1 ray 85: Specifies an editor to use.
1.9 ray 86: If both
1.1 ray 87: .Ev EDITOR
1.9 ray 88: and
89: .Ev VISUAL
90: are set,
91: .Ev VISUAL
92: takes precedence.
93: If neither
94: .Ev EDITOR
95: nor
96: .Ev VISUAL
97: are set,
1.1 ray 98: the default is
99: .Xr vi 1 .
1.4 ray 100: .It Ev PR_FORM
101: Filename of PR form to use instead of using the built-in form.
102: Such a PR form can be partially pre-completed to make the
103: process faster.
1.1 ray 104: .El
1.7 ray 105: .Sh FILES
106: .Bl -tag -width "/tmp/p.XXXXXXXXXX" -compact
107: .It Pa /tmp/p.XXXXXXXXXX
108: temporary PR report
1.8 jmc 109: .El
1.11 jmc 110: .Sh SEE ALSO
1.14 jmc 111: .Xr crash 8 ,
1.19 jmc 112: .Xr dmesg 8
1.1 ray 113: .Sh AUTHORS
114: .Nm
115: was written from scratch for the public domain by
1.23 schwarze 116: .An Ray Lai Aq Mt ray@cyth.net .
1.12 jmc 117: .Sh CAVEATS
118: The content of the PR is not confidential; it is sent out to a public
119: mailing list.
120: Sensitive, security related issues should be sent via email to
1.23 schwarze 121: .Aq Mt 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