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