gnu/usr.bin/send-pr/send-pr.1

   1 .\" -*- nroff -*-
   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
   5 .\"
   6 .\"    This file is part of the Problem Report Management System (GNATS)
   7 .\"    Copyright 1992 Cygnus Support
   8 .\"
   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.
  13 .\"
  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.
  18 .\"
  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
  22 .\"
  23 .\" ---------------------------------------------------------------------------
  24 .\"
  25 .\" $FreeBSD$
  26 .nh
  27 .TH SEND-PR 1 3.113 "October 2006"
  28 .SH NAME
  29 send-pr \- send problem report (PR) to a central support site
  30 .SH SYNOPSIS
  31 .B send-pr
  32 [
  33 .I site
  34 ]
  35 [
  36 .B \-f
  37 .I problem-report
  38 ]
  39 [
  40 .B \-t
  41 .I mail-address
  42 ]
  43 .br
  44 .in +0.8i
  45 [
  46 .B \-P
  47 ]
  48 [
  49 .B \-L
  50 ]
  51 [
  52 .B \-s
  53 .I severity
  54 ]
  55 [
  56 .B \-V
  57 ]
  58 .br
  59 [
  60 .B \-\-version
  61 ]
  62 [
  63 .B \-c
  64 .I address
  65 ]
  66 [
  67 .B \-a
  68 .I file
  69 ]
  70 .SH DESCRIPTION
  71 .B send-pr
  72 is a tool used to submit
  73 .I problem reports
  74 .\" SITE ADMINISTRATORS - change this if you use a local default
  75 (PRs) to a central support site.  In most cases the correct
  76 .I site
  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.
  80 .I site
  81 values are defined by using the
  82 .BR aliases (5).
  83 .LP
  84 .B send-pr
  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
  87 editor,
  88 .B send-pr
  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
  95 number.
  96 .LP
  97 To ensure that a PR is handled promptly, it should contain
  98 one of the available \fIcategories\fR to identify the
  99 problem area.  (Use
 100 .B `send-pr -L'
 101 to see a list of categories.)
 102 .LP
 103 The more precise your problem description and the more complete your
 104 information, the faster your support team can solve your problems.
 105 .LP
 106 .B send-pr
 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:
 110 .IP
 111 .I http://www.freebsd.org/send-pr.html
 112 .SH OPTIONS
 113 .TP
 114 .BI \-f " problem-report"
 115 specify a file (\fIproblem-report\fR) which already contains a
 116 complete problem report.
 117 .B send-pr
 118 sends the contents of the file without invoking the editor.  If
 119 the value for
 120 .I problem-report
 121 is
 122 .BR `\|\-\|' ,
 123 then
 124 .B send-pr
 125 reads from standard input.
 126 .TP
 127 .BI \-s " severity"
 128 Give the problem report the severity
 129 .IR severity .
 130 .TP
 131 .BI \-t " mail-address"
 132 Change mail address at the support site for problem reports.  The
 133 default
 134 .I mail-address
 135 is the address used for the default
 136 .IR site .
 137 Use the
 138 .I site
 139 argument rather than this option in nearly all cases.
 140 .TP
 141 .BI \-c " address"
 142 Put
 143 .I address
 144 in the
 145 .B Cc:
 146 header of the message.
 147 .TP
 148 .BI \-a " file"
 149 Copy the specified
 150 .I file
 151 into the
 152 .B Fix:
 153 section.
 154 Binary files are uuencoded.
 155 .TP
 156 .B \-P
 157 print the form specified by the environment variable
 158 .B PR_FORM
 159 on standard output.  If
 160 .B PR_FORM
 161 is not set, print the standard blank PR template.  No mail is sent.
 162 .TP
 163 .B \-L
 164 print the list of available categories.  No mail is sent.
 165 .TP
 166 .B \-V
 167 Display the
 168 .B send-pr
 169 version number.
 170 This may also be specified as
 171 .B \-\-version.
 172 .LP
 173 Note: use
 174 .B send-pr
 175 to submit problem reports rather than mailing them directly.  Using
 176 both the template and
 177 .B send-pr
 178 itself will help ensure all necessary information will reach the
 179 support site.
 180 .SH FREEBSD CATEGORIES
 181 .TP
 182 .B advocacy
 183 This used to be for the advocacy WWW pages.
 184 Now deprecated in favour of the
 185 .B www
 186 category, relevant alternative use of this category is encouraged.
 187 .TP
 188 .B alpha
 189 Alpha processor specific problems.
 190 .TP
 191 .B amd64
 192 AMD64 processor specific problems.
 193 .TP
 194 .B arm
 195 ARM processor specific problems.
 196 .TP
 197 .B bin
 198 Corrections or enhancements to system executables.
 199 .TP
 200 .B conf
 201 Corrections or enhancements to the system configuration files.
 202 .TP
 203 .B docs
 204 Corrections or enhancements to the manpages or other documentation.
 205 .TP
 206 .B gnu
 207 Corrections or enhancements to the GNU contributed software.
 208 .TP
 209 .B i386
 210 Intel x86 processor specific problems.
 211 .TP
 212 .B ia64
 213 Intel ia64 processor specific problems.
 214 .TP
 215 .B java
 216 Problems related to Java.
 217 .TP
 218 .B kern
 219 Changes or enhancements to the architecture independent kernel sources.
 220 .TP
 221 .B misc
 222 Problems that do not fit into any of the other categories.
 223 .TP
 224 .B ports
 225 Corrections or enhancements (including new ports) to the ports collection.
 226 .TP
 227 .B powerpc
 228 PowerPC processor specific problems.
 229 .TP
 230 .B sparc64
 231 SPARC processor specific problems.
 232 .TP
 233 .B standards
 234 Standards conformance issues.
 235 .TP
 236 .B sun4v
 237 Problems specific to the SPARC sun4v architecture and processors.
 238 .TP
 239 .B threads
 240 Problems related to threading on FreeBSD.
 241 .TP
 242 .B usb
 243 Problems related to the USB subsystem.
 244 .TP
 245 .B www
 246 Changes or enhancements to the FreeBSD website.
 247 .SH ENVIRONMENT
 248 The environment variable
 249 .B EDITOR
 250 specifies the editor to invoke on the template.
 251 .br
 252 default:
 253 .B vi
 254 .sp
 255 If the environment variable
 256 .B MAIL_AGENT
 257 is set, its value is used as the path + command line arguments of the
 258 executable to be invoked for sending the problem report (which will be
 259 provided via standard input).
 260 .br
 261 This can be useful if you either use a MTA other than sendmail or need
 262 to provide additional parameters, such as the envelope sender on
 263 machines without a valid FQDN.
 264 .br
 265 Default value:
 266 .B /usr/sbin/sendmail -oi -t
 267 .sp
 268 If the environment variable
 269 .B PR_FORM
 270 is set, then its value is used as the file name of the template for
 271 your problem-report editing session.  You can use this to start with a
 272 partially completed form (for example, a form with the identification
 273 fields already completed).
 274 .SH "HOW TO FILL OUT A PROBLEM REPORT"
 275 Problem reports have to be in a particular form so that a program can
 276 easily manage them.  Please remember the following guidelines:
 277 .IP \(bu 3m
 278 describe only
 279 .B one problem
 280 with each problem report.
 281 .IP \(bu 3m
 282 For follow-up mail, use the same subject line as the one in the automatic
 283 acknowledgement. It consists of category, PR number and the original synopsis
 284 line.  This allows the support site to relate several mail messages to a
 285 particular PR and to record them automatically.
 286 .IP \(bu 3m
 287 Please try to be as accurate as possible in the subject and/or synopsis line.
 288 .IP \(bu 3m
 289 The subject and the synopsis line are not confidential.  This is
 290 because open-bugs lists are compiled from them.  Avoid confidential
 291 information there.
 292 .LP
 293 See the GNU
 294 .B Info
 295 file
 296 .B send-pr.info
 297 or the document \fIReporting Problems With send-pr\fR\ for detailed
 298 information on reporting problems
 299 .SH "HOW TO SUBMIT TEST CASES, CODE, ETC."
 300 Submit small code samples with the PR.  Contact the support site for
 301 instructions on submitting larger test cases and problematic source
 302 code.
 303 .SH FILES
 304 .ta \w'/tmp/pbad.XXXXXXXX  'u
 305 /tmp/pf.XXXXXXXX        copy of PR used in editing session
 306 .br
 307 /tmp/pf.XXXXXXXX        copy of empty PR form, for testing purposes
 308 .br
 309 /tmp/pr.XXXXXXXX        copy of filled PR form, created on interrupt
 310 .br
 311 /tmp/pbad.XXXXXXXX      file for rejected PRs
 312 .SH EMACS USER INTERFACE
 313 An Emacs user interface for
 314 .B send-pr
 315 with completion of field values is part of the
 316 .B send-pr
 317 distribution (invoked with
 318 .BR "M-x send-pr" ).
 319 See the file
 320 .B send-pr.info
 321 or the ASCII file
 322 .B INSTALL
 323 in the top level directory of the distribution for configuration and
 324 installation information.  The Emacs LISP template file is
 325 .B send-pr-el.in
 326 and is installed as
 327 .BR send-pr.el .
 328 .SH INSTALLATION AND CONFIGURATION
 329 See
 330 .B send-pr.info
 331 or
 332 .B INSTALL
 333 for installation instructions.
 334 .SH SEE ALSO
 335 .I Reporting Problems Using send-pr
 336 (also installed as the GNU Info file
 337 .BR send-pr.info ).
 338 .SH AUTHORS
 339 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
 340 Support)
 341 .SH COPYING
 342 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
 343 .PP
 344 Permission is granted to make and distribute verbatim copies of
 345 this manual provided the copyright notice and this permission notice
 346 are preserved on all copies.
 347 .PP
 348 Permission is granted to copy and distribute modified versions of this
 349 manual under the conditions for verbatim copying, provided that the
 350 entire resulting derived work is distributed under the terms of a
 351 permission notice identical to this one.
 352 .PP
 353 Permission is granted to copy and distribute translations of this
 354 manual into another language, under the above conditions for modified
 355 versions, except that this permission notice may be included in
 356 translations approved by the Free Software Foundation instead of in
 357 the original English.
 358