4 use File::Basename qw(&basename &dirname);
6 use File::Spec::Functions;
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
13 # to ensure Configure will look for $Config{startperl}.
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.
20 $file = basename($0, '.PL');
21 $file .= '.com' if $^O eq 'VMS';
23 open OUT, ">$file" or die "Can't create $file: $!";
25 # extract patchlevel.h information
27 open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h")
28 or die "Can't open patchlevel.h: $!";
30 my $patchlevel_date = (stat PATCH_LEVEL)[9];
32 while (<PATCH_LEVEL>) {
33 last if $_ =~ /^\s*static\s+char.*?local_patches\[\]\s*=\s*{\s*$/;
37 while (<PATCH_LEVEL>) {
43 push @patches, $_ unless $_ eq 'NULL';
45 my $patch_desc = "'" . join("',\n '", @patches) . "'";
46 my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches;
48 close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!";
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.
55 print "Extracting $file (with variable substitutions)\n";
57 # In this section, perl variables will be expanded during extraction.
58 # You can use $Config{...} to use Configure variables.
60 my $extract_version = sprintf("v%vd", $^V);
62 print OUT <<"!GROK!THIS!";
64 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
65 if \$running_under_some_shell;
67 my \$config_tag1 = '$extract_version - $Config{cf_time}';
69 my \$patchlevel_date = $patchlevel_date;
70 my \$patch_tags = '$patch_tags';
76 # In the following, perl variables are not expanded during extraction.
78 print OUT <<'!NO!SUBS!';
81 use File::Spec; # keep perlbug Perl 5.005 compatible
88 eval "use Mail::Send;";
89 $::HaveSend = ($@ eq "");
90 eval "use Mail::Util;";
91 $::HaveUtil = ($@ eq "");
92 # use secure tempfiles wherever possible
93 eval "require File::Temp;";
94 $::HaveTemp = ($@ eq "");
99 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
100 # Changed in 1.07 to see more sendmail execs, and added pipe output.
101 # Changed in 1.08 to use correct address for sendmail.
102 # Changed in 1.09 to close the REP file before calling it up in the editor.
103 # Also removed some old comments duplicated elsewhere.
104 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
105 # temp filename generation.
106 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
107 # Changed in 1.12 to check for editor errors, make save/send distinction
108 # clearer and add $ENV{REPLYTO}.
109 # Changed in 1.13 to hopefully make it more difficult to accidentally
111 # Changed in 1.14 to make the prompts a little more clear on providing
112 # helpful information. Also let file read fail gracefully.
113 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
114 # Also report selected environment variables.
115 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
116 # Changed in 1.17 Win32 support added. GSAR 97-04-12
117 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
118 # Changed in 1.19 '-ok' default not '-v'
119 # add local patch information
120 # warn on '-ok' if this is an old system; add '-okay'
121 # Changed in 1.20 Added patchlevel.h reading and version/config checks
122 # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
123 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
124 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
125 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
126 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
127 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
128 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
129 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
130 # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000
131 # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000
132 # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000
133 # Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000
134 # Changed in 1.33 Don't require -t STDOUT for -ok.
135 # Changed in 1.34 Added Message-Id RFOLEY 18-06-2002
136 # Changed in 1.35 Use File::Temp (patch from Solar Designer) NWCLARK 28-02-2004
138 # TODO: - Allow the user to re-name the file on mail failure, and
139 # make sure failure (transmission-wise) of Mail::Send is
143 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $messageid, $domain,
144 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
145 $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS, $msg, $body, $andcc, %REP, $ok,
148 my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
150 my $config_tag2 = "$perl_version - $Config{cf_time}";
154 if ($::opt_h) { Help(); exit; }
155 if ($::opt_d) { Dump(*STDOUT); exit; }
156 if (!-t STDIN && !($ok and not $::opt_n)) {
158 Please use perlbug interactively. If you want to
159 include a file, you can use the -f switch.
165 Edit() unless $usefile || ($ok and not $::opt_n);
171 sub ask_for_alternatives { # (category|severity)
177 'opts' => [qw(core docs install library utilities)], # patch, notabug
182 'opts' => [qw(critical high medium low wishlist none)], # zero
185 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
188 $alt = $alts{$name}{'ok'};
190 my @alts = @{$alts{$name}{'opts'}};
192 Please pick a \u$name from the following:
200 die "Invalid $name: aborting.\n";
202 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
205 if ($alt =~ /^\s*$/) {
206 $alt = $alts{$name}{'default'};
208 } while !((($alt) = grep(/^$alt/i, @alts)));
214 # -------- Setup --------
216 $Is_MSWin32 = $^O eq 'MSWin32';
217 $Is_VMS = $^O eq 'VMS';
218 $Is_Linux = lc($^O) eq 'linux';
219 $Is_OpenBSD = lc($^O) eq 'openbsd';
220 $Is_MacOS = $^O eq 'MacOS';
222 @ARGV = split m/\s+/,
223 MacPerl::Ask('Provide command-line args here (-h for help):')
224 if $Is_MacOS && $MacPerl::Version =~ /App/;
226 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
228 # This comment is needed to notify metaconfig that we are
229 # using the $perladmin, $cf_by, and $cf_time definitions.
231 # -------- Configuration ---------
234 $perlbug = 'perlbug@perl.org';
237 $testaddress = 'perlbug-test@perl.org';
240 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
242 # Users address, used in message and in Reply-To header
243 $from = $::opt_r || "";
245 # Include verbose configuration information
246 $verbose = $::opt_v || 0;
248 # Subject of bug-report message
249 $subject = $::opt_s || "";
252 $usefile = ($::opt_f || 0);
254 # File to send as report
255 $file = $::opt_f || "";
258 $outfile = $::opt_F || "";
261 $body = $::opt_b || "";
264 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
265 || ($Is_VMS && "edit/tpu")
266 || ($Is_MSWin32 && "notepad")
270 # Not OK - provide build failure template by finessing OK report
272 if (substr($::opt_n, 0, 2) eq 'ok' ) {
273 $::opt_o = substr($::opt_n, 1);
280 # OK - send "OK" report for build on this system
283 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
284 my $age = time - $patchlevel_date;
285 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
286 my $date = localtime $patchlevel_date;
288 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
289 are more than 60 days old. This Perl version was constructed on
290 $date. If you really want to report this, use
291 "perlbug -okay" or "perlbug -nokay".
295 # force these options
297 $::opt_S = 1; # don't prompt for send
298 $::opt_b = 1; # we have a body
299 $body = "Perl reported to build OK on this system.\n";
301 $::opt_C = 1; # don't send a copy to the local admin
302 $::opt_s = 1; # we have a subject line
303 $subject = ($::opt_n ? 'Not ' : '')
304 . "OK: perl $perl_version ${patch_tags}on"
305 ." $::Config{'archname'} $::Config{'osvers'} $subject";
313 # Possible administrator addresses, in order of confidence
314 # (Note that cf_email is not mentioned to metaconfig, since
315 # we don't really want it. We'll just take it if we have to.)
317 # This has to be after the $ok stuff above because of the way
318 # that $::opt_C is forced.
319 $cc = $::opt_C ? "" : (
320 $::opt_c || $::Config{'perladmin'}
321 || $::Config{'cf_email'} || $::Config{'cf_by'}
325 $domain = Mail::Util::maildomain();
326 } elsif ($Is_MSWin32) {
327 $domain = $ENV{'USERDOMAIN'};
329 require Sys::Hostname;
330 $domain = Sys::Hostname::hostname();
334 $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>";
337 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
338 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
339 : $Is_MacOS ? $ENV{'USER'}
340 : eval { getpwuid($<) }; # May be missing
342 $from = $::Config{'cf_email'}
343 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
344 ($me eq $::Config{'cf_by'});
348 # Explain what perlbug is
351 This program provides an easy way to create a message reporting a bug
352 in perl, and e-mail it to $address. It is *NOT* intended for
353 sending test messages or simply verifying that perl works, *NOR* is it
354 intended for reporting bugs in third-party perl modules. It is *ONLY*
355 a means of reporting verifiable problems with the core perl distribution,
356 and any solutions to such problems, to the people who maintain perl.
358 If you're just looking for help with perl, try posting to the Usenet
359 newsgroup comp.lang.perl.misc. If you're looking for help with using
360 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
364 # Prompt for subject of message, if needed
366 if (TrivialSubject($subject)) {
372 First of all, please provide a subject for the
373 message. It should be a concise description of
374 the bug or problem. "perl bug" or "perl problem"
375 is not a concise description.
386 } while (TrivialSubject($subject));
389 # Prompt for return address, if needed
391 # Try and guess return address
394 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
396 require Mac::InternetConfig;
397 $guess = $Mac::InternetConfig::InternetConfig{
398 Mac::InternetConfig::kICEmail()
403 # move $domain to where we can use it elsewhere
405 if ($Is_VMS && !$::Config{'d_socket'}) {
406 $guess = "$domain\:\:$me";
408 $guess = "$me\@$domain" if $domain;
416 Your e-mail address will be useful if you need to be contacted. If the
417 default shown is not your full internet e-mail address, please correct it.
422 So that you may be contacted if necessary, please enter
423 your full internet e-mail address here.
432 print "Your address [$guess]: ";
435 $from = $guess if $from eq '';
439 if ($from eq $cc or $me eq $cc) {
440 # Try not to copy ourselves
444 # Prompt for administrator address, unless an override was given
445 if( !$::opt_C and !$::opt_c ) {
447 A copy of this report can be sent to your local
448 perl administrator. If the address is wrong, please
449 correct it, or enter 'none' or 'yourself' to not send
452 print "Local perl administrator [$cc]: ";
453 my $entry = scalar <>;
458 $cc = '' if $me eq $cc;
462 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
463 $andcc = " and $cc" if $cc;
465 # Prompt for editor, if no override is given
467 unless ($::opt_e || $::opt_f || $::opt_b) {
469 Now you need to supply the bug report. Try to make
470 the report concise but descriptive. Include any
471 relevant detail. If you are reporting something
472 that does not work as you think it should, please
473 try to include example of both the actual
474 result, and what you expected.
476 Some information about your local
477 perl configuration will automatically be included
478 at the end of the report. If you are using any
479 unusual version of perl, please try and confirm
480 exactly which versions are relevant.
482 You will probably want to use an editor to enter
483 the report. If "$ed" is the editor you want
484 to use, then just press Enter, otherwise type in
485 the name of the editor you would like to use.
487 If you would like to use a prepared file, type
488 "file", and you will be asked for the filename.
490 print "Editor [$ed]: ";
491 my $entry =scalar <>;
495 if ($entry eq "file") {
497 } elsif ($entry ne "") {
502 # Prompt for category of bug
503 $category ||= ask_for_alternatives('category');
505 # Prompt for severity of bug
506 $severity ||= ask_for_alternatives('severity');
508 # Generate scratch file to edit report in
509 $filename = filename();
511 # Prompt for file to read report from, if needed
512 if ($usefile and !$file) {
515 What is the name of the file that contains your report?
518 my $entry = scalar <>;
523 No filename? I'll let you go back and choose an editor again.
528 unless (-f $entry and -r $entry) {
530 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
531 the file? If you don't want to send a file, just enter a blank line and you
532 can get back to the editor selection.
540 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
541 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
544 This is a $reptype report for perl from $from,
545 generated with the help of perlbug $Version running under perl $perl_version.
553 or die "Unable to read report file from `$file': $!\n";
557 close(F) or die "Error closing `$file': $!";
561 -----------------------------------------------------------------
562 [Please enter your report here]
566 [Please do not change anything below this line]
567 -----------------------------------------------------------------
571 close(REP) or die "Error closing report file: $!";
573 # read in the report template once so that
574 # we can track whether the user does any editing.
575 # yes, *all* whitespace is ignored.
576 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
581 close(REP) or die "Error closing report file `$filename': $!";
601 print OUT "This perlbug was built using Perl $config_tag1\n",
602 "It is being executed now by Perl $config_tag2.\n\n"
603 if $config_tag2 ne $config_tag1;
606 Site configuration information for perl $perl_version:
609 if ($::Config{cf_by} and $::Config{cf_time}) {
610 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
612 print OUT Config::myconfig;
615 print OUT join "\n ", "Locally applied patches:", @patches;
622 \@INC for perl $perl_version:
631 Environment for perl $perl_version:
634 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
635 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
636 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
639 for my $env (sort keys %env) {
641 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
645 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
647 foreach (sort keys %::Config) {
648 $value = $::Config{$_};
650 print OUT "$_='$value'\n";
657 if ($usefile || $body) {
659 Please make sure that the name of the editor you want to use is correct.
661 print "Editor [$ed]: ";
662 my $entry =scalar <>;
664 $ed = $entry unless $entry eq '';
669 $sts = system("$ed $filename") unless $Is_MacOS;
671 require ExtUtils::MakeMaker;
672 ExtUtils::MM_MacOS::launch_file($filename);
674 Press Enter when done.
680 The editor you chose (`$ed') could apparently not be run!
681 Did you mistype the name of your editor? If so, please
682 correct it here, otherwise just press Enter.
684 print "Editor [$ed]: ";
685 my $entry =scalar <>;
693 You may want to save your report to a file, so you can edit and mail it
699 return if ($ok and not $::opt_n) || $body;
700 # Check that we have a report that has some, eh, report in it.
703 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
704 # a strange way to check whether any significant editing
705 # have been done: check whether any new non-empty lines
706 # have been added. Yes, the below code ignores *any* space
710 $unseen++ if $_ ne '' and not exists $REP{$_};
713 while ($unseen == 0) {
715 I am sorry but it looks like you did not report anything.
717 print "Action (Retry Edit/Cancel) ";
718 my ($action) = scalar(<>);
719 if ($action =~ /^[re]/i) { # <R>etry <E>dit
721 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
728 1 while unlink($filename); # remove all versions under VMS
729 print "\nCancelling.\n";
734 # Report is done, prompt for further action
738 Now that you have completed your report, would you like to send
739 the message to $address$andcc, display the message on
740 the screen, re-edit it, display/change the subject,
741 or cancel without sending anything?
742 You may also save the message as a file to mail at another time.
745 print "Action (Send/Display/Edit/Subject/Save to File): ";
746 my $action = scalar <>;
749 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
750 my $file_save = $outfile || "perlbug.rep";
751 print "\n\nName of file to save message in [$file_save]: ";
752 my $file = scalar <>;
754 $file = $file_save if $file eq "";
756 unless (open(FILE, ">$file")) {
757 print "\nError opening $file: $!\n\n";
760 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
761 print FILE "To: $address\nSubject: $subject\n";
762 print FILE "Cc: $cc\n" if $cc;
763 print FILE "Reply-To: $from\n" if $from;
764 print FILE "Message-Id: $messageid\n" if $messageid;
766 while (<REP>) { print FILE }
767 close(REP) or die "Error closing report file `$filename': $!";
768 close(FILE) or die "Error closing $file: $!";
770 print "\nMessage saved in `$file'.\n";
772 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
773 # Display the message
774 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
775 while (<REP>) { print $_ }
776 close(REP) or die "Error closing report file `$filename': $!";
777 } elsif ($action =~ /^su/i) { # <Su>bject
778 print "Subject: $subject\n";
779 print "If the above subject is fine, just press Enter.\n";
780 print "If not, type in the new subject.\n";
782 my $reply = scalar <STDIN>;
785 unless (TrivialSubject($reply)) {
787 print "Subject: $subject\n";
790 } elsif ($action =~ /^se/i) { # <S>end
792 print "Are you certain you want to send this message?\n"
793 . 'Please type "yes" if you are: ';
794 my $reply = scalar <STDIN>;
796 if ($reply eq "yes") {
800 That wasn't a clear "yes", so I won't send your message. If you are sure
801 your message should be sent, type in "yes" (without the quotes) at the
805 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
808 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
810 } elsif ($action =~ /^s/i) {
812 I'm sorry, but I didn't understand that. Please type "send" or "save".
822 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
823 length($subject) < 4 ||
825 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
833 # Message has been accepted for transmission -- Send the message
835 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
839 # on linux certain mail implementations won't accept the subject
840 # as "~s subject" and thus the Subject header will be corrupted
841 # so don't use Mail::Send to be safe
842 if ($::HaveSend && !$Is_Linux && !$Is_OpenBSD) {
843 $msg = new Mail::Send Subject => $subject, To => $address;
844 $msg->cc($cc) if $cc;
845 $msg->add("Reply-To",$from) if $from;
848 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
849 while (<REP>) { print $fh $_ }
850 close(REP) or die "Error closing $filename: $!";
853 print "\nMessage sent.\n";
855 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
856 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
858 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
859 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
861 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
862 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
864 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
865 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
869 (leaving bug report in $filename): $sts
874 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
875 $sendmail = $_, last if -e $_;
877 if ($^O eq 'os2' and $sendmail eq "") {
878 my $path = $ENV{PATH};
880 my @path = split /$Config{'path_sep'}/, $path;
882 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
883 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
887 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
888 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
889 the perl package Mail::Send has not been installed, so I can't send your bug
890 report. We apologize for the inconvenience.
892 So you may attempt to find some way of sending your message, it has
893 been left in the file `$filename'.
895 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
897 print SENDMAIL "To: $address\n";
898 print SENDMAIL "Subject: $subject\n";
899 print SENDMAIL "Cc: $cc\n" if $cc;
900 print SENDMAIL "Reply-To: $from\n" if $from;
901 print SENDMAIL "Message-Id: $messageid\n" if $messageid;
902 print SENDMAIL "\n\n";
903 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
904 while (<REP>) { print SENDMAIL $_ }
905 close(REP) or die "Error closing $filename: $!";
907 if (close(SENDMAIL)) {
908 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
910 warn "\nSendmail returned status '", $? >> 8, "'\n";
913 1 while unlink($filename); # remove all versions under VMS
919 A program to help generate bug reports about perl5, and mail them.
920 It is designed to be used interactively. Normally no arguments will
924 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
925 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
926 $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
928 Simplest usage: run "$0", and follow the prompts.
932 -v Include Verbose configuration data in the report
933 -f File containing the body of the report. Use this to
934 quickly send a prepared message.
935 -F File to output the resulting mail message to, instead of mailing.
936 -S Send without asking for confirmation.
937 -a Address to send the report to. Defaults to `$address'.
938 -c Address to send copy of report to. Defaults to `$cc'.
939 -C Don't send copy to administrator.
940 -s Subject to include with the message. You will be prompted
941 if you don't supply one on the command line.
942 -b Body of the report. If not included on the command line, or
943 in a file with -f, you will get a chance to edit the message.
944 -r Your return address. The program will ask you to confirm
945 this if you don't give it here.
947 -t Test mode. The target address defaults to `$testaddress'.
948 -d Data mode. This prints out your configuration data, without mailing
949 anything. You can use this with -v to get more complete data.
950 -A Don't send a bug received acknowledgement to the return address.
951 -ok Report successful build on this system to perl porters
952 (use alone or with -v). Only use -ok if *everything* was ok:
953 if there were *any* problems at all, use -nok.
954 -okay As -ok but allow report from old builds.
955 -nok Report unsuccessful build on this system to perl porters
956 (use alone or with -v). You must describe what went wrong
957 in the body of the report which you will be asked to edit.
958 -nokay As -nok but allow report from old builds.
959 -h Print this help message.
966 # Good. Use a secure temp file
967 my ($fh, $filename) = File::Temp::tempfile(UNLINK => 1);
971 # Bah. Fall back to doing things less securely.
972 my $dir = File::Spec->tmpdir();
973 $filename = "bugrep0$$";
974 $filename++ while -e File::Spec->catfile($dir, $filename);
975 $filename = File::Spec->catfile($dir, $filename);
980 my @paragraphs = split /\n{2,}/, "@_";
982 for (@paragraphs) { # implicit local $_
990 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
998 perlbug - how to submit bug reports on Perl
1002 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
1003 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
1004 S<[ B<-r> I<returnaddress> ]>
1005 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
1006 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
1008 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
1009 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
1013 A program to help generate bug reports about perl or the modules that
1014 come with it, and mail them.
1016 If you have found a bug with a non-standard port (one that was not part
1017 of the I<standard distribution>), a binary distribution, or a
1018 non-standard module (such as Tk, CGI, etc), then please see the
1019 documentation that came with that distribution to determine the correct
1020 place to report bugs.
1022 C<perlbug> is designed to be used interactively. Normally no arguments
1023 will be needed. Simply run it, and follow the prompts.
1025 If you are unable to run B<perlbug> (most likely because you don't have
1026 a working setup to send mail that perlbug recognizes), you may have to
1027 compose your own report, and email it to B<perlbug@perl.org>. You might
1028 find the B<-d> option useful to get summary information in that case.
1030 In any case, when reporting a bug, please make sure you have run through
1035 =item What version of Perl you are running?
1037 Type C<perl -v> at the command line to find out.
1039 =item Are you running the latest released version of perl?
1041 Look at http://www.perl.com/ to find out. If it is not the latest
1042 released version, get that one and see whether your bug has been
1043 fixed. Note that bug reports about old versions of Perl, especially
1044 those prior to the 5.0 release, are likely to fall upon deaf ears.
1045 You are on your own if you continue to use perl1 .. perl4.
1047 =item Are you sure what you have is a bug?
1049 A significant number of the bug reports we get turn out to be documented
1050 features in Perl. Make sure the behavior you are witnessing doesn't fall
1051 under that category, by glancing through the documentation that comes
1052 with Perl (we'll admit this is no mean task, given the sheer volume of
1053 it all, but at least have a look at the sections that I<seem> relevant).
1055 Be aware of the familiar traps that perl programmers of various hues
1056 fall into. See L<perltrap>.
1058 Check in L<perldiag> to see what any Perl error message(s) mean.
1059 If message isn't in perldiag, it probably isn't generated by Perl.
1060 Consult your operating system documentation instead.
1062 If you are on a non-UNIX platform check also L<perlport>, as some
1063 features may be unimplemented or work differently.
1065 Try to study the problem under the Perl debugger, if necessary.
1068 =item Do you have a proper test case?
1070 The easier it is to reproduce your bug, the more likely it will be
1071 fixed, because if no one can duplicate the problem, no one can fix it.
1072 A good test case has most of these attributes: fewest possible number
1073 of lines; few dependencies on external commands, modules, or
1074 libraries; runs on most platforms unimpeded; and is self-documenting.
1076 A good test case is almost always a good candidate to be on the perl
1077 test suite. If you have the time, consider making your test case so
1078 that it will readily fit into the standard test suite.
1080 Remember also to include the B<exact> error messages, if any.
1081 "Perl complained something" is not an exact error message.
1083 If you get a core dump (or equivalent), you may use a debugger
1084 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1085 report. NOTE: unless your Perl has been compiled with debug info
1086 (often B<-g>), the stack trace is likely to be somewhat hard to use
1087 because it will most probably contain only the function names and not
1088 their arguments. If possible, recompile your Perl with debug info and
1089 reproduce the dump and the stack trace.
1091 =item Can you describe the bug in plain English?
1093 The easier it is to understand a reproducible bug, the more likely it
1094 will be fixed. Anything you can provide by way of insight into the
1095 problem helps a great deal. In other words, try to analyze the
1096 problem (to the extent you can) and report your discoveries.
1098 =item Can you fix the bug yourself?
1100 A bug report which I<includes a patch to fix it> will almost
1101 definitely be fixed. Use the C<diff> program to generate your patches
1102 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1103 package, so you should be able to get it from any of the GNU software
1104 repositories). If you do submit a patch, the cool-dude counter at
1105 perlbug@perl.org will register you as a savior of the world. Your
1106 patch may be returned with requests for changes, or requests for more
1107 detailed explanations about your fix.
1109 Here are some clues for creating quality patches: Use the B<-c> or
1110 B<-u> switches to the diff program (to create a so-called context or
1111 unified diff). Make sure the patch is not reversed (the first
1112 argument to diff is typically the original file, the second argument
1113 your changed file). Make sure you test your patch by applying it with
1114 the C<patch> program before you send it on its way. Try to follow the
1115 same style as the code you are trying to patch. Make sure your patch
1116 really does work (C<make test>, if the thing you're patching supports
1119 =item Can you use C<perlbug> to submit the report?
1121 B<perlbug> will, amongst other things, ensure your report includes
1122 crucial information about your version of perl. If C<perlbug> is unable
1123 to mail your report after you have typed it in, you may have to compose
1124 the message yourself, add the output produced by C<perlbug -d> and email
1125 it to B<perlbug@perl.org>. If, for some reason, you cannot run
1126 C<perlbug> at all on your system, be sure to include the entire output
1127 produced by running C<perl -V> (note the uppercase V).
1129 Whether you use C<perlbug> or send the email manually, please make
1130 your Subject line informative. "a bug" not informative. Neither is
1131 "perl crashes" nor "HELP!!!". These don't help.
1132 A compact description of what's wrong is fine.
1136 Having done your bit, please be prepared to wait, to be told the bug
1137 is in your code, or even to get no reply at all. The Perl maintainers
1138 are busy folks, so if your problem is a small one or if it is difficult
1139 to understand or already known, they may not respond with a personal reply.
1140 If it is important to you that your bug be fixed, do monitor the
1141 C<Changes> file in any development releases since the time you submitted
1142 the bug, and encourage the maintainers with kind words (but never any
1143 flames!). Feel free to resend your bug report if the next released
1144 version of perl comes out and your bug is still present.
1152 Address to send the report to. Defaults to B<perlbug@perl.org>.
1156 Don't send a bug received acknowledgement to the reply address.
1157 Generally it is only a sensible to use this option if you are a
1158 perl maintainer actively watching perl porters for your message to
1163 Body of the report. If not included on the command line, or
1164 in a file with B<-f>, you will get a chance to edit the message.
1168 Don't send copy to administrator.
1172 Address to send copy of report to. Defaults to the address of the
1173 local perl administrator (recorded when perl was built).
1177 Data mode (the default if you redirect or pipe output). This prints out
1178 your configuration data, without mailing anything. You can use this
1179 with B<-v> to get more complete data.
1187 File containing the body of the report. Use this to quickly send a
1192 File to output the results to instead of sending as an email. Useful
1193 particularly when running perlbug on a machine with no direct internet
1198 Prints a brief summary of the options.
1202 Report successful build on this system to perl porters. Forces B<-S>
1203 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1204 prompts for a return address if it cannot guess it (for use with
1205 B<make>). Honors return address specified with B<-r>. You can use this
1206 with B<-v> to get more complete data. Only makes a report if this
1207 system is less than 60 days old.
1211 As B<-ok> except it will report on older systems.
1215 Report unsuccessful build on this system. Forces B<-C>. Forces and
1216 supplies a value for B<-s>, then requires you to edit the report
1217 and say what went wrong. Alternatively, a prepared report may be
1218 supplied using B<-f>. Only prompts for a return address if it
1219 cannot guess it (for use with B<make>). Honors return address
1220 specified with B<-r>. You can use this with B<-v> to get more
1221 complete data. Only makes a report if this system is less than 60
1226 As B<-nok> except it will report on older systems.
1230 Your return address. The program will ask you to confirm its default
1231 if you don't use this option.
1235 Send without asking for confirmation.
1239 Subject to include with the message. You will be prompted if you don't
1240 supply one on the command line.
1244 Test mode. The target address defaults to B<perlbug-test@perl.org>.
1248 Include verbose configuration data in the report.
1254 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1255 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1256 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1257 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1258 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1259 Hugo van der Sanden (E<lt>hv@crypt.org<gt>),
1260 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1261 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1262 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1266 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1267 diff(1), patch(1), dbx(1), gdb(1)
1271 None known (guess what must have been used to report them?)
1277 close OUT or die "Can't close $file: $!";
1278 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1279 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';