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