freeswan/utils/send-pr.man

   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 .nh
  25 .TH SEND-PR 1 xVERSIONx "February 1993"
  26 .SH NAME
  27 ipsec send-pr \- send problem report (PR) to a central support site
  28 .SH SYNOPSIS
  29 .B ipsec send-pr
  30 [
  31 .I site
  32 ]
  33 [
  34 .B \-f
  35 .I problem-report
  36 ]
  37 [
  38 .B \-t
  39 .I mail-address
  40 ]
  41 .br
  42 .in +0.8i
  43 [
  44 .B \-P
  45 ]
  46 [
  47 .B \-L
  48 ]
  49 [
  50 .B \-s
  51 .I severity
  52 ]
  53 [
  54 .B \-c
  55 .I address
  56 ]
  57 .br
  58 [
  59 .B \-\-request-id
  60 ]
  61 [
  62 .B \-V
  63 ]
  64 .SH DESCRIPTION
  65 .B ipsec send-pr
  66 is a tool used to submit
  67 .I problem reports
  68 .\" SITE ADMINISTRATORS - change this if you use a local default
  69 (PRs) to a central support site.  In most cases the correct
  70 .I site
  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.
  74 .I site
  75 values are defined by using the
  76 .BR aliases (5).
  77 .LP
  78 .B ipsec send-pr
  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
  81 editor,
  82 .B ipsec send-pr
  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
  89 number.
  90 .LP
  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
  93 problem area.  (Use
  94 .B `ipsec send-pr -L'
  95 to see a list of categories.)
  96 .LP
  97 The
  98 .B ipsec send-pr
  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
 102 .BR ipsec send-pr ).
 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
 108 .B `net'
 109 for this field.
 110 .LP
 111 The more precise your problem description and the more complete your
 112 information, the faster your support team can solve your problems.
 113 .SH OPTIONS
 114 .TP
 115 .BI \-f " problem-report"
 116 specify a file (\fIproblem-report\fR) which already contains a
 117 complete problem report.
 118 .B ipsec send-pr
 119 sends the contents of the file without invoking the editor.  If
 120 the value for
 121 .I problem-report
 122 is
 123 .BR `\|\-\|' ,
 124 then
 125 .B ipsec send-pr
 126 reads from standard input.
 127 .TP
 128 .BI \-s " severity"
 129 Give the problem report the severity
 130 .IR severity .
 131 .TP
 132 .BI \-t " mail-address"
 133 Change mail address at the support site for problem reports.  The
 134 default
 135 .I mail-address
 136 is the address used for the default
 137 .IR site .
 138 Use the
 139 .I site
 140 argument rather than this option in nearly all cases.
 141 .TP
 142 .BI \-c " address"
 143 Put
 144 .I address
 145 in the
 146 .B Cc:
 147 header of the message.
 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 \-\-request\-id
 160 sends mail to the default support site, or
 161 .I site
 162 if specified, with a request for your
 163 .IR submitter-id .
 164 If you are
 165 not affiliated with
 166 .IR site ,
 167 use a
 168 .I submitter-id
 169 of
 170 .BR net \|'.
 171 .TP
 172 .B \-V
 173 Display the
 174 .B ipsec send-pr
 175 version number.
 176 .LP
 177 Note: use
 178 .B ipsec send-pr
 179 to submit problem reports rather than mailing them directly.  Using
 180 both the template and
 181 .B ipsec send-pr
 182 itself will help ensure all necessary information will reach the
 183 support site.
 184 .SH ENVIRONMENT
 185 The environment variable
 186 .B EDITOR
 187 specifies the editor to invoke on the template.
 188 .br
 189 default:
 190 .B vi
 191 .sp
 192 If the environment variable
 193 .B PR_FORM
 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:
 201 .IP \(bu 3m
 202 describe only
 203 .B one problem
 204 with each problem report.
 205 .IP \(bu 3m
 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.
 210 .IP \(bu 3m
 211 Please try to be as accurate as possible in the subject and/or synopsis line.
 212 .IP \(bu 3m
 213 The subject and the synopsis line are not confidential.  This is
 214 because open-bugs lists are compiled from them.  Avoid confidential
 215 information there.
 216 .LP
 217 See the GNU
 218 .B Info
 219 file
 220 .B send-pr.info
 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
 226 code.
 227 .SH FILES
 228 .ta \w'/tmp/pbad$$  'u
 229 /tmp/p$$        copy of PR used in editing session
 230 .br
 231 /tmp/pf$$       copy of empty PR form, for testing purposes
 232 .br
 233 /tmp/pbad$$     file for rejected PRs
 234 .br
 235 @IPSEC_DIR@/send-pr.conf        script to customize send-pr.
 236 .SH EMACS USER INTERFACE
 237 An Emacs user interface for
 238 .B send-pr
 239 with completion of field values is part of the
 240 .B send-pr
 241 distribution (invoked with
 242 .BR "M-x send-pr" ).
 243 See the file
 244 .B send-pr.info
 245 or the ASCII file
 246 .B INSTALL
 247 in the top level directory of the distribution for configuration and
 248 installation information.  The Emacs LISP template file is
 249 .B send-pr-el.in
 250 and is installed as
 251 .BR send-pr.el .
 252 .SH INSTALLATION AND CONFIGURATION
 253 See
 254 .B send-pr.info
 255 or
 256 .B INSTALL
 257 for installation instructions.
 258 .SH SEE ALSO
 259 .I Reporting Problems Using send-pr
 260 (also installed as the GNU Info file
 261 .BR send-pr.info ).
 262 .LP
 263 .BR gnats (l),
 264 .BR query-pr (1),
 265 .BR edit-pr (1),
 266 .BR gnats (8),
 267 .BR queue-pr (8),
 268 .BR at-pr (8),
 269 .BR mkcat (8),
 270 .BR mkdist (8).
 271 .SH AUTHORS
 272 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
 273 Support)
 274 .SH COPYING
 275 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
 276 .PP
 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.
 280 .PP
 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.
 285 .PP
 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.
 291