mostly revert commit 700c1c04445f4ff11cdb7256df2be57db55abbf6
[alioth/cvs.git] / man / cvsbug.8
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 .\" ---------------------------------------------------------------------------
20 .nh
21 .TH CVSBUG 8 xVERSIONx "February 1993"
22 .SH NAME
23 cvsbug \- send problem report (PR) about CVS to a central support site
24 .SH SYNOPSIS
25 .B cvsbug
26 [
27 .I site
28 ]
29 [
30 .B \-f
31 .I problem-report
32 ]
33 [
34 .B \-t
35 .I mail-address
36 ]
37 .br
38 .in +0.8i
39 [
40 .B \-P
41 ]
42 [
43 .B \-L
44 ]
45 [
46 .B \-\-request-id
47 ]
48 [
49 .B \-v
50 ]
51 .SH DESCRIPTION
52 .B cvsbug
53 is a tool used to submit 
54 .I problem reports 
55 .\" SITE ADMINISTRATORS - change this if you use a local default
56 (PRs) to a central support site.  In most cases the correct 
57 .I site
58 will be the default.  This argument indicates the support site which
59 is responsible for the category of problem involved.  Some sites may
60 use a local address as a default.  
61 .I site
62 values are defined by using the 
63 .BR aliases (5).
64 .LP
65 .B cvsbug
66 invokes an editor on a problem report template (after trying to fill
67 in some fields with reasonable default values).  When you exit the
68 editor,
69 .B cvsbug 
70 sends the completed form to the
71 .I Problem Report Management System
72 (\fBGNATS\fR) at a central support site.  At the support site, the PR
73 is assigned a unique number and is stored in the \fBGNATS\fR database
74 according to its category and submitter-id.  \fBGNATS\fR automatically
75 replies with an acknowledgement, citing the category and the PR
76 number.
77 .LP
78 To ensure that a PR is handled promptly, it should contain your (unique)
79 \fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the
80 problem area.  (Use
81 .B `cvsbug -L'
82 to see a list of categories.)
83 .LP
84 The
85 .B cvsbug
86 template at your site should already be customized with your
87 submitter-id (running `\|\fBinstall-sid\fP \fIsubmitter-id\fP\|' to
88 accomplish this is part of the installation procedures for
89 .BR cvsbug ).
90 If this hasn't been done, see your system administrator for your
91 submitter-id, or request one from your support site by invoking
92 .B `cvsbug \-\-request\-id'.
93 If your site does not distinguish between different user sites, or if
94 you are not affiliated with the support site, use
95 .B `net'
96 for this field.
97 .LP
98 The more precise your problem description and the more complete your
99 information, the faster your support team can solve your problems.
100 .SH OPTIONS
101 .TP
102 .BI \-f " problem-report"
103 specify a file (\fIproblem-report\fR) which already contains a
104 complete problem report.
105 .B cvsbug
106 sends the contents of the file without invoking the editor.  If 
107 the value for 
108 .I problem-report
109 is
110 .BR `\|\-\|' ,
111 then
112 .B cvsbug
113 reads from standard input.
114 .TP
115 .BI \-t " mail-address"
116 Change mail address at the support site for problem reports.  The
117 default 
118 .I mail-address
119 is the address used for the default 
120 .IR site .  
121 Use the
122 .I site
123 argument rather than this option in nearly all cases.
124 .TP
125 .B \-P
126 print the form specified by the environment variable 
127 .B PR_FORM 
128 on standard output.  If 
129 .B PR_FORM
130 is not set, print the standard blank PR template.  No mail is sent.
131 .TP
132 .B -L
133 print the list of available categories.  No mail is sent.
134 .TP
135 .B \-\-request\-id
136 sends mail to the default support site, or
137 .I site
138 if specified, with a request for your 
139 .IR submitter-id . 
140 If you are
141 not affiliated with 
142 .IR site ,
143 use a
144 .I submitter-id
145 of
146 .BR net \|'.
147 .TP
148 .B \-v
149 Display the 
150 .B cvsbug
151 version number.
152 .LP
153 Note: use
154 .B cvsbug
155 to submit problem reports rather than mailing them directly.  Using
156 both the template and
157 .B cvsbug
158 itself will help ensure all necessary information will reach the
159 support site.
160 .SH ENVIRONMENT
161 The environment variable 
162 .B EDITOR
163 specifies the editor to invoke on the template.
164 .br
165 default:
166 .B vi
167 .sp
168 If the environment variable 
169 .B PR_FORM
170 is set, then its value is used as the file name of the template for
171 your problem-report editing session.  You can use this to start with a
172 partially completed form (for example, a form with the identification
173 fields already completed).
174 .SH "HOW TO FILL OUT A PROBLEM REPORT"
175 Problem reports have to be in a particular form so that a program can
176 easily manage them.  Please remember the following guidelines:
177 .IP \(bu 3m 
178 describe only 
179 .B one problem
180 with each problem report.
181 .IP \(bu 3m
182 For follow-up mail, use the same subject line as the one in the automatic
183 acknowledgement. It consists of category, PR number and the original synopsis
184 line.  This allows the support site to relate several mail messages to a
185 particular PR and to record them automatically.
186 .IP \(bu 3m 
187 Please try to be as accurate as possible in the subject and/or synopsis line.
188 .IP \(bu 3m 
189 The subject and the synopsis line are not confidential.  This is
190 because open-bugs lists are compiled from them.  Avoid confidential
191 information there.
192 .LP
193 See the GNU 
194 .B Info 
195 file
196 .B cvsbug.info
197 or the document \fIReporting Problems With cvsbug\fR\ for detailed
198 information on reporting problems
199 .SH "HOW TO SUBMIT TEST CASES, CODE, ETC."
200 Submit small code samples with the PR.  Contact the support site for
201 instructions on submitting larger test cases and problematic source
202 code.
203 .SH FILES
204 .ta \w'/tmp/pbad$$  'u
205 /tmp/p$$        copy of PR used in editing session
206 .br
207 /tmp/pf$$       copy of empty PR form, for testing purposes
208 .br
209 /tmp/pbad$$     file for rejected PRs
210 .SH INSTALLATION AND CONFIGURATION
211 See 
212 .B INSTALL
213 for installation instructions.
214 .SH SEE ALSO
215 .BR gnats (l),
216 .BR query-pr (1),
217 .BR edit-pr (1),
218 .BR gnats (8),
219 .BR queue-pr (8),
220 .BR at-pr (8),
221 .BR mkcat (8),
222 .BR mkdist (8).
223 .SH AUTHORS
224 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
225 Support)
226 .SH COPYING
227 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
228 .PP
229 Permission is granted to make and distribute verbatim copies of
230 this manual provided the copyright notice and this permission notice
231 are preserved on all copies.
232 .PP
233 Permission is granted to copy and distribute modified versions of this
234 manual under the conditions for verbatim copying, provided that the
235 entire resulting derived work is distributed under the terms of a
236 permission notice identical to this one.
237 .PP
238 Permission is granted to copy and distribute translations of this
239 manual into another language, under the above conditions for modified
240 versions, except that this permission notice may be included in
241 translations approved by the Free Software Foundation instead of in
242 the original English.
243