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 .\" ---------------------------------------------------------------------------
27 .TH SEND-PR 1 3.113 "October 2006"
29 send-pr \- send problem report (PR) to a central support site
72 is a tool used to submit
74 .\" SITE ADMINISTRATORS - change this if you use a local default
75 (PRs) to a central support site. In most cases the correct
77 will be the default. This argument indicates the support site which
78 is responsible for the category of problem involved. Some sites may
79 use a local address as a default.
81 values are defined by using the
85 invokes an editor on a problem report template (after trying to fill
86 in some fields with reasonable default values). When you exit the
89 sends the completed form to the
90 .I Problem Report Management System
91 (\fBGNATS\fR) at a central support site. At the support site, the PR
92 is assigned a unique number and is stored in the \fBGNATS\fR database
93 according to its category and submitter-id. \fBGNATS\fR automatically
94 replies with an acknowledgement, citing the category and the PR
97 To ensure that a PR is handled promptly, it should contain
98 one of the available \fIcategories\fR to identify the
101 to see a list of categories.)
103 The more precise your problem description and the more complete your
104 information, the faster your support team can solve your problems.
107 depends on a correctly configured mail submission system to work correctly.
108 If, for any reason, sending mail is not working, problem reports can be
109 submitted over the web, through:
111 .I http://www.freebsd.org/send-pr.html
114 .BI \-f " problem-report"
115 specify a file (\fIproblem-report\fR) which already contains a
116 complete problem report.
118 sends the contents of the file without invoking the editor. If
125 reads from standard input.
128 Give the problem report the severity
131 .BI \-t " mail-address"
132 Change mail address at the support site for problem reports. The
135 is the address used for the default
139 argument rather than this option in nearly all cases.
146 header of the message.
154 Binary files are uuencoded.
157 print the form specified by the environment variable
159 on standard output. If
161 is not set, print the standard blank PR template. No mail is sent.
164 print the list of available categories. No mail is sent.
170 This may also be specified as
175 to submit problem reports rather than mailing them directly. Using
176 both the template and
178 itself will help ensure all necessary information will reach the
180 .SH FREEBSD CATEGORIES
183 This used to be for the advocacy WWW pages.
184 Now deprecated in favour of the
186 category, relevant alternative use of this category is encouraged.
189 Alpha processor specific problems.
192 AMD64 processor specific problems.
195 ARM processor specific problems.
198 Corrections or enhancements to system executables.
201 Corrections or enhancements to the system configuration files.
204 Corrections or enhancements to the manpages or other documentation.
207 Corrections or enhancements to the GNU contributed software.
210 Intel x86 processor specific problems.
213 Intel ia64 processor specific problems.
216 Problems related to Java.
219 Changes or enhancements to the architecture independent kernel sources.
222 Problems that do not fit into any of the other categories.
225 Corrections or enhancements (including new ports) to the ports collection.
228 PowerPC processor specific problems.
231 SPARC processor specific problems.
234 Standards conformance issues.
237 Problems related to threading on FreeBSD.
240 Problems related to the USB subsystem.
243 Changes or enhancements to the FreeBSD website.
245 The environment variable
247 specifies the editor to invoke on the template.
252 If the environment variable
254 is set, its value is used as the path + command line arguments of the
255 executable to be invoked for sending the problem report (which will be
256 provided via standard input).
258 This can be useful if you either use a MTA other than sendmail or need
259 to provide additional parameters, such as the envelope sender on
260 machines without a valid FQDN.
263 .B /usr/sbin/sendmail -oi -t
265 If the environment variable
267 is set, then its value is used as the file name of the template for
268 your problem-report editing session. You can use this to start with a
269 partially completed form (for example, a form with the identification
270 fields already completed).
271 .SH "HOW TO FILL OUT A PROBLEM REPORT"
272 Problem reports have to be in a particular form so that a program can
273 easily manage them. Please remember the following guidelines:
277 with each problem report.
279 For follow-up mail, use the same subject line as the one in the automatic
280 acknowledgement. It consists of category, PR number and the original synopsis
281 line. This allows the support site to relate several mail messages to a
282 particular PR and to record them automatically.
284 Please try to be as accurate as possible in the subject and/or synopsis line.
286 The subject and the synopsis line are not confidential. This is
287 because open-bugs lists are compiled from them. Avoid confidential
294 or the document \fIReporting Problems With send-pr\fR\ for detailed
295 information on reporting problems
296 .SH "HOW TO SUBMIT TEST CASES, CODE, ETC."
297 Submit small code samples with the PR. Contact the support site for
298 instructions on submitting larger test cases and problematic source
301 .ta \w'/tmp/pbad.XXXXXXXX 'u
302 /tmp/pf.XXXXXXXX copy of PR used in editing session
304 /tmp/pf.XXXXXXXX copy of empty PR form, for testing purposes
306 /tmp/pr.XXXXXXXX copy of filled PR form, created on interrupt
308 /tmp/pbad.XXXXXXXX file for rejected PRs
309 .SH EMACS USER INTERFACE
310 An Emacs user interface for
312 with completion of field values is part of the
314 distribution (invoked with
320 in the top level directory of the distribution for configuration and
321 installation information. The Emacs LISP template file is
325 .SH INSTALLATION AND CONFIGURATION
330 for installation instructions.
332 .I Reporting Problems Using send-pr
333 (also installed as the GNU Info file
336 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
339 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
341 Permission is granted to make and distribute verbatim copies of
342 this manual provided the copyright notice and this permission notice
343 are preserved on all copies.
345 Permission is granted to copy and distribute modified versions of this
346 manual under the conditions for verbatim copying, provided that the
347 entire resulting derived work is distributed under the terms of a
348 permission notice identical to this one.
350 Permission is granted to copy and distribute translations of this
351 manual into another language, under the above conditions for modified
352 versions, except that this permission notice may be included in
353 translations approved by the Free Software Foundation instead of in
354 the original English.