2 .\" ---------------------------------------------------------------------------
3 .\" man page for send-pr (by Heinz G. Seidl, hgs@cygnus.com)
4 .\" updated Feb 1993 for GNATS 3.00 by Jeffrey Osier, jeffrey@cygnus.com
6 .\" This file is part of the Problem Report Management System (GNATS)
7 .\" Copyright 1992 Cygnus Support
9 .\" This program is free software; you can redistribute it and/or
10 .\" modify it under the terms of the GNU General Public
11 .\" License as published by the Free Software Foundation; either
12 .\" version 2 of the License, or (at your option) any later version.
14 .\" This program is distributed in the hope that it will be useful,
15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 .\" General Public License for more details.
19 .\" You should have received a copy of the GNU Library General Public
20 .\" License along with this program; if not, write to the Free
21 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
23 .\" ---------------------------------------------------------------------------
25 .TH SEND-PR 1 xVERSIONx "February 1993"
27 ipsec send-pr \- send problem report (PR) to a central support site
66 is a tool used to submit
68 .\" SITE ADMINISTRATORS - change this if you use a local default
69 (PRs) to a central support site. In most cases the correct
71 will be the default. This argument indicates the support site which
72 is responsible for the category of problem involved. Some sites may
73 use a local address as a default.
75 values are defined by using the
79 invokes an editor on a problem report template (after trying to fill
80 in some fields with reasonable default values). When you exit the
83 sends the completed form to the
84 .I Problem Report Management System
85 (\fBGNATS\fR) at a central support site. At the support site, the PR
86 is assigned a unique number and is stored in the \fBGNATS\fR database
87 according to its category and submitter-id. \fBGNATS\fR automatically
88 replies with an acknowledgement, citing the category and the PR
91 To ensure that a PR is handled promptly, it should contain your (unique)
92 \fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the
95 to see a list of categories.)
99 template at your site should already be customized with your
100 submitter-id (running `\|\fBinstall-sid\fP \fIsubmitter-id\fP\|' to
101 accomplish this is part of the installation procedures for
103 If this hasn't been done, see your system administrator for your
104 submitter-id, or request one from your support site by invoking
105 .B `ipsec send-pr \-\-request\-id'.
106 If your site does not distinguish between different user sites, or if
107 you are not affiliated with the support site, use
111 The more precise your problem description and the more complete your
112 information, the faster your support team can solve your problems.
115 .BI \-f " problem-report"
116 specify a file (\fIproblem-report\fR) which already contains a
117 complete problem report.
119 sends the contents of the file without invoking the editor. If
126 reads from standard input.
129 Give the problem report the severity
132 .BI \-t " mail-address"
133 Change mail address at the support site for problem reports. The
136 is the address used for the default
140 argument rather than this option in nearly all cases.
147 header of the message.
150 print the form specified by the environment variable
152 on standard output. If
154 is not set, print the standard blank PR template. No mail is sent.
157 print the list of available categories. No mail is sent.
160 sends mail to the default support site, or
162 if specified, with a request for your
179 to submit problem reports rather than mailing them directly. Using
180 both the template and
182 itself will help ensure all necessary information will reach the
185 The environment variable
187 specifies the editor to invoke on the template.
192 If the environment variable
194 is set, then its value is used as the file name of the template for
195 your problem-report editing session. You can use this to start with a
196 partially completed form (for example, a form with the identification
197 fields already completed).
198 .SH "HOW TO FILL OUT A PROBLEM REPORT"
199 Problem reports have to be in a particular form so that a program can
200 easily manage them. Please remember the following guidelines:
204 with each problem report.
206 For follow-up mail, use the same subject line as the one in the automatic
207 acknowledgent. It consists of category, PR number and the original synopsis
208 line. This allows the support site to relate several mail messages to a
209 particular PR and to record them automatically.
211 Please try to be as accurate as possible in the subject and/or synopsis line.
213 The subject and the synopsis line are not confidential. This is
214 because open-bugs lists are compiled from them. Avoid confidential
221 or the document \fIReporting Problems With send-pr\fR\ for detailed
222 information on reporting problems
223 .SH "HOW TO SUBMIT TEST CASES, CODE, ETC."
224 Submit small code samples with the PR. Contact the support site for
225 instructions on submitting larger test cases and problematic source
228 .ta \w'/tmp/pbad$$ 'u
229 /tmp/p$$ copy of PR used in editing session
231 /tmp/pf$$ copy of empty PR form, for testing purposes
233 /tmp/pbad$$ file for rejected PRs
235 @IPSEC_DIR@/send-pr.conf script to customize send-pr.
236 .SH EMACS USER INTERFACE
237 An Emacs user interface for
239 with completion of field values is part of the
241 distribution (invoked with
247 in the top level directory of the distribution for configuration and
248 installation information. The Emacs LISP template file is
252 .SH INSTALLATION AND CONFIGURATION
257 for installation instructions.
259 .I Reporting Problems Using send-pr
260 (also installed as the GNU Info file
272 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
275 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
277 Permission is granted to make and distribute verbatim copies of
278 this manual provided the copyright notice and this permission notice
279 are preserved on all copies.
281 Permission is granted to copy and distribute modified versions of this
282 manual under the conditions for verbatim copying, provided that the
283 entire resulting derived work is distributed under the terms of a
284 permission notice identical to this one.
286 Permission is granted to copy and distribute translations of this
287 manual into another language, under the above conditions for modified
288 versions, except that this permission notice may be included in
289 translations approved by the Free Software Foundation instead of in
290 the original English.