This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[PATCH: perl@11564] introducing perlivp
[perl5.git] / utils / perlbug.PL
CommitLineData
37fa004c
PP
1#!/usr/local/bin/perl
2
3use Config;
4use File::Basename qw(&basename &dirname);
8a5546a1 5use Cwd;
1948c06a 6use File::Spec::Functions;
37fa004c
PP
7
8# List explicitly here the variables you want Configure to
9# generate. Metaconfig only looks for shell variables, so you
10# have to mention them as if they were shell variables, not
11# %Config entries. Thus you write
12# $startperl
13# to ensure Configure will look for $Config{startperl}.
84902520 14# $perlpath
37fa004c
PP
15
16# This forces PL files to create target in same directory as PL file.
17# This is so that make depend always knows where to find PL derivatives.
8a5546a1 18$origdir = cwd;
44a8e56a
PP
19chdir dirname($0);
20$file = basename($0, '.PL');
774d564b 21$file .= '.com' if $^O eq 'VMS';
37fa004c 22
55d729e4 23open OUT, ">$file" or die "Can't create $file: $!";
37fa004c 24
84902520
TB
25# extract patchlevel.h information
26
1948c06a
CN
27open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h")
28 or die "Can't open patchlevel.h: $!";
84902520
TB
29
30my $patchlevel_date = (stat PATCH_LEVEL)[9];
31
32while (<PATCH_LEVEL>) {
fb73857a 33 last if $_ =~ /^\s*static\s+char.*?local_patches\[\]\s*=\s*{\s*$/;
55d729e4 34}
84902520 35
fb73857a 36my @patches;
84902520 37while (<PATCH_LEVEL>) {
fb73857a 38 last if /^\s*}/;
84902520 39 chomp;
5963b987
GS
40 s/^\s+,?\s*"?//;
41 s/"?\s*,?$//;
84902520 42 s/(['\\])/\\$1/g;
fb73857a 43 push @patches, $_ unless $_ eq 'NULL';
55d729e4
GS
44}
45my $patch_desc = "'" . join("',\n '", @patches) . "'";
46my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches;
84902520 47
c0a6bf09 48close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!";
84902520 49
5edeba26
TB
50# TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is
51# used, compare $Config::config_sh with the stored version. If they differ then
52# append a list of individual differences to the bug report.
53
84902520 54
37fa004c
PP
55print "Extracting $file (with variable substitutions)\n";
56
57# In this section, perl variables will be expanded during extraction.
58# You can use $Config{...} to use Configure variables.
59
b22c7a20 60my $extract_version = sprintf("v%vd", $^V);
1ec03f31 61
37fa004c 62print OUT <<"!GROK!THIS!";
5f05dabc
PP
63$Config{startperl}
64 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
65 if \$running_under_some_shell;
84902520 66
1ec03f31 67my \$config_tag1 = '$extract_version - $Config{cf_time}';
fb73857a 68
84902520 69my \$patchlevel_date = $patchlevel_date;
fb73857a
PP
70my \$patch_tags = '$patch_tags';
71my \@patches = (
55d729e4 72 $patch_desc
fb73857a 73);
37fa004c
PP
74!GROK!THIS!
75
76# In the following, perl variables are not expanded during extraction.
77
78print OUT <<'!NO!SUBS!';
79
80use Config;
1ec03f31 81use File::Spec; # keep perlbug Perl 5.005 compatible
37fa004c 82use Getopt::Std;
37fa004c
PP
83use strict;
84
85sub paraprint;
86
55d729e4
GS
87BEGIN {
88 eval "use Mail::Send;";
89 $::HaveSend = ($@ eq "");
90 eval "use Mail::Util;";
91 $::HaveUtil = ($@ eq "");
92};
c07a80fd 93
489b74f8 94my $Version = "1.33";
c07a80fd
PP
95
96# Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
a5f75d66
AD
97# Changed in 1.07 to see more sendmail execs, and added pipe output.
98# Changed in 1.08 to use correct address for sendmail.
c07a80fd
PP
99# Changed in 1.09 to close the REP file before calling it up in the editor.
100# Also removed some old comments duplicated elsewhere.
101# Changed in 1.10 to run under VMS without Mail::Send; also fixed
a5f75d66 102# temp filename generation.
c07a80fd 103# Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
a5f75d66
AD
104# Changed in 1.12 to check for editor errors, make save/send distinction
105# clearer and add $ENV{REPLYTO}.
84478119
PP
106# Changed in 1.13 to hopefully make it more difficult to accidentally
107# send mail
ab3ef367
PP
108# Changed in 1.14 to make the prompts a little more clear on providing
109# helpful information. Also let file read fail gracefully.
8ecf1a0c
KA
110# Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
111# Also report selected environment variables.
774d564b 112# Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
137443ea 113# Changed in 1.17 Win32 support added. GSAR 97-04-12
1b0e3b9e 114# Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
84902520
TB
115# Changed in 1.19 '-ok' default not '-v'
116# add local patch information
117# warn on '-ok' if this is an old system; add '-okay'
fb73857a 118# Changed in 1.20 Added patchlevel.h reading and version/config checks
55d729e4
GS
119# Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
120# Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
cca87523 121# Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
105f9295 122# Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
8b49bb9a 123# Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
eedd3c36 124# Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
1948c06a 125# Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
50d3c28b 126# Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
975b416b 127# Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000
b0c10877 128# Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000
c0a6bf09 129# Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000
93b42772 130# Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000
489b74f8 131# Changed in 1.33 Don't require -t STDOUT for -ok.
c07a80fd 132
1b0e3b9e 133# TODO: - Allow the user to re-name the file on mail failure, and
55d729e4 134# make sure failure (transmission-wise) of Mail::Send is
c07a80fd 135# accounted for.
1b0e3b9e 136# - Test -b option
37fa004c 137
ab3ef367 138my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
7f2de2d2 139 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
1b0e3b9e 140 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
37fa004c 141
b22c7a20 142my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
1ec03f31
GS
143
144my $config_tag2 = "$perl_version - $Config{cf_time}";
fb73857a 145
37fa004c
PP
146Init();
147
55d729e4
GS
148if ($::opt_h) { Help(); exit; }
149if ($::opt_d) { Dump(*STDOUT); exit; }
eedd3c36 150if (!-t STDIN && !($ok and not $::opt_n)) {
55d729e4
GS
151 paraprint <<EOF;
152Please use perlbug interactively. If you want to
84478119
PP
153include a file, you can use the -f switch.
154EOF
55d729e4 155 die "\n";
84478119 156}
c07a80fd 157
37fa004c 158Query();
cca87523 159Edit() unless $usefile || ($ok and not $::opt_n);
37fa004c
PP
160NowWhat();
161Send();
162
163exit;
164
975b416b 165sub ask_for_alternatives { # (category|severity)
50d3c28b 166 my $name = shift;
975b416b
GS
167 my %alts = (
168 'category' => {
169 'default' => 'core',
170 'ok' => 'install',
171 'opts' => [qw(core docs install library utilities)], # patch, notabug
172 },
173 'severity' => {
174 'default' => 'low',
175 'ok' => 'none',
176 'opts' => [qw(critical high medium low wishlist none)], # zero
7f2de2d2 177 },
975b416b 178 );
7f2de2d2 179 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
50d3c28b 180 my $alt = "";
975b416b
GS
181 if ($ok) {
182 $alt = $alts{$name}{'ok'};
183 } else {
184 my @alts = @{$alts{$name}{'opts'}};
185 paraprint <<EOF;
50d3c28b
GS
186Please pick a \u$name from the following:
187
188 @alts
189
190EOF
975b416b
GS
191 my $err = 0;
192 do {
193 if ($err++ > 5) {
194 die "Invalid $name: aborting.\n";
195 }
196 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
197 $alt = <>;
198 chomp $alt;
199 if ($alt =~ /^\s*$/) {
200 $alt = $alts{$name}{'default'};
201 }
202 } while !((($alt) = grep(/^$alt/i, @alts)));
203 }
50d3c28b
GS
204 lc $alt;
205}
206
37fa004c 207sub Init {
55d729e4
GS
208 # -------- Setup --------
209
210 $Is_MSWin32 = $^O eq 'MSWin32';
211 $Is_VMS = $^O eq 'VMS';
1948c06a
CN
212 $Is_MacOS = $^O eq 'MacOS';
213
214 @ARGV = split m/\s+/,
215 MacPerl::Ask('Provide command-line args here (-h for help):')
216 if $Is_MacOS && $MacPerl::Version =~ /App/;
55d729e4 217
890b8eb0 218 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
55d729e4
GS
219
220 # This comment is needed to notify metaconfig that we are
221 # using the $perladmin, $cf_by, and $cf_time definitions.
222
223 # -------- Configuration ---------
224
225 # perlbug address
8db473c3 226 $perlbug = 'perlbug@perl.org';
55d729e4
GS
227
228 # Test address
229 $testaddress = 'perlbug-test@perl.com';
230
231 # Target address
232 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
233
234 # Users address, used in message and in Reply-To header
235 $from = $::opt_r || "";
236
237 # Include verbose configuration information
238 $verbose = $::opt_v || 0;
239
240 # Subject of bug-report message
241 $subject = $::opt_s || "";
242
243 # Send a file
244 $usefile = ($::opt_f || 0);
245
246 # File to send as report
247 $file = $::opt_f || "";
248
105f9295
HS
249 # File to output to
250 $outfile = $::opt_F || "";
251
55d729e4
GS
252 # Body of report
253 $body = $::opt_b || "";
254
255 # Editor
256 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
257 || ($Is_VMS && "edit/tpu")
258 || ($Is_MSWin32 && "notepad")
1948c06a 259 || ($Is_MacOS && '')
55d729e4
GS
260 || "vi";
261
262 # Not OK - provide build failure template by finessing OK report
263 if ($::opt_n) {
264 if (substr($::opt_n, 0, 2) eq 'ok' ) {
265 $::opt_o = substr($::opt_n, 1);
266 } else {
267 Help();
268 exit();
269 }
270 }
271
272 # OK - send "OK" report for build on this system
273 $ok = 0;
274 if ($::opt_o) {
275 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
276 my $age = time - $patchlevel_date;
277 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
278 my $date = localtime $patchlevel_date;
279 print <<"EOF";
280"perlbug -ok" and "perlbug -nok" do not report on Perl versions which
281are more than 60 days old. This Perl version was constructed on
282$date. If you really want to report this, use
283"perlbug -okay" or "perlbug -nokay".
84902520 284EOF
1b0e3b9e
CR
285 exit();
286 }
55d729e4
GS
287 # force these options
288 unless ($::opt_n) {
289 $::opt_S = 1; # don't prompt for send
290 $::opt_b = 1; # we have a body
291 $body = "Perl reported to build OK on this system.\n";
292 }
293 $::opt_C = 1; # don't send a copy to the local admin
294 $::opt_s = 1; # we have a subject line
295 $subject = ($::opt_n ? 'Not ' : '')
1ec03f31 296 . "OK: perl $perl_version ${patch_tags}on"
55d729e4
GS
297 ." $::Config{'archname'} $::Config{'osvers'} $subject";
298 $ok = 1;
299 } else {
300 Help();
301 exit();
1b0e3b9e 302 }
55d729e4 303 }
37fa004c 304
55d729e4
GS
305 # Possible administrator addresses, in order of confidence
306 # (Note that cf_email is not mentioned to metaconfig, since
307 # we don't really want it. We'll just take it if we have to.)
308 #
309 # This has to be after the $ok stuff above because of the way
310 # that $::opt_C is forced.
311 $cc = $::opt_C ? "" : (
312 $::opt_c || $::Config{'perladmin'}
313 || $::Config{'cf_email'} || $::Config{'cf_by'}
314 );
315
316 # My username
317 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
318 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
1948c06a 319 : $Is_MacOS ? $ENV{'USER'}
55d729e4 320 : eval { getpwuid($<) }; # May be missing
c0830f08
RB
321
322 $from = $::Config{'cf_email'}
323 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
324 ($me eq $::Config{'cf_by'});
55d729e4 325} # sub Init
37fa004c
PP
326
327sub Query {
55d729e4
GS
328 # Explain what perlbug is
329 unless ($ok) {
37fa004c 330 paraprint <<EOF;
8ecf1a0c
KA
331This program provides an easy way to create a message reporting a bug
332in perl, and e-mail it to $address. It is *NOT* intended for
54310121
PP
333sending test messages or simply verifying that perl works, *NOR* is it
334intended for reporting bugs in third-party perl modules. It is *ONLY*
335a means of reporting verifiable problems with the core perl distribution,
336and any solutions to such problems, to the people who maintain perl.
337
338If you're just looking for help with perl, try posting to the Usenet
339newsgroup comp.lang.perl.misc. If you're looking for help with using
340perl with CGI, try posting to comp.infosystems.www.programming.cgi.
37fa004c 341EOF
1b0e3b9e 342 }
37fa004c 343
55d729e4 344 # Prompt for subject of message, if needed
2e7f46bf
JH
345
346 if (TrivialSubject($subject)) {
347 $subject = '';
348 }
349
55d729e4
GS
350 unless ($subject) {
351 paraprint <<EOF;
352First of all, please provide a subject for the
353message. It should be a concise description of
774d564b
PP
354the bug or problem. "perl bug" or "perl problem"
355is not a concise description.
37fa004c 356EOF
55d729e4
GS
357
358 my $err = 0;
2e7f46bf
JH
359 do {
360 print "Subject: ";
55d729e4 361 $subject = <>;
2e7f46bf
JH
362 chomp $subject;
363 if ($err++ == 5) {
55d729e4
GS
364 die "Aborting.\n";
365 }
2e7f46bf 366 } while (TrivialSubject($subject));
55d729e4
GS
367 }
368
369 # Prompt for return address, if needed
370 unless ($from) {
371 # Try and guess return address
372 my $guess;
373
374 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
1948c06a
CN
375 if ($Is_MacOS) {
376 require Mac::InternetConfig;
377 $guess = $Mac::InternetConfig::InternetConfig{
378 Mac::InternetConfig::kICEmail()
379 };
380 }
381
55d729e4
GS
382 unless ($guess) {
383 my $domain;
384 if ($::HaveUtil) {
385 $domain = Mail::Util::maildomain();
386 } elsif ($Is_MSWin32) {
387 $domain = $ENV{'USERDOMAIN'};
388 } else {
389 require Sys::Hostname;
390 $domain = Sys::Hostname::hostname();
391 }
392 if ($domain) {
393 if ($Is_VMS && !$::Config{'d_socket'}) {
394 $guess = "$domain\:\:$me";
41f926b8 395 } else {
55d729e4 396 $guess = "$me\@$domain" if $domain;
c07a80fd 397 }
55d729e4
GS
398 }
399 }
37fa004c 400
55d729e4
GS
401 if ($guess) {
402 unless ($ok) {
403 paraprint <<EOF;
a5f75d66
AD
404Your e-mail address will be useful if you need to be contacted. If the
405default shown is not your full internet e-mail address, please correct it.
37fa004c 406EOF
55d729e4
GS
407 }
408 } else {
409 paraprint <<EOF;
410So that you may be contacted if necessary, please enter
a5f75d66 411your full internet e-mail address here.
37fa004c 412EOF
37fa004c 413 }
37fa004c 414
55d729e4
GS
415 if ($ok && $guess) {
416 # use it
417 $from = $guess;
418 } else {
419 # verify it
420 print "Your address [$guess]: ";
421 $from = <>;
2e7f46bf 422 chomp $from;
55d729e4
GS
423 $from = $guess if $from eq '';
424 }
425 }
37fa004c 426
55d729e4
GS
427 if ($from eq $cc or $me eq $cc) {
428 # Try not to copy ourselves
429 $cc = "yourself";
430 }
37fa004c 431
55d729e4
GS
432 # Prompt for administrator address, unless an override was given
433 if( !$::opt_C and !$::opt_c ) {
434 paraprint <<EOF;
37fa004c 435A copy of this report can be sent to your local
55d729e4 436perl administrator. If the address is wrong, please
c07a80fd
PP
437correct it, or enter 'none' or 'yourself' to not send
438a copy.
37fa004c 439EOF
55d729e4
GS
440 print "Local perl administrator [$cc]: ";
441 my $entry = scalar <>;
2e7f46bf 442 chomp $entry;
37fa004c 443
55d729e4
GS
444 if ($entry ne "") {
445 $cc = $entry;
446 $cc = '' if $me eq $cc;
37fa004c 447 }
55d729e4 448 }
37fa004c 449
55d729e4
GS
450 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
451 $andcc = " and $cc" if $cc;
37fa004c 452
55d729e4 453 # Prompt for editor, if no override is given
ab3ef367 454editor:
55d729e4
GS
455 unless ($::opt_e || $::opt_f || $::opt_b) {
456 paraprint <<EOF;
c07a80fd 457Now you need to supply the bug report. Try to make
55d729e4 458the report concise but descriptive. Include any
ab3ef367
PP
459relevant detail. If you are reporting something
460that does not work as you think it should, please
55d729e4 461try to include example of both the actual
ab3ef367
PP
462result, and what you expected.
463
464Some information about your local
55d729e4 465perl configuration will automatically be included
ab3ef367
PP
466at the end of the report. If you are using any
467unusual version of perl, please try and confirm
468exactly which versions are relevant.
37fa004c
PP
469
470You will probably want to use an editor to enter
471the report. If "$ed" is the editor you want
472to use, then just press Enter, otherwise type in
473the name of the editor you would like to use.
474
c07a80fd 475If you would like to use a prepared file, type
37fa004c 476"file", and you will be asked for the filename.
37fa004c 477EOF
55d729e4
GS
478 print "Editor [$ed]: ";
479 my $entry =scalar <>;
2e7f46bf 480 chomp $entry;
55d729e4
GS
481
482 $usefile = 0;
483 if ($entry eq "file") {
484 $usefile = 1;
485 } elsif ($entry ne "") {
486 $ed = $entry;
37fa004c 487 }
55d729e4 488 }
37fa004c 489
50d3c28b 490 # Prompt for category of bug
975b416b 491 $category ||= ask_for_alternatives('category');
50d3c28b
GS
492
493 # Prompt for severity of bug
975b416b 494 $severity ||= ask_for_alternatives('severity');
50d3c28b 495
55d729e4
GS
496 # Generate scratch file to edit report in
497 $filename = filename();
37fa004c 498
55d729e4
GS
499 # Prompt for file to read report from, if needed
500 if ($usefile and !$file) {
ab3ef367 501filename:
55d729e4 502 paraprint <<EOF;
37fa004c 503What is the name of the file that contains your report?
37fa004c 504EOF
55d729e4
GS
505 print "Filename: ";
506 my $entry = scalar <>;
2e7f46bf 507 chomp $entry;
37fa004c 508
55d729e4
GS
509 if ($entry eq "") {
510 paraprint <<EOF;
511No filename? I'll let you go back and choose an editor again.
ab3ef367 512EOF
55d729e4
GS
513 goto editor;
514 }
515
516 unless (-f $entry and -r $entry) {
517 paraprint <<EOF;
ab3ef367
PP
518I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
519the file? If you don't want to send a file, just enter a blank line and you
520can get back to the editor selection.
ab3ef367 521EOF
55d729e4 522 goto filename;
37fa004c 523 }
55d729e4
GS
524 $file = $entry;
525 }
37fa004c 526
55d729e4 527 # Generate report
b0c10877 528 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
cca87523 529 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
37fa004c 530
55d729e4 531 print REP <<EOF;
84902520 532This is a $reptype report for perl from $from,
1ec03f31 533generated with the help of perlbug $Version running under perl $perl_version.
37fa004c
PP
534
535EOF
536
55d729e4
GS
537 if ($body) {
538 print REP $body;
539 } elsif ($usefile) {
540 open(F, "<$file")
541 or die "Unable to read report file from `$file': $!\n";
542 while (<F>) {
543 print REP $_
544 }
c0a6bf09 545 close(F) or die "Error closing `$file': $!";
55d729e4
GS
546 } else {
547 print REP <<EOF;
774d564b
PP
548
549-----------------------------------------------------------------
550[Please enter your report here]
551
552
553
554[Please do not change anything below this line]
555-----------------------------------------------------------------
556EOF
55d729e4
GS
557 }
558 Dump(*REP);
c0a6bf09 559 close(REP) or die "Error closing report file: $!";
55d729e4
GS
560
561 # read in the report template once so that
562 # we can track whether the user does any editing.
563 # yes, *all* whitespace is ignored.
b0c10877 564 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
55d729e4
GS
565 while (<REP>) {
566 s/\s+//g;
567 $REP{$_}++;
568 }
c0a6bf09 569 close(REP) or die "Error closing report file `$filename': $!";
55d729e4 570} # sub Query
c07a80fd
PP
571
572sub Dump {
55d729e4 573 local(*OUT) = @_;
37fa004c 574
50d3c28b
GS
575 print OUT <<EFF;
576---
577Flags:
578 category=$category
579 severity=$severity
890b8eb0
NC
580EFF
581 if ($::opt_A) {
582 print OUT <<EFF;
583 ack=no
584EFF
585 }
586 print OUT <<EFF;
50d3c28b
GS
587---
588EFF
589 print OUT "This perlbug was built using Perl $config_tag1\n",
1ec03f31 590 "It is being executed now by Perl $config_tag2.\n\n"
55d729e4 591 if $config_tag2 ne $config_tag1;
fb73857a 592
55d729e4 593 print OUT <<EOF;
1ec03f31 594Site configuration information for perl $perl_version:
37fa004c
PP
595
596EOF
55d729e4
GS
597 if ($::Config{cf_by} and $::Config{cf_time}) {
598 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
599 }
600 print OUT Config::myconfig;
37fa004c 601
55d729e4
GS
602 if (@patches) {
603 print OUT join "\n ", "Locally applied patches:", @patches;
604 print OUT "\n";
605 };
84902520 606
55d729e4 607 print OUT <<EOF;
8ecf1a0c 608
774d564b 609---
1ec03f31 610\@INC for perl $perl_version:
774d564b 611EOF
55d729e4
GS
612 for my $i (@INC) {
613 print OUT " $i\n";
614 }
774d564b 615
55d729e4 616 print OUT <<EOF;
8ecf1a0c 617
774d564b 618---
1ec03f31 619Environment for perl $perl_version:
8ecf1a0c 620EOF
5cf1d1f1
JH
621 my @env =
622 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
623 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
27414c22 624 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
8876aa85
JH
625 my %env;
626 @env{@env} = @env;
627 for my $env (sort keys %env) {
55d729e4
GS
628 print OUT " $env",
629 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
630 "\n";
631 }
632 if ($verbose) {
1ec03f31 633 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
55d729e4
GS
634 my $value;
635 foreach (sort keys %::Config) {
636 $value = $::Config{$_};
637 $value =~ s/'/\\'/g;
638 print OUT "$_='$value'\n";
84902520 639 }
55d729e4
GS
640 }
641} # sub Dump
37fa004c
PP
642
643sub Edit {
55d729e4
GS
644 # Edit the report
645 if ($usefile || $body) {
646 paraprint <<EOF;
ab3ef367 647Please make sure that the name of the editor you want to use is correct.
ab3ef367 648EOF
55d729e4
GS
649 print "Editor [$ed]: ";
650 my $entry =scalar <>;
2e7f46bf 651 chomp $entry;
55d729e4
GS
652 $ed = $entry unless $entry eq '';
653 }
a5f75d66 654
55d729e4 655tryagain:
c0a6bf09
TJ
656 my $sts;
657 $sts = system("$ed $filename") unless $Is_MacOS;
1948c06a
CN
658 if ($Is_MacOS) {
659 require ExtUtils::MakeMaker;
660 ExtUtils::MM_MacOS::launch_file($filename);
661 paraprint <<EOF;
662Press Enter when done.
663EOF
664 scalar <>;
665 }
55d729e4
GS
666 if ($sts) {
667 paraprint <<EOF;
a5f75d66
AD
668The editor you chose (`$ed') could apparently not be run!
669Did you mistype the name of your editor? If so, please
55d729e4 670correct it here, otherwise just press Enter.
a5f75d66 671EOF
55d729e4
GS
672 print "Editor [$ed]: ";
673 my $entry =scalar <>;
2e7f46bf 674 chomp $entry;
a5f75d66 675
55d729e4
GS
676 if ($entry ne "") {
677 $ed = $entry;
678 goto tryagain;
679 } else {
680 paraprint <<EOF;
a5f75d66
AD
681You may want to save your report to a file, so you can edit and mail it
682yourself.
683EOF
774d564b 684 }
55d729e4 685 }
774d564b 686
55d729e4
GS
687 return if ($ok and not $::opt_n) || $body;
688 # Check that we have a report that has some, eh, report in it.
689 my $unseen = 0;
690
b0c10877 691 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
55d729e4
GS
692 # a strange way to check whether any significant editing
693 # have been done: check whether any new non-empty lines
694 # have been added. Yes, the below code ignores *any* space
695 # in *any* line.
696 while (<REP>) {
697 s/\s+//g;
698 $unseen++ if $_ ne '' and not exists $REP{$_};
699 }
774d564b 700
55d729e4
GS
701 while ($unseen == 0) {
702 paraprint <<EOF;
774d564b 703I am sorry but it looks like you did not report anything.
774d564b 704EOF
55d729e4
GS
705 print "Action (Retry Edit/Cancel) ";
706 my ($action) = scalar(<>);
707 if ($action =~ /^[re]/i) { # <R>etry <E>dit
708 goto tryagain;
709 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
710 Cancel();
711 }
712 }
713} # sub Edit
774d564b
PP
714
715sub Cancel {
716 1 while unlink($filename); # remove all versions under VMS
717 print "\nCancelling.\n";
718 exit(0);
37fa004c
PP
719}
720
721sub NowWhat {
55d729e4
GS
722 # Report is done, prompt for further action
723 if( !$::opt_S ) {
724 while(1) {
725 paraprint <<EOF;
726Now that you have completed your report, would you like to send
727the message to $address$andcc, display the message on
2e7f46bf
JH
728the screen, re-edit it, display/change the subject,
729or cancel without sending anything?
37fa004c 730You may also save the message as a file to mail at another time.
37fa004c 731EOF
8b49bb9a 732 retry:
2e7f46bf 733 print "Action (Send/Display/Edit/Subject/Save to File): ";
55d729e4 734 my $action = scalar <>;
2e7f46bf 735 chomp $action;
55d729e4
GS
736
737 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
fd49642c
PP
738 my $file_save = $outfile || "perlbug.rep";
739 print "\n\nName of file to save message in [$file_save]: ";
55d729e4 740 my $file = scalar <>;
2e7f46bf 741 chomp $file;
fd49642c 742 $file = $file_save if $file eq "";
55d729e4 743
8b49bb9a
HS
744 unless (open(FILE, ">$file")) {
745 print "\nError opening $file: $!\n\n";
746 goto retry;
747 }
b0c10877 748 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
55d729e4
GS
749 print FILE "To: $address\nSubject: $subject\n";
750 print FILE "Cc: $cc\n" if $cc;
751 print FILE "Reply-To: $from\n" if $from;
752 print FILE "\n";
753 while (<REP>) { print FILE }
c0a6bf09
TJ
754 close(REP) or die "Error closing report file `$filename': $!";
755 close(FILE) or die "Error closing $file: $!";
55d729e4
GS
756
757 print "\nMessage saved in `$file'.\n";
758 exit;
759 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
760 # Display the message
b0c10877 761 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
55d729e4 762 while (<REP>) { print $_ }
c0a6bf09 763 close(REP) or die "Error closing report file `$filename': $!";
2e7f46bf
JH
764 } elsif ($action =~ /^su/i) { # <Su>bject
765 print "Subject: $subject\n";
766 print "If the above subject is fine, just press Enter.\n";
767 print "If not, type in the new subject.\n";
768 print "Subject: ";
769 my $reply = scalar <STDIN>;
770 chomp $reply;
771 if ($reply ne '') {
772 unless (TrivialSubject($reply)) {
773 $subject = $reply;
774 print "Subject: $subject\n";
775 }
776 }
55d729e4
GS
777 } elsif ($action =~ /^se/i) { # <S>end
778 # Send the message
779 print "Are you certain you want to send this message?\n"
780 . 'Please type "yes" if you are: ';
781 my $reply = scalar <STDIN>;
2e7f46bf 782 chomp $reply;
55d729e4
GS
783 if ($reply eq "yes") {
784 last;
785 } else {
786 paraprint <<EOF;
ab3ef367
PP
787That wasn't a clear "yes", so I won't send your message. If you are sure
788your message should be sent, type in "yes" (without the quotes) at the
789confirmation prompt.
ab3ef367 790EOF
55d729e4
GS
791 }
792 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
793 # edit the message
794 Edit();
795 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
796 Cancel();
01544859 797 } elsif ($action =~ /^s/i) {
55d729e4 798 paraprint <<EOF;
84478119
PP
799I'm sorry, but I didn't understand that. Please type "send" or "save".
800EOF
55d729e4 801 }
37fa004c 802 }
55d729e4
GS
803 }
804} # sub NowWhat
37fa004c 805
2e7f46bf
JH
806sub TrivialSubject {
807 my $subject = shift;
808 if ($subject =~
809 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
810 length($subject) < 4 ||
811 $subject !~ /\s/) {
812 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
813 return 1;
814 } else {
815 return 0;
816 }
817}
818
37fa004c 819sub Send {
55d729e4 820 # Message has been accepted for transmission -- Send the message
105f9295
HS
821 if ($outfile) {
822 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
823 goto sendout;
824 }
55d729e4
GS
825 if ($::HaveSend) {
826 $msg = new Mail::Send Subject => $subject, To => $address;
827 $msg->cc($cc) if $cc;
828 $msg->add("Reply-To",$from) if $from;
829
830 $fh = $msg->open;
b0c10877 831 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
55d729e4 832 while (<REP>) { print $fh $_ }
c0a6bf09 833 close(REP) or die "Error closing $filename: $!";
55d729e4
GS
834 $fh->close;
835
836 print "\nMessage sent.\n";
837 } elsif ($Is_VMS) {
838 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
839 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
840 my $prefix;
841 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
842 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
843 }
844 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
845 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
846 }
847 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
848 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
849 if ($sts) {
850 die <<EOF;
851Can't spawn off mail
852 (leaving bug report in $filename): $sts
853EOF
854 }
855 } else {
856 my $sendmail = "";
857 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
858 $sendmail = $_, last if -e $_;
859 }
860 if ($^O eq 'os2' and $sendmail eq "") {
861 my $path = $ENV{PATH};
862 $path =~ s:\\:/: ;
863 my @path = split /$Config{'path_sep'}/, $path;
864 for (@path) {
865 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
866 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
867 }
868 }
37fa004c 869
55d729e4 870 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
c07a80fd
PP
871I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
872the perl package Mail::Send has not been installed, so I can't send your bug
d121ca8c 873report. We apologize for the inconvenience.
c07a80fd
PP
874
875So you may attempt to find some way of sending your message, it has
876been left in the file `$filename'.
c07a80fd 877EOF
01544859 878 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
105f9295 879sendout:
55d729e4
GS
880 print SENDMAIL "To: $address\n";
881 print SENDMAIL "Subject: $subject\n";
882 print SENDMAIL "Cc: $cc\n" if $cc;
883 print SENDMAIL "Reply-To: $from\n" if $from;
884 print SENDMAIL "\n\n";
b0c10877 885 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
55d729e4 886 while (<REP>) { print SENDMAIL $_ }
c0a6bf09 887 close(REP) or die "Error closing $filename: $!";
37fa004c 888
55d729e4 889 if (close(SENDMAIL)) {
105f9295 890 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
55d729e4
GS
891 } else {
892 warn "\nSendmail returned status '", $? >> 8, "'\n";
893 }
894 }
895 1 while unlink($filename); # remove all versions under VMS
896} # sub Send
37fa004c
PP
897
898sub Help {
55d729e4 899 print <<EOF;
37fa004c 900
55d729e4 901A program to help generate bug reports about perl5, and mail them.
37fa004c
PP
902It is designed to be used interactively. Normally no arguments will
903be needed.
55d729e4 904
37fa004c 905Usage:
105f9295 906$0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
d121ca8c 907 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
890b8eb0 908$0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
55d729e4 909
c07a80fd 910Simplest usage: run "$0", and follow the prompts.
37fa004c
PP
911
912Options:
913
914 -v Include Verbose configuration data in the report
55d729e4 915 -f File containing the body of the report. Use this to
37fa004c 916 quickly send a prepared message.
1948c06a 917 -F File to output the resulting mail message to, instead of mailing.
37fa004c
PP
918 -S Send without asking for confirmation.
919 -a Address to send the report to. Defaults to `$address'.
920 -c Address to send copy of report to. Defaults to `$cc'.
921 -C Don't send copy to administrator.
55d729e4 922 -s Subject to include with the message. You will be prompted
37fa004c
PP
923 if you don't supply one on the command line.
924 -b Body of the report. If not included on the command line, or
925 in a file with -f, you will get a chance to edit the message.
926 -r Your return address. The program will ask you to confirm
927 this if you don't give it here.
55d729e4 928 -e Editor to use.
37fa004c 929 -t Test mode. The target address defaults to `$testaddress'.
489b74f8 930 -d Data mode. This prints out your configuration data, without mailing
c07a80fd 931 anything. You can use this with -v to get more complete data.
890b8eb0 932 -A Don't send a bug received acknowledgement to the return address.
84902520 933 -ok Report successful build on this system to perl porters
55d729e4
GS
934 (use alone or with -v). Only use -ok if *everything* was ok:
935 if there were *any* problems at all, use -nok.
fb73857a 936 -okay As -ok but allow report from old builds.
55d729e4
GS
937 -nok Report unsuccessful build on this system to perl porters
938 (use alone or with -v). You must describe what went wrong
939 in the body of the report which you will be asked to edit.
940 -nokay As -nok but allow report from old builds.
941 -h Print this help message.
942
37fa004c
PP
943EOF
944}
945
55d729e4 946sub filename {
93b42772 947 my $dir = File::Spec->tmpdir();
55d729e4 948 $filename = "bugrep0$$";
1ec03f31
GS
949 $filename++ while -e File::Spec->catfile($dir, $filename);
950 $filename = File::Spec->catfile($dir, $filename);
55d729e4
GS
951}
952
37fa004c
PP
953sub paraprint {
954 my @paragraphs = split /\n{2,}/, "@_";
c07a80fd 955 print "\n\n";
37fa004c 956 for (@paragraphs) { # implicit local $_
55d729e4
GS
957 s/(\S)\s*\n/$1 /g;
958 write;
959 print "\n";
37fa004c 960 }
37fa004c 961}
37fa004c
PP
962
963format STDOUT =
964^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
965$_
966.
d121ca8c
CS
967
968__END__
969
970=head1 NAME
971
972perlbug - how to submit bug reports on Perl
973
974=head1 SYNOPSIS
975
976B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
105f9295
HS
977S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
978S<[ B<-r> I<returnaddress> ]>
d121ca8c 979S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
890b8eb0 980S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
d121ca8c 981
55d729e4 982B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
890b8eb0 983 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
1b0e3b9e 984
d121ca8c
CS
985=head1 DESCRIPTION
986
987A program to help generate bug reports about perl or the modules that
55d729e4 988come with it, and mail them.
d121ca8c
CS
989
990If you have found a bug with a non-standard port (one that was not part
991of the I<standard distribution>), a binary distribution, or a
992non-standard module (such as Tk, CGI, etc), then please see the
993documentation that came with that distribution to determine the correct
994place to report bugs.
995
996C<perlbug> is designed to be used interactively. Normally no arguments
997will be needed. Simply run it, and follow the prompts.
998
999If you are unable to run B<perlbug> (most likely because you don't have
1000a working setup to send mail that perlbug recognizes), you may have to
7f2de2d2 1001compose your own report, and email it to B<perlbug@perl.org>. You might
d121ca8c
CS
1002find the B<-d> option useful to get summary information in that case.
1003
1004In any case, when reporting a bug, please make sure you have run through
1005this checklist:
1006
1007=over 4
1008
884baa66 1009=item What version of Perl you are running?
d121ca8c
CS
1010
1011Type C<perl -v> at the command line to find out.
1012
1013=item Are you running the latest released version of perl?
1014
1015Look at http://www.perl.com/ to find out. If it is not the latest
1016released version, get that one and see whether your bug has been
884baa66 1017fixed. Note that bug reports about old versions of Perl, especially
d121ca8c
CS
1018those prior to the 5.0 release, are likely to fall upon deaf ears.
1019You are on your own if you continue to use perl1 .. perl4.
1020
1021=item Are you sure what you have is a bug?
1022
1023A significant number of the bug reports we get turn out to be documented
884baa66 1024features in Perl. Make sure the behavior you are witnessing doesn't fall
d121ca8c 1025under that category, by glancing through the documentation that comes
884baa66 1026with Perl (we'll admit this is no mean task, given the sheer volume of
d121ca8c
CS
1027it all, but at least have a look at the sections that I<seem> relevant).
1028
1029Be aware of the familiar traps that perl programmers of various hues
1030fall into. See L<perltrap>.
1031
f27fa58d
G
1032Check in L<perldiag> to see what any Perl error message(s) mean.
1033If message isn't in perldiag, it probably isn't generated by Perl.
1034Consult your operating system documentation instead.
bdcdfa19 1035
1948c06a
CN
1036If you are on a non-UNIX platform check also L<perlport>, as some
1037features may be unimplemented or work differently.
bdcdfa19 1038
884baa66 1039Try to study the problem under the Perl debugger, if necessary.
d121ca8c
CS
1040See L<perldebug>.
1041
1042=item Do you have a proper test case?
1043
1044The easier it is to reproduce your bug, the more likely it will be
1045fixed, because if no one can duplicate the problem, no one can fix it.
1046A good test case has most of these attributes: fewest possible number
1047of lines; few dependencies on external commands, modules, or
1048libraries; runs on most platforms unimpeded; and is self-documenting.
1049
1050A good test case is almost always a good candidate to be on the perl
1051test suite. If you have the time, consider making your test case so
1052that it will readily fit into the standard test suite.
1053
bdcdfa19
JH
1054Remember also to include the B<exact> error messages, if any.
1055"Perl complained something" is not an exact error message.
1056
1057If you get a core dump (or equivalent), you may use a debugger
1058(B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1059report. NOTE: unless your Perl has been compiled with debug info
1060(often B<-g>), the stack trace is likely to be somewhat hard to use
884baa66 1061because it will most probably contain only the function names and not
bdcdfa19
JH
1062their arguments. If possible, recompile your Perl with debug info and
1063reproduce the dump and the stack trace.
1064
d121ca8c
CS
1065=item Can you describe the bug in plain English?
1066
1067The easier it is to understand a reproducible bug, the more likely it
1068will be fixed. Anything you can provide by way of insight into the
884baa66
JH
1069problem helps a great deal. In other words, try to analyze the
1070problem (to the extent you can) and report your discoveries.
d121ca8c
CS
1071
1072=item Can you fix the bug yourself?
1073
1074A bug report which I<includes a patch to fix it> will almost
1075definitely be fixed. Use the C<diff> program to generate your patches
1076(C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1077package, so you should be able to get it from any of the GNU software
1078repositories). If you do submit a patch, the cool-dude counter at
7f2de2d2 1079perlbug@perl.org will register you as a savior of the world. Your
d121ca8c
CS
1080patch may be returned with requests for changes, or requests for more
1081detailed explanations about your fix.
1082
1083Here are some clues for creating quality patches: Use the B<-c> or
1084B<-u> switches to the diff program (to create a so-called context or
1085unified diff). Make sure the patch is not reversed (the first
1086argument to diff is typically the original file, the second argument
1087your changed file). Make sure you test your patch by applying it with
1088the C<patch> program before you send it on its way. Try to follow the
1089same style as the code you are trying to patch. Make sure your patch
1090really does work (C<make test>, if the thing you're patching supports
1091it).
1092
1093=item Can you use C<perlbug> to submit the report?
1094
1095B<perlbug> will, amongst other things, ensure your report includes
1096crucial information about your version of perl. If C<perlbug> is unable
1097to mail your report after you have typed it in, you may have to compose
1098the message yourself, add the output produced by C<perlbug -d> and email
7f2de2d2 1099it to B<perlbug@perl.org>. If, for some reason, you cannot run
d121ca8c
CS
1100C<perlbug> at all on your system, be sure to include the entire output
1101produced by running C<perl -V> (note the uppercase V).
1102
bdcdfa19 1103Whether you use C<perlbug> or send the email manually, please make
884baa66
JH
1104your Subject line informative. "a bug" not informative. Neither is
1105"perl crashes" nor "HELP!!!". These don't help.
1106A compact description of what's wrong is fine.
bdcdfa19 1107
d121ca8c
CS
1108=back
1109
1110Having done your bit, please be prepared to wait, to be told the bug
884baa66 1111is in your code, or even to get no reply at all. The Perl maintainers
84902520
TB
1112are busy folks, so if your problem is a small one or if it is difficult
1113to understand or already known, they may not respond with a personal reply.
d121ca8c
CS
1114If it is important to you that your bug be fixed, do monitor the
1115C<Changes> file in any development releases since the time you submitted
1116the bug, and encourage the maintainers with kind words (but never any
1117flames!). Feel free to resend your bug report if the next released
1118version of perl comes out and your bug is still present.
1119
1120=head1 OPTIONS
1121
1122=over 8
1123
1124=item B<-a>
1125
7f2de2d2 1126Address to send the report to. Defaults to `perlbug@perl.org'.
d121ca8c 1127
890b8eb0
NC
1128=item B<-A>
1129
1130Don't send a bug received acknowledgement to the reply address.
1131Generally it is only a sensible to use this option if you are a
1132perl maintainer actively watching perl porters for your message to
1133arrive.
1134
d121ca8c
CS
1135=item B<-b>
1136
1137Body of the report. If not included on the command line, or
1138in a file with B<-f>, you will get a chance to edit the message.
1139
1140=item B<-C>
1141
1142Don't send copy to administrator.
1143
1144=item B<-c>
1145
1146Address to send copy of report to. Defaults to the address of the
1147local perl administrator (recorded when perl was built).
1148
1149=item B<-d>
1150
1151Data mode (the default if you redirect or pipe output). This prints out
1152your configuration data, without mailing anything. You can use this
1153with B<-v> to get more complete data.
1154
1155=item B<-e>
1156
55d729e4 1157Editor to use.
d121ca8c
CS
1158
1159=item B<-f>
1160
1161File containing the body of the report. Use this to quickly send a
1162prepared message.
1163
105f9295
HS
1164=item B<-F>
1165
1166File to output the results to instead of sending as an email. Useful
1167particularly when running perlbug on a machine with no direct internet
1168connection.
1169
d121ca8c
CS
1170=item B<-h>
1171
1172Prints a brief summary of the options.
1173
1b0e3b9e
CR
1174=item B<-ok>
1175
84902520
TB
1176Report successful build on this system to perl porters. Forces B<-S>
1177and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1b0e3b9e 1178prompts for a return address if it cannot guess it (for use with
84902520
TB
1179B<make>). Honors return address specified with B<-r>. You can use this
1180with B<-v> to get more complete data. Only makes a report if this
1181system is less than 60 days old.
1182
1183=item B<-okay>
1184
1185As B<-ok> except it will report on older systems.
1b0e3b9e 1186
55d729e4
GS
1187=item B<-nok>
1188
1189Report unsuccessful build on this system. Forces B<-C>. Forces and
1190supplies a value for B<-s>, then requires you to edit the report
1191and say what went wrong. Alternatively, a prepared report may be
1192supplied using B<-f>. Only prompts for a return address if it
1193cannot guess it (for use with B<make>). Honors return address
1194specified with B<-r>. You can use this with B<-v> to get more
1195complete data. Only makes a report if this system is less than 60
1196days old.
1197
1198=item B<-nokay>
1199
1200As B<-nok> except it will report on older systems.
1201
d121ca8c
CS
1202=item B<-r>
1203
1204Your return address. The program will ask you to confirm its default
1205if you don't use this option.
1206
1207=item B<-S>
1208
1209Send without asking for confirmation.
1210
1211=item B<-s>
1212
1213Subject to include with the message. You will be prompted if you don't
1214supply one on the command line.
1215
1216=item B<-t>
1217
1218Test mode. The target address defaults to `perlbug-test@perl.com'.
1219
1220=item B<-v>
1221
1222Include verbose configuration data in the report.
1223
1224=back
1225
1226=head1 AUTHORS
1227
1228Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
6e238990 1229by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1b0e3b9e 1230(E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
55d729e4 1231Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
bdcdfa19 1232(E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1948c06a 1233Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>),
50d3c28b
GS
1234Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1235(E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1236and Richard Foley (E<lt>richard@rfi.netE<gt>).
d121ca8c
CS
1237
1238=head1 SEE ALSO
1239
bdcdfa19
JH
1240perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1241diff(1), patch(1), dbx(1), gdb(1)
d121ca8c
CS
1242
1243=head1 BUGS
1244
1245None known (guess what must have been used to report them?)
1246
1247=cut
1248
37fa004c
PP
1249!NO!SUBS!
1250
1251close OUT or die "Can't close $file: $!";
1252chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1253exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
8a5546a1 1254chdir $origdir;