Changes to gnats/send-pr/send-pr.man

[Yngve Svendsen]

Index: gnats/send-pr/send-pr.man
diff -c gnats/send-pr/send-pr.man:1.2 gnats/send-pr/send-pr.man:1.3
*** gnats/send-pr/send-pr.man:1.2       Sun Nov  3 06:58:41 2002
--- gnats/send-pr/send-pr.man   Sun Nov  3 17:35:36 2002
***************
*** 22,175 ****
  .\"
  .\" 
---------------------------------------------------------------------------
  .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 \-s
! .I severity
! ]
! .br
! [
! .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.)
! .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 \-s " severity"
! Give the problem report the severity
! .IR severity .
! .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
  The environment variable 
  .B EDITOR
--- 22,108 ----
  .\"
  .\" 
---------------------------------------------------------------------------
  .nh
! .TH SEND-PR 1 xVERSIONx "November 2002"
  .SH NAME
! send-pr \- submit a GNATS Problem Report (PR) to a support site
  .SH SYNOPSIS
  .B send-pr
! .RS
! [\ \fB\-\-batch\ \fR|\fB\ \-b\fR\ ]
! .br
! [\ \fB\-\-database\fR\=\fIdatabase\fR\ |\ \fB\-d\fR\ \fIdatabase\fR\ ]
! .br
! [\ \fB\-\-file\fR\=\fIfile\fR\ |\ \fB\-f\fR\ \fIfile\fR\ ]
! .br
! [\ \fB\-\-print\fR\ |\ \fB\-p\fR\ ]
! .br
! [\ \fB\-\-request-id\fR\ ]
! .br
! [\ \fB\-\-severity\fR\=\fIseverity\fR\ |\ \fB\-s\fR\ \fIseverity\fR\ ]
! .br
! [\ \fB\-\-help\fR\ |\ \fB\-h\fR\ ]
! [\ \fB\-\-version\fR\ |\ \fB\-V\fR\ ]
! .ad b
! .hy 1
  .SH DESCRIPTION
! 
! \fBsend-pr\fR invokes an editor on a problem report template (after
! trying to fill in some fields with reasonable default values).  When
! you exit the editor, \fBsend-pr\fR submits the completed form to the
! GNATS system at a central support site, either directly over the
! network to the GNATS server or by e-mail.  At the support site, the PR
! is assigned a unique number and is stored in the GNATS database
! according to its category and submitter-id.  GNATS 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.
  .LP
  The more precise your problem description and the more complete your
  information, the faster your support team can solve your problems.
+ .LP
+ Note: use \fBsend-pr\fR to submit problem reports rather than mailing
+ them directly.  Using both the template and \fBsend-pr\fR itself will
+ help ensure that all necessary information will reach the support site.
  .SH OPTIONS
  .TP
! \fB\-b\fR,\ \fB\-\-batch
! Suppresses printing of most of the messages that \fBsend-pr\fR usually
! prints while running.
! .TP
! \fB\-d \fIdatabase\fR,\ \fB\-\-database=\fIdatabase\fR 
! Specifies the database to which the PR is to be submitted; if no
! database is specified, the local database named \fBdefault\fR is
! assumed.  This option overrides the database specified in the
! \fBGNATSDB\fR environment variable.
! .TP
! \fB\-f\ \fIfile\fR,\ \fB\-\-file=\fIfile\fR
! Specifies a file where a completed Problem Report or a PR template
! exists.  \fBsend-pr\fR verifies that the contents of the file
! constitute a valid PR and asks the user whether the PR should be
! submitted directly or edited first.  If the PR text is invalid, the
! user will be notified and given the option to edit it.  If \fIfile\fR
! is set to `-', \fBsend-pr\fR reads from standard input.
! .TP
! \fB\-p\fR,\ \fB\-\-print
! Displays the PR template for the specified \fBdatabase\fR, or if the
! \fB-d\fR or \fB--database\fR options are not specified, print the
! template for the local database \fBdefault\fR.  No PR is submitted
! when this option is used.
! .TP
! \fB\-\-request-id\fR
! Sends a request for a Submitter Id to the support site.
  .TP
! \fB\-s\ \fIseverity\fR,\ \fB\-\-severity=\fIseverity\fR
! Sets the initial value of the \fBSeverity\fR field to \fIseverity\fR.
  .TP
! \fB\-\-version\fR,\ \fB\-V\fR
! Displays the version number of the program.
! .TP
! \fB\-\-help\fR,\ \fB\-h\fR
! Prints a brief usage message.
  .SH ENVIRONMENT
  The environment variable 
  .B EDITOR
***************
*** 177,189 ****
  .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"
  Problem reports have to be in a particular form so that a program can
  easily manage them.  Please remember the following guidelines:
--- 110,115 ----
***************
*** 206,219 ****
  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
  .ta \w'/tmp/pbad$$  'u
  /tmp/p$$      copy of PR used in editing session
  .br
--- 132,143 ----
  See the GNU 
  .B Info 
  file
! .B gnats.info
! or the document \fIKeeping Track: Managing Messages With GNATS\fR\ for 
detailed
! information on reporting problems.
  .SH FILES
+ xPREFIXx/etc/gnats/send-pr.conf  The \fBsend-pr\fR configuration file
+ .br
  .ta \w'/tmp/pbad$$  'u
  /tmp/p$$      copy of PR used in editing session
  .br
***************
*** 228,265 ****
  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 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
--- 152,191 ----
  distribution (invoked with
  .BR "M-x send-pr" ).
  See the file
! .B gnats.info
! in the doc subdirectory of the distribution for configuration,
! installation and usage information, or see
! .I Keeping Track: Managing Messages With GNATS
  .SH INSTALLATION AND CONFIGURATION
  See 
! .B gnats.info
  or
  .B INSTALL
  for installation instructions.
! .SH "SEE ALSO"
! .I Keeping Track: Managing Messages With GNATS
  (also installed as the GNU Info file
! .BR gnats.info )
  .LP
! .BR databases (5),
! .BR dbconfig (5),
! .BR delete-pr (8),
! .BR edit-pr (1)
! .BR file-pr (8),
! .BR gen-index (8),
! .BR gnats (7),
! .BR gnatsd (8),
! .BR mkcat (8),
! .BR mkdb (8),
! .BR pr-edit (8),
  .BR query-pr (1),
  .BR queue-pr (8),
! .BR send-pr (1).
  .SH AUTHORS
  Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
! Support), Yngve Svendsen.
  .SH COPYING
! Copyright (c) 1992, 1993, 2002, 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