diff options
author | Todd C. Miller <millert@cvs.openbsd.org> | 2003-02-28 01:34:30 +0000 |
---|---|---|
committer | Todd C. Miller <millert@cvs.openbsd.org> | 2003-02-28 01:34:30 +0000 |
commit | 3599b200810b964547f74a9dd4e45d31fc6fb33b (patch) | |
tree | 6edb68fe96c5a218bab5a6c725b496a8a85d8173 /gnu/usr.bin/sendbug/sendbug.1 | |
parent | cb61f4ee3661783b6469af1a8ca5098bfe43d584 (diff) |
Convert to mdoc and customize further for OpenBSD
Diffstat (limited to 'gnu/usr.bin/sendbug/sendbug.1')
-rw-r--r-- | gnu/usr.bin/sendbug/sendbug.1 | 214 |
1 files changed, 108 insertions, 106 deletions
diff --git a/gnu/usr.bin/sendbug/sendbug.1 b/gnu/usr.bin/sendbug/sendbug.1 index a03c281d310..c2cd359d418 100644 --- a/gnu/usr.bin/sendbug/sendbug.1 +++ b/gnu/usr.bin/sendbug/sendbug.1 @@ -21,138 +21,140 @@ .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA .\" .\" --------------------------------------------------------------------------- -.nh -.TH SENDBUG 1 3.97 "February 1993" -.SH NAME -.B sendbug -\- send problem report (PR) about OpenBSD to a central support site -.SH SYNOPSIS -.B sendbug -[ -.B \-P -] -[ -.B \-L -] -[ -.B \-V -] -[ -.B \--version -] -.SH DESCRIPTION -.B sendbug +.Dd February 27, 2003 +.Dt SENDBUG 1 +.Sh NAME +.Nm sendbug +.Nd report a bug in OpenBSD +.Sh SYNOPSIS +.Nm sendbug +.Op Fl LPV +.Op Fl -version +.Sh DESCRIPTION +.Nm is a tool used to submit -.I problem reports -.\" SITE ADMINISTRATORS - change this if you use a local default -(PRs) to a central support site. -.B sendbug -invokes an editor on a problem report template (after trying to fill -in some fields with reasonable default values). When you exit the -editor, -.B sendbug +.Em problem reports +(PRs) to the +.Ox +bugs database. +.Nm +invokes an editor on a problem report template (after filling +in some fields with reasonable default values). +When you exit the editor, +.Nm sends the completed form to the -.I Problem Report Management System -(\fBGNATS\fR) at a central support site. At the support site, the PR -is assigned a unique number and is stored in the \fBGNATS\fR database -according to its category and submitter-id. \fBGNATS\fR automatically -replies with an acknowledgement, citing the category and the PR -number. -.LP -To ensure that a PR is handled promptly, it should contain your (unique) -\fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the -problem area. (Use -.B `sendbug -L' +.Ox +bugs database. +The PR will be assigned a unique number and stored in the bugs database +according to its category. +An automatic reply will be sent with an acknowledgement, citing the category +and the PR number. +.Pp +To ensure that a PR is handled promptly, it should specify one of the +available +.Em categories +to identify the problem area. +(Use +.Nm sendbug +.Fl L to see a list of categories.) -.LP +.Pp The more precise your problem description and the more complete your -information, the faster your support team can solve your problems. -.SH OPTIONS -.TP -.B \-P +information, the faster the +.Ox +team will be able to solve your problem. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl L +Print the list of available categories. +No mail is sent. +.It Fl P Print the form specified by the environment variable -.B PR_FORM -on standard output. If -.B PR_FORM -is not set, print the standard blank PR template. No mail is sent. -.TP -.B -L -Print the list of available categories. No mail is sent. -.TP -.B \-V +.Ev PR_FORM +on standard output. +If +.Ev PR_FORM +is not set, print the standard blank PR template. +No mail is sent. +.It Fl V Display the -.B sendbug +.Nm version number. -.TP -.B \--version +.It Fl -version Same as -.B \-V. -.LP +.Fl V . +.El +.Pp Note: Use -.B sendbug -to submit problem reports rather than mailing them directly. Using -both the template and -.B sendbug +.Nm +to submit problem reports rather than mailing them directly. +Using both the template and +.Nm itself will help ensure all necessary information will reach the -support site. -.SH ENVIRONMENT -The environment variable -.B EDITOR -specifies the editor to invoke on the template. -.br -default: -.B vi -.sp -If the environment variable -.B PR_FORM -is set, then its value is used as the file name of the template for -your problem-report editing session. You can use this to start with a -partially completed form (for example, a form with the identification -fields already completed). -.SH "HOW TO FILL OUT A PROBLEM REPORT" +.Ox +bugs database. +.Sh ENVIRONMENT +.Bl -tag -width "/tmp/pbad.XXXXXXX" +.It Ev EDITOR +Specifies the editor to invoke on the template. +The default editor is +.Pa /usr/bin/vi . +.It Ev PR_FORM +Used as the file name of the template for your problem-report editing session. +You can use this to start with a partially completed form (for example, +a form with the identification fields already completed). +.El +.Sh "HOW TO FILL OUT A PROBLEM REPORT" Problem reports have to be in a particular form so that a program can easily manage them. Please remember the following guidelines: -.IP \(bu 3m +.Bl -bullet +.It Describe only -.B one problem -with each problem report. -.IP \(bu 3m +.Em one problem +per problem report. +.It For follow-up mail, use the same subject line as the one in the automatic -acknowledgement. It consists of category, PR number and the original synopsis -line. This allows the support site to relate several mail messages to a +acknowledgement. +It consists of category, PR number and the original synopsis line. +This allows the bugs database to relate several mail messages to a particular PR and to record them automatically. -.IP \(bu 3m +.It Please try to be as accurate as possible in the subject and/or synopsis line. -.IP \(bu 3m -The subject and the synopsis line are not confidential. This is -because open-bugs lists are compiled from them. Avoid confidential -information there. -.SH "HOW TO SUBMIT TEST CASES, CODE, ETC." -Submit small code samples with the PR. Contact the support site for -instructions on submitting larger test cases and problematic source -code. -.SH FILES -.ta \w'/tmp/pbad.XXXXXX 'u -/tmp/p.XXXXXX copy of PR used in editing session -.br -/tmp/pf.XXXXXX copy of empty PR form (testing purposes) -.br -/tmp/pbad.XXXXXX file for rejected PRs -.SH AUTHORS +.It +The contents 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 . +.Sh "HOW TO SUBMIT TEST CASES, CODE, ETC." +Submit small code samples with the PR. +Contact +.Aq bugs@OpenBSD.org +for instructions on submitting larger test cases and problematic source code. +.Sh FILES +.Bl -tag -width "/tmp/pbad.XXXXXXX" -compact +.It Pa /tmp/p.XXXXXX +copy of PR used in editing session +.It Pa /tmp/pf.XXXXXX +copy of empty PR form (testing purposes) +.It Pa /tmp/pbad.XXXXXX +file for rejected PRs +.El +.Sh AUTHORS Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus Support) -.SH COPYING +.Sh COPYING Copyright (c) 1992, 1993 Free Software Foundation, Inc. -.PP +.Pp Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. -.PP +.Pp Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. -.PP +.Pp Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in |