]> git.ipfire.org Git - people/ms/strongswan.git/blob - doc/manpage.d/ipsec_send-pr.8.html
- import of strongswan-2.7.0
[people/ms/strongswan.git] / doc / manpage.d / ipsec_send-pr.8.html
1 Content-type: text/html
2
3 <HTML><HEAD><TITLE>Manpage of SEND-PR</TITLE>
4 </HEAD><BODY>
5 <H1>SEND-PR</H1>
6 Section: User Commands (1)<BR>Updated: xVERSIONx<BR><A HREF="#index">Index</A>
7 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
8
9 <A NAME="lbAB">&nbsp;</A>
10 <H2>NAME</H2>
11
12 ipsec send-pr - send problem report (PR) to a central support site
13 <A NAME="lbAC">&nbsp;</A>
14 <H2>SYNOPSIS</H2>
15
16 <B>ipsec send-pr</B>
17
18 [
19 <I>site</I>
20
21 ]
22 [
23 <B>-f</B>
24
25 <I>problem-report</I>
26
27 ]
28 [
29 <B>-t</B>
30
31 <I>mail-address</I>
32
33 ]
34 <BR>
35
36
37 [
38 <B>-P</B>
39
40 ]
41 [
42 <B>-L</B>
43
44 ]
45 [
46 <B>-s</B>
47
48 <I>severity</I>
49
50 ]
51 [
52 <B>-c</B>
53
54 <I>address</I>
55
56 ]
57 <BR>
58
59 [
60 <B>--request-id</B>
61
62 ]
63 [
64 <B>-V</B>
65
66 ]
67 <A NAME="lbAD">&nbsp;</A>
68 <H2>DESCRIPTION</H2>
69
70 <B>ipsec send-pr</B>
71
72 is a tool used to submit
73 <I>problem reports </I>
74
75
76 (PRs) to a central support site. In most cases the correct
77 <I>site</I>
78
79 will be the default. This argument indicates the support site which
80 is responsible for the category of problem involved. Some sites may
81 use a local address as a default.
82 <I>site</I>
83
84 values are defined by using the
85 <B><A HREF="aliases.5.html">aliases</A></B>(5).
86
87 <P>
88
89 <B>ipsec send-pr</B>
90
91 invokes an editor on a problem report template (after trying to fill
92 in some fields with reasonable default values). When you exit the
93 editor,
94 <B>ipsec send-pr </B>
95
96 sends the completed form to the
97 <I>Problem Report Management System</I>
98
99 (<B>GNATS</B>) at a central support site. At the support site, the PR
100 is assigned a unique number and is stored in the <B>GNATS</B> database
101 according to its category and submitter-id. <B>GNATS</B> automatically
102 replies with an acknowledgement, citing the category and the PR
103 number.
104 <P>
105
106 To ensure that a PR is handled promptly, it should contain your (unique)
107 <I>submitter-id</I> and one of the available <I>categories</I> to identify the
108 problem area. (Use
109 <B>`ipsec send-pr -L'</B>
110
111 to see a list of categories.)
112 <P>
113
114 The
115 <B>ipsec send-pr</B>
116
117 template at your site should already be customized with your
118 submitter-id (running `<B>install-sid</B> <I>submitter-id</I>' to
119 accomplish this is part of the installation procedures for
120 <B>ipsec</B>send-pr<B>).</B>
121
122 If this hasn't been done, see your system administrator for your
123 submitter-id, or request one from your support site by invoking
124 <B>`ipsec send-pr --request-id'.</B>
125
126 If your site does not distinguish between different user sites, or if
127 you are not affiliated with the support site, use
128 <B>`net'</B>
129
130 for this field.
131 <P>
132
133 The more precise your problem description and the more complete your
134 information, the faster your support team can solve your problems.
135 <A NAME="lbAE">&nbsp;</A>
136 <H2>OPTIONS</H2>
137
138 <DL COMPACT>
139 <DT><B>-f</B><I> problem-report</I>
140
141 <DD>
142 specify a file (<I>problem-report</I>) which already contains a
143 complete problem report.
144 <B>ipsec send-pr</B>
145
146 sends the contents of the file without invoking the editor. If
147 the value for
148 <I>problem-report</I>
149
150 is
151 <B>`-'</B>,
152
153 then
154 <B>ipsec send-pr</B>
155
156 reads from standard input.
157 <DT><B>-s</B><I> severity</I>
158
159 <DD>
160 Give the problem report the severity
161 <I>severity</I>.
162
163 <DT><B>-t</B><I> mail-address</I>
164
165 <DD>
166 Change mail address at the support site for problem reports. The
167 default
168 <I>mail-address</I>
169
170 is the address used for the default
171 <I>site</I>.
172
173 Use the
174 <I>site</I>
175
176 argument rather than this option in nearly all cases.
177 <DT><B>-c</B><I> address</I>
178
179 <DD>
180 Put
181 <I>address</I>
182
183 in the
184 <B>Cc:</B>
185
186 header of the message.
187 <DT><B>-P</B>
188
189 <DD>
190 print the form specified by the environment variable
191 <B>PR_FORM </B>
192
193 on standard output. If
194 <B>PR_FORM</B>
195
196 is not set, print the standard blank PR template. No mail is sent.
197 <DT><B>-L</B>
198
199 <DD>
200 print the list of available categories. No mail is sent.
201 <DT><B>--request-id</B>
202
203 <DD>
204 sends mail to the default support site, or
205 <I>site</I>
206
207 if specified, with a request for your
208 <I>submitter-id</I>.
209
210 If you are
211 not affiliated with
212 <I>site</I>,
213
214 use a
215 <I>submitter-id</I>
216
217 of
218 <B>net</B>'.
219
220 <DT><B>-V</B>
221
222 <DD>
223 Display the
224 <B>ipsec send-pr</B>
225
226 version number.
227 </DL>
228 <P>
229
230 Note: use
231 <B>ipsec send-pr</B>
232
233 to submit problem reports rather than mailing them directly. Using
234 both the template and
235 <B>ipsec send-pr</B>
236
237 itself will help ensure all necessary information will reach the
238 support site.
239 <A NAME="lbAF">&nbsp;</A>
240 <H2>ENVIRONMENT</H2>
241
242 The environment variable
243 <B>EDITOR</B>
244
245 specifies the editor to invoke on the template.
246 <BR>
247
248 default:
249 <B>vi</B>
250
251 <P>
252 If the environment variable
253 <B>PR_FORM</B>
254
255 is set, then its value is used as the file name of the template for
256 your problem-report editing session. You can use this to start with a
257 partially completed form (for example, a form with the identification
258 fields already completed).
259 <A NAME="lbAG">&nbsp;</A>
260 <H2>HOW TO FILL OUT A PROBLEM REPORT</H2>
261
262 Problem reports have to be in a particular form so that a program can
263 easily manage them. Please remember the following guidelines:
264 <DL COMPACT>
265 <DT>*<DD>
266 describe only
267 <B>one problem</B>
268
269 with each problem report.
270 <DT>*<DD>
271 For follow-up mail, use the same subject line as the one in the automatic
272 acknowledgent. It consists of category, PR number and the original synopsis
273 line. This allows the support site to relate several mail messages to a
274 particular PR and to record them automatically.
275 <DT>*<DD>
276 Please try to be as accurate as possible in the subject and/or synopsis line.
277 <DT>*<DD>
278 The subject and the synopsis line are not confidential. This is
279 because open-bugs lists are compiled from them. Avoid confidential
280 information there.
281 </DL>
282 <P>
283
284 See the GNU
285 <B>Info </B>
286
287 file
288 <B>send-pr.info</B>
289
290 or the document <I>Reporting Problems With send-pr</I>&nbsp;for detailed
291 information on reporting problems
292 <A NAME="lbAH">&nbsp;</A>
293 <H2>HOW TO SUBMIT TEST CASES, CODE, ETC.</H2>
294
295 Submit small code samples with the PR. Contact the support site for
296 instructions on submitting larger test cases and problematic source
297 code.
298 <A NAME="lbAI">&nbsp;</A>
299 <H2>FILES</H2>
300
301
302
303 /tmp/p$$<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>copy of PR used in editing session<BR>
304 <BR>
305
306 /tmp/pf$$<TT>&nbsp;&nbsp;&nbsp;</TT>copy of empty PR form, for testing purposes<BR>
307 <BR>
308
309 /tmp/pbad$$<TT>&nbsp;</TT>file for rejected PRs<BR>
310 <BR>
311
312 @IPSEC_DIR@/send-pr.confscript to customize send-pr.<BR>
313 <A NAME="lbAJ">&nbsp;</A>
314 <H2>EMACS USER INTERFACE</H2>
315
316 An Emacs user interface for
317 <B>send-pr</B>
318
319 with completion of field values is part of the
320 <B>send-pr</B>
321
322 distribution (invoked with
323 <B>M-x send-pr</B>).
324
325 See the file
326 <B>send-pr.info</B>
327
328 or the ASCII file
329 <B>INSTALL</B>
330
331 in the top level directory of the distribution for configuration and
332 installation information. The Emacs LISP template file is
333 <B>send-pr-el.in</B>
334
335 and is installed as
336 <B>send-pr.el</B>.
337
338 <A NAME="lbAK">&nbsp;</A>
339 <H2>INSTALLATION AND CONFIGURATION</H2>
340
341 See
342 <B>send-pr.info</B>
343
344 or
345 <B>INSTALL</B>
346
347 for installation instructions.
348 <A NAME="lbAL">&nbsp;</A>
349 <H2>SEE ALSO</H2>
350
351 <I>Reporting Problems Using send-pr</I>
352
353 (also installed as the GNU Info file
354 <B>send-pr.info</B>).
355
356 <P>
357
358 <B><A HREF="http://localhost/cgi-bin/man/man2html?l+gnats">gnats</A></B>(l),
359
360 <B><A HREF="query-pr.1.html">query-pr</A></B>(1),
361
362 <B><A HREF="edit-pr.1.html">edit-pr</A></B>(1),
363
364 <B><A HREF="gnats.8.html">gnats</A></B>(8),
365
366 <B><A HREF="queue-pr.8.html">queue-pr</A></B>(8),
367
368 <B><A HREF="at-pr.8.html">at-pr</A></B>(8),
369
370 <B><A HREF="mkcat.8.html">mkcat</A></B>(8),
371
372 <B><A HREF="mkdist.8.html">mkdist</A></B>(8).
373
374 <A NAME="lbAM">&nbsp;</A>
375 <H2>AUTHORS</H2>
376
377 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
378 Support)
379 <A NAME="lbAN">&nbsp;</A>
380 <H2>COPYING</H2>
381
382 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
383 <P>
384
385 Permission is granted to make and distribute verbatim copies of
386 this manual provided the copyright notice and this permission notice
387 are preserved on all copies.
388 <P>
389
390 Permission is granted to copy and distribute modified versions of this
391 manual under the conditions for verbatim copying, provided that the
392 entire resulting derived work is distributed under the terms of a
393 permission notice identical to this one.
394 <P>
395
396 Permission is granted to copy and distribute translations of this
397 manual into another language, under the above conditions for modified
398 versions, except that this permission notice may be included in
399 translations approved by the Free Software Foundation instead of in
400 the original English.
401 <P>
402 <P>
403
404 <HR>
405 <A NAME="index">&nbsp;</A><H2>Index</H2>
406 <DL>
407 <DT><A HREF="#lbAB">NAME</A><DD>
408 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
409 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
410 <DT><A HREF="#lbAE">OPTIONS</A><DD>
411 <DT><A HREF="#lbAF">ENVIRONMENT</A><DD>
412 <DT><A HREF="#lbAG">HOW TO FILL OUT A PROBLEM REPORT</A><DD>
413 <DT><A HREF="#lbAH">HOW TO SUBMIT TEST CASES, CODE, ETC.</A><DD>
414 <DT><A HREF="#lbAI">FILES</A><DD>
415 <DT><A HREF="#lbAJ">EMACS USER INTERFACE</A><DD>
416 <DT><A HREF="#lbAK">INSTALLATION AND CONFIGURATION</A><DD>
417 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
418 <DT><A HREF="#lbAM">AUTHORS</A><DD>
419 <DT><A HREF="#lbAN">COPYING</A><DD>
420 </DL>
421 <HR>
422 This document was created by
423 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
424 using the manual pages.<BR>
425 Time: 21:40:18 GMT, November 11, 2003
426 </BODY>
427 </HTML>