Expand PMF_FN_* macros.

[netbsd-mini2440.git] / gnu / usr.bin / send-pr / send-pr.man

.\" -*- nroff -*-
.\" ---------------------------------------------------------------------------
.\"    man page for send-pr (by Heinz G. Seidl, hgs@cygnus.com)
.\"    updated Feb 1993 for GNATS 3.00 by Jeffrey Osier, jeffrey@cygnus.com
.\"
.\"    This file is part of the Problem Report Management System (GNATS)
.\"    Copyright 1992 Cygnus Support
.\"
.\"    This program is free software; you can redistribute it and/or
.\"    modify it under the terms of the GNU General Public
.\"    License as published by the Free Software Foundation; either
.\"    version 2 of the License, or (at your option) any later version.
.\"
.\"    This program is distributed in the hope that it will be useful,
.\"    but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\"    General Public License for more details.
.\"
.\"    You should have received a copy of the GNU Library General Public
.\"    License along with this program; if not, write to the Free
.\"    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
.\"
.\" ---------------------------------------------------------------------------
.nh
.TH SEND-PR 1 xVERSIONx "February 1993"
.SH NAME
send-pr \- send problem report (PR) to a central support site
.SH SYNOPSIS
.B send-pr
[
.I site
]
[
.B \-f
.I problem-report
]
[
.B \-t
.I mail-address
]
.br
.in +0.8i
[
.B \-P
]
[
.B \-L
]
[
.B \-\-request-id
]
[
.B \-V
]
.SH DESCRIPTION
.B send-pr
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.  In most cases the correct 
.I site
will be the default.  This argument indicates the support site which
is responsible for the category of problem involved.  Some sites may
use a local address as a default.  
.I site
values are defined by using the 
.BR aliases (5).
.LP
.B send-pr
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 send-pr 
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 `send-pr -L'
to see a list of categories).
The PR should also contain a subject header, which is separate to the
synopsis line.
NetBSD does not use unique \fIsubmitter-id\fR's - all PR's use the
default value of
.B `net'
for this field.
.\" .LP
.\" The
.\" .B send-pr
.\" template at your site should already be customized with your
.\" submitter-id (running `\|\fBinstall-sid\fP \fIsubmitter-id\fP\|' to
.\" accomplish this is part of the installation procedures for
.\" .BR send-pr ).
.\" If this hasn't been done, see your system administrator for your
.\" submitter-id, or request one from your support site by invoking
.\" .B `send-pr \-\-request\-id'.
.\" If your site does not distinguish between different user sites, or if
.\" you are not affiliated with the support site, use
.\" .B `net'
.\" for this field.
.LP
The more precise your problem description and the more complete your
information, the faster your support team can solve your problems.
.SH OPTIONS
.TP
.BI \-f " problem-report"
specify a file (\fIproblem-report\fR) which already contains a
complete problem report.
.B send-pr
sends the contents of the file without invoking the editor.  If 
the value for 
.I problem-report
is
.BR `\|\-\|' ,
then
.B send-pr
reads from standard input.
.TP
.BI \-t " mail-address"
Change mail address at the support site for problem reports.  The
default 
.I mail-address
is the address used for the default 
.IR site .  
Use the
.I site
argument rather than this option in nearly all cases.
.TP
.B \-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 \-\-request\-id
sends mail to the default support site, or
.I site
if specified, with a request for your 
.IR submitter-id . 
If you are
not affiliated with 
.IR site ,
use a
.I submitter-id
of
.BR net \|'.
.TP
.B \-V
Display the 
.B send-pr
version number.
.LP
Note: use
.B send-pr
to submit problem reports rather than mailing them directly.  Using
both the template and
.B send-pr
itself will help ensure all necessary information will reach the
support site.
.SH ENVIRONMENT
.TP
.SM GNATS_ROOT
If the file $GNATS_ROOT/gnats-adm/config exists then it is used
to provide newer configuration information.  The default value
is the empty string.
.TP
.SM LOGNAME
Sets the default for the From and Reply-To fields of the problem report.
Defaults to $USER if not set.
.TP
.SM NAME
Sets the default for the Originator field of the problem report.
If not set, then the file $HOME/.fullname is used.  If 
$HOME/.fullname is not present, then an attempt is made to query
the password file for a full name.
.TP
.SM ORGANIZATION
The name of a file which contains the default for the Organization field
of the problem report.
.TP
.SM PR_FORM
If this 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).
.TP
.SM REPLYTO
Sets the default for the Reply-To field of the problem report.  If not
set, then it defaults to $LOGNAME.
.TP
.SM TMPDIR
Specifies the temporary directory used for creating the problem report.
This directory must exist with write permissions.  Defaults to /tmp if
not specified.
.TP
.SM USER_GNATS_SITE
Used to set the default site you are reporting bugs to.  Defaults to
netbsd if not specified.
.TP
.SM VISUAL
Specifies the editor to invoke on the template.  If not set, then the
variable EDITOR is used.  If neither VISUAL nor EDITOR are
set, then
.BR vi (1)
is used.
.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 
describe only 
.B one problem
with each problem report.
.IP \(bu 3m
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
particular PR and to record them automatically.
.IP \(bu 3m 
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.
.LP
The
.B severity
field is to indicate the severity of the problem.
The accepted values are:
.IP \fBcritical\fR
The product, component or concept is completely non-operational or some
essential functionality is missing (e.g. kernel panic or program core dumps).
No workaround is known.
.IP \fBserious\fR
The product, component or concept is not working properly or significant
functionality is missing.
Problems that would otherwise be considered
.B critical
are rated
.B serious
when a workaround is known.
.IP \fBnon-critical\fR
The product, component or concept is working in general, but lacks
features, has irritating behavior, does something wrong, or doesn't
match its documentation.
.LP
The default value is 
.B serious.
.LP
The
.B priority
field specifies
how soon the problem report submitter requires a solution.
The accepted values are:
.IP \fBhigh\fR
A solution is needed as soon as possible.
.IP \fBmedium\fR
The problem should be solved in the next release.
.IP \fBlow\fR
The problem should be solved in a future release.
.LP
The default value is 
.B medium.
.LP
The
.B class
of a problem report can be one of the following:
.IP \fBsw-bug\fR
A general software problem (
.I `sw'
stands for
.I "software"
).
.IP \fBdoc-bug\fR
A problem with the manual pages or other documentation.
.IP \fBchange-request\fR
A request for a change from existing behavior that is not a bug
("It's nice, but it would be better if ...").
.IP \fBsupport\fR
A support problem or question.
.LP
The default value is
.B sw-bug.
.LP
See the GNU 
.B Info 
file
.B send-pr.info
or the document \fIReporting Problems With send-pr\fR\ for detailed
information on reporting problems
.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
.SM /tmp/p$$
copy of PR used in editing session
.TP
.SM /tmp/pf$$
copy of empty PR form, for testing purposes
.TP
.SM /tmp/pbad$$
file for rejected PRs
.TP
.SM $HOME/.fullname
Contains the default for the Originator field of the problem 
report if $NAME is not set
.TP
.SM $HOME/.organization
Contains the default for the Organization field of the problem
report if $ORGANIZATION is not set.
.TP
.SM $HOME/.signature
Contains the default for the Organization field of the problem
report if $ORGANIZATION is not set and $HOME/.organization does
not exist.
.SH EMACS USER INTERFACE
An Emacs user interface for 
.B send-pr
with completion of field values is part of the 
.B send-pr
distribution (invoked with
.BR "M-x send-pr" ).
See the file
.B send-pr.info
or the ASCII file
.B INSTALL
in the top level directory of the distribution for configuration and
installation information.  The Emacs LISP template file is 
.B send-pr-el.in
and is installed as
.BR send-pr.el .
.SH WEB INTERFACE
An interface to sending PR's is available on the NetBSD website at
http://www.NetBSD.org/Gnats/.
.SH INSTALLATION AND CONFIGURATION
See 
.B send-pr.info
or
.B INSTALL
for installation instructions.
.SH SEE ALSO
.I Reporting Problems Using send-pr
(also installed as the GNU Info file
.BR send-pr.info ).
.\" .LP
.\" .BR gnats (l),
.\" .BR query-pr (1),
.\" .BR edit-pr (1),
.\" .BR gnats (8),
.\" .BR queue-pr (8),
.\" .BR at-pr (8),
.\" .BR mkcat (8),
.\" .BR mkdist (8).
.SH AUTHORS
Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
Support)
.SH COPYING
Copyright (c) 1992, 1993 Free Software Foundation, Inc.
.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
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
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
translations approved by the Free Software Foundation instead of in
the original English.