/[gnats]/gnats/send-pr/send-pr.man
ViewVC logotype

Diff of /gnats/send-pr/send-pr.man

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2 by yngves, Sun Nov 3 11:58:41 2002 UTC revision 1.3 by yngves, Sun Nov 3 22:35:36 2002 UTC
# Line 22  Line 22 
22  .\"  .\"
23  .\" ---------------------------------------------------------------------------  .\" ---------------------------------------------------------------------------
24  .nh  .nh
25  .TH SEND-PR 1 xVERSIONx "February 1993"  .TH SEND-PR 1 xVERSIONx "November 2002"
26  .SH NAME  .SH NAME
27  send-pr \- send problem report (PR) to a central support site  send-pr \- submit a GNATS Problem Report (PR) to a support site
28  .SH SYNOPSIS  .SH SYNOPSIS
29  .B send-pr  .B send-pr
30  [  .RS
31  .I site  [\ \fB\-\-batch\ \fR|\fB\ \-b\fR\ ]
32  ]  .br
33  [  [\ \fB\-\-database\fR\=\fIdatabase\fR\ |\ \fB\-d\fR\ \fIdatabase\fR\ ]
34  .B \-f  .br
35  .I problem-report  [\ \fB\-\-file\fR\=\fIfile\fR\ |\ \fB\-f\fR\ \fIfile\fR\ ]
36  ]  .br
37  [  [\ \fB\-\-print\fR\ |\ \fB\-p\fR\ ]
38  .B \-t  .br
39  .I mail-address  [\ \fB\-\-request-id\fR\ ]
40  ]  .br
41  .br  [\ \fB\-\-severity\fR\=\fIseverity\fR\ |\ \fB\-s\fR\ \fIseverity\fR\ ]
42  .in +0.8i  .br
43  [  [\ \fB\-\-help\fR\ |\ \fB\-h\fR\ ]
44  .B \-P  [\ \fB\-\-version\fR\ |\ \fB\-V\fR\ ]
45  ]  .ad b
46  [  .hy 1
 .B \-L  
 ]  
 [  
 .B \-s  
 .I severity  
 ]  
 .br  
 [  
 .B \-\-request-id  
 ]  
 [  
 .B \-V  
 ]  
47  .SH DESCRIPTION  .SH DESCRIPTION
48  .B send-pr  
49  is a tool used to submit  \fBsend-pr\fR invokes an editor on a problem report template (after
50  .I problem reports  trying to fill in some fields with reasonable default values).  When
51  .\" SITE ADMINISTRATORS - change this if you use a local default  you exit the editor, \fBsend-pr\fR submits the completed form to the
52  (PRs) to a central support site.  In most cases the correct  GNATS system at a central support site, either directly over the
53  .I site  network to the GNATS server or by e-mail.  At the support site, the PR
54  will be the default.  This argument indicates the support site which  is assigned a unique number and is stored in the GNATS database
55  is responsible for the category of problem involved.  Some sites may  according to its category and submitter-id.  GNATS automatically
 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  
56  replies with an acknowledgement, citing the category and the PR  replies with an acknowledgement, citing the category and the PR
57  number.  number.
58  .LP  .LP
59  To ensure that a PR is handled promptly, it should contain your (unique)  To ensure that a PR is handled promptly, it should contain your (unique)
60  \fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the  \fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the
61  problem area.  (Use  problem area.
 .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.  
62  .LP  .LP
63  The more precise your problem description and the more complete your  The more precise your problem description and the more complete your
64  information, the faster your support team can solve your problems.  information, the faster your support team can solve your problems.
65    .LP
66    Note: use \fBsend-pr\fR to submit problem reports rather than mailing
67    them directly.  Using both the template and \fBsend-pr\fR itself will
68    help ensure that all necessary information will reach the support site.
69  .SH OPTIONS  .SH OPTIONS
70  .TP  .TP
71  .BI \-f " problem-report"  \fB\-b\fR,\ \fB\-\-batch
72  specify a file (\fIproblem-report\fR) which already contains a  Suppresses printing of most of the messages that \fBsend-pr\fR usually
73  complete problem report.  prints while running.
74  .B send-pr  .TP
75  sends the contents of the file without invoking the editor.  If  \fB\-d \fIdatabase\fR,\ \fB\-\-database=\fIdatabase\fR
76  the value for  Specifies the database to which the PR is to be submitted; if no
77  .I problem-report  database is specified, the local database named \fBdefault\fR is
78  is  assumed.  This option overrides the database specified in the
79  .BR `\|\-\|' ,  \fBGNATSDB\fR environment variable.
80  then  .TP
81  .B send-pr  \fB\-f\ \fIfile\fR,\ \fB\-\-file=\fIfile\fR
82  reads from standard input.  Specifies a file where a completed Problem Report or a PR template
83    exists.  \fBsend-pr\fR verifies that the contents of the file
84    constitute a valid PR and asks the user whether the PR should be
85    submitted directly or edited first.  If the PR text is invalid, the
86    user will be notified and given the option to edit it.  If \fIfile\fR
87    is set to `-', \fBsend-pr\fR reads from standard input.
88    .TP
89    \fB\-p\fR,\ \fB\-\-print
90    Displays the PR template for the specified \fBdatabase\fR, or if the
91    \fB-d\fR or \fB--database\fR options are not specified, print the
92    template for the local database \fBdefault\fR.  No PR is submitted
93    when this option is used.
94    .TP
95    \fB\-\-request-id\fR
96    Sends a request for a Submitter Id to the support site.
97  .TP  .TP
98  .BI \-s " severity"  \fB\-s\ \fIseverity\fR,\ \fB\-\-severity=\fIseverity\fR
99  Give the problem report the severity  Sets the initial value of the \fBSeverity\fR field to \fIseverity\fR.
 .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 \|'.  
100  .TP  .TP
101  .B \-V  \fB\-\-version\fR,\ \fB\-V\fR
102  Display the  Displays the version number of the program.
103  .B send-pr  .TP
104  version number.  \fB\-\-help\fR,\ \fB\-h\fR
105  .LP  Prints a brief usage message.
 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.  
106  .SH ENVIRONMENT  .SH ENVIRONMENT
107  The environment variable  The environment variable
108  .B EDITOR  .B EDITOR
# Line 177  specifies the editor to invoke on the te Line 110  specifies the editor to invoke on the te
110  .br  .br
111  default:  default:
112  .B vi  .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).  
113  .SH "HOW TO FILL OUT A PROBLEM REPORT"  .SH "HOW TO FILL OUT A PROBLEM REPORT"
114  Problem reports have to be in a particular form so that a program can  Problem reports have to be in a particular form so that a program can
115  easily manage them.  Please remember the following guidelines:  easily manage them.  Please remember the following guidelines:
# Line 206  information there. Line 132  information there.
132  See the GNU  See the GNU
133  .B Info  .B Info
134  file  file
135  .B send-pr.info  .B gnats.info
136  or the document \fIReporting Problems With send-pr\fR\ for detailed  or the document \fIKeeping Track: Managing Messages With GNATS\fR\ for detailed
137  information on reporting problems  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.  
138  .SH FILES  .SH FILES
139    xPREFIXx/etc/gnats/send-pr.conf  The \fBsend-pr\fR configuration file
140    .br
141  .ta \w'/tmp/pbad$$  'u  .ta \w'/tmp/pbad$$  'u
142  /tmp/p$$        copy of PR used in editing session  /tmp/p$$        copy of PR used in editing session
143  .br  .br
# Line 228  with completion of field values is part Line 152  with completion of field values is part
152  distribution (invoked with  distribution (invoked with
153  .BR "M-x send-pr" ).  .BR "M-x send-pr" ).
154  See the file  See the file
155  .B send-pr.info  .B gnats.info
156  or the ASCII file  in the doc subdirectory of the distribution for configuration,
157  .B INSTALL  installation and usage information, or see
158  in the top level directory of the distribution for configuration and  .I Keeping Track: Managing Messages With GNATS
 installation information.  The Emacs LISP template file is  
 .B send-pr-el.in  
 and is installed as  
 .BR send-pr.el .  
159  .SH INSTALLATION AND CONFIGURATION  .SH INSTALLATION AND CONFIGURATION
160  See  See
161  .B send-pr.info  .B gnats.info
162  or  or
163  .B INSTALL  .B INSTALL
164  for installation instructions.  for installation instructions.
165  .SH SEE ALSO  .SH "SEE ALSO"
166  .I Reporting Problems Using send-pr  .I Keeping Track: Managing Messages With GNATS
167  (also installed as the GNU Info file  (also installed as the GNU Info file
168  .BR send-pr.info ).  .BR gnats.info )
169  .LP  .LP
170  .BR gnats (l),  .BR databases (5),
171    .BR dbconfig (5),
172    .BR delete-pr (8),
173    .BR edit-pr (1)
174    .BR file-pr (8),
175    .BR gen-index (8),
176    .BR gnats (7),
177    .BR gnatsd (8),
178    .BR mkcat (8),
179    .BR mkdb (8),
180    .BR pr-edit (8),
181  .BR query-pr (1),  .BR query-pr (1),
 .BR edit-pr (1),  
 .BR gnats (8),  
182  .BR queue-pr (8),  .BR queue-pr (8),
183  .BR at-pr (8),  .BR send-pr (1).
 .BR mkcat (8),  
 .BR mkdist (8).  
184  .SH AUTHORS  .SH AUTHORS
185  Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus  Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
186  Support)  Support), Yngve Svendsen.
187  .SH COPYING  .SH COPYING
188  Copyright (c) 1992, 1993 Free Software Foundation, Inc.  Copyright (c) 1992, 1993, 2002, Free Software Foundation, Inc.
189  .PP  .PP
190  Permission is granted to make and distribute verbatim copies of  Permission is granted to make and distribute verbatim copies of
191  this manual provided the copyright notice and this permission notice  this manual provided the copyright notice and this permission notice

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26