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;
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 "");
96 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
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.
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
102 # temp filename generation.
103 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
104 # Changed in 1.12 to check for editor errors, make save/send distinction
105 # clearer and add $ENV{REPLYTO}.
106 # Changed in 1.13 to hopefully make it more difficult to accidentally
108 # Changed in 1.14 to make the prompts a little more clear on providing
109 # helpful information. Also let file read fail gracefully.
110 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
111 # Also report selected environment variables.
112 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
113 # Changed in 1.17 Win32 support added. GSAR 97-04-12
114 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
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'
118 # Changed in 1.20 Added patchlevel.h reading and version/config checks
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
121 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
122 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
123 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
124 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
125 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
126 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
127 # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000
129 # TODO: - Allow the user to re-name the file on mail failure, and
130 # make sure failure (transmission-wise) of Mail::Send is
134 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
135 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
136 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
138 my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
140 my $config_tag2 = "$perl_version - $Config{cf_time}";
144 if ($::opt_h) { Help(); exit; }
145 if ($::opt_d) { Dump(*STDOUT); exit; }
146 if (!-t STDIN && !($ok and not $::opt_n)) {
148 Please use perlbug interactively. If you want to
149 include a file, you can use the -f switch.
153 if (!-t STDOUT && !$outfile) { Dump(*STDOUT); exit; }
156 Edit() unless $usefile || ($ok and not $::opt_n);
162 sub ask_for_alternatives { # (category|severity)
168 'opts' => [qw(core docs install library utilities)], # patch, notabug
173 'opts' => [qw(critical high medium low wishlist none)], # zero
176 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
179 $alt = $alts{$name}{'ok'};
181 my @alts = @{$alts{$name}{'opts'}};
183 Please pick a \u$name from the following:
191 die "Invalid $name: aborting.\n";
193 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
196 if ($alt =~ /^\s*$/) {
197 $alt = $alts{$name}{'default'};
199 } while !((($alt) = grep(/^$alt/i, @alts)));
205 # -------- Setup --------
207 $Is_MSWin32 = $^O eq 'MSWin32';
208 $Is_VMS = $^O eq 'VMS';
209 $Is_MacOS = $^O eq 'MacOS';
211 @ARGV = split m/\s+/,
212 MacPerl::Ask('Provide command-line args here (-h for help):')
213 if $Is_MacOS && $MacPerl::Version =~ /App/;
215 if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
217 # This comment is needed to notify metaconfig that we are
218 # using the $perladmin, $cf_by, and $cf_time definitions.
220 # -------- Configuration ---------
223 $perlbug = 'perlbug@perl.com';
226 $testaddress = 'perlbug-test@perl.com';
229 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
231 # Users address, used in message and in Reply-To header
232 $from = $::opt_r || "";
234 # Include verbose configuration information
235 $verbose = $::opt_v || 0;
237 # Subject of bug-report message
238 $subject = $::opt_s || "";
241 $usefile = ($::opt_f || 0);
243 # File to send as report
244 $file = $::opt_f || "";
247 $outfile = $::opt_F || "";
250 $body = $::opt_b || "";
253 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
254 || ($Is_VMS && "edit/tpu")
255 || ($Is_MSWin32 && "notepad")
259 # Not OK - provide build failure template by finessing OK report
261 if (substr($::opt_n, 0, 2) eq 'ok' ) {
262 $::opt_o = substr($::opt_n, 1);
269 # OK - send "OK" report for build on this system
272 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
273 my $age = time - $patchlevel_date;
274 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
275 my $date = localtime $patchlevel_date;
277 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
278 are more than 60 days old. This Perl version was constructed on
279 $date. If you really want to report this, use
280 "perlbug -okay" or "perlbug -nokay".
284 # force these options
286 $::opt_S = 1; # don't prompt for send
287 $::opt_b = 1; # we have a body
288 $body = "Perl reported to build OK on this system.\n";
290 $::opt_C = 1; # don't send a copy to the local admin
291 $::opt_s = 1; # we have a subject line
292 $subject = ($::opt_n ? 'Not ' : '')
293 . "OK: perl $perl_version ${patch_tags}on"
294 ." $::Config{'archname'} $::Config{'osvers'} $subject";
302 # Possible administrator addresses, in order of confidence
303 # (Note that cf_email is not mentioned to metaconfig, since
304 # we don't really want it. We'll just take it if we have to.)
306 # This has to be after the $ok stuff above because of the way
307 # that $::opt_C is forced.
308 $cc = $::opt_C ? "" : (
309 $::opt_c || $::Config{'perladmin'}
310 || $::Config{'cf_email'} || $::Config{'cf_by'}
314 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
315 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
316 : $Is_MacOS ? $ENV{'USER'}
317 : eval { getpwuid($<) }; # May be missing
319 $from = $::Config{'cf_email'}
320 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
321 ($me eq $::Config{'cf_by'});
325 # Explain what perlbug is
328 This program provides an easy way to create a message reporting a bug
329 in perl, and e-mail it to $address. It is *NOT* intended for
330 sending test messages or simply verifying that perl works, *NOR* is it
331 intended for reporting bugs in third-party perl modules. It is *ONLY*
332 a means of reporting verifiable problems with the core perl distribution,
333 and any solutions to such problems, to the people who maintain perl.
335 If you're just looking for help with perl, try posting to the Usenet
336 newsgroup comp.lang.perl.misc. If you're looking for help with using
337 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
341 # Prompt for subject of message, if needed
344 First of all, please provide a subject for the
345 message. It should be a concise description of
346 the bug or problem. "perl bug" or "perl problem"
347 is not a concise description.
353 while ($subject !~ /\S/) {
354 print "\nPlease enter a subject: ";
363 # Prompt for return address, if needed
365 # Try and guess return address
368 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
370 require Mac::InternetConfig;
371 $guess = $Mac::InternetConfig::InternetConfig{
372 Mac::InternetConfig::kICEmail()
379 $domain = Mail::Util::maildomain();
380 } elsif ($Is_MSWin32) {
381 $domain = $ENV{'USERDOMAIN'};
383 require Sys::Hostname;
384 $domain = Sys::Hostname::hostname();
387 if ($Is_VMS && !$::Config{'d_socket'}) {
388 $guess = "$domain\:\:$me";
390 $guess = "$me\@$domain" if $domain;
398 Your e-mail address will be useful if you need to be contacted. If the
399 default shown is not your full internet e-mail address, please correct it.
404 So that you may be contacted if necessary, please enter
405 your full internet e-mail address here.
414 print "Your address [$guess]: ";
417 $from = $guess if $from eq '';
421 if ($from eq $cc or $me eq $cc) {
422 # Try not to copy ourselves
426 # Prompt for administrator address, unless an override was given
427 if( !$::opt_C and !$::opt_c ) {
429 A copy of this report can be sent to your local
430 perl administrator. If the address is wrong, please
431 correct it, or enter 'none' or 'yourself' to not send
434 print "Local perl administrator [$cc]: ";
435 my $entry = scalar <>;
440 $cc = '' if $me eq $cc;
444 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
445 $andcc = " and $cc" if $cc;
447 # Prompt for editor, if no override is given
449 unless ($::opt_e || $::opt_f || $::opt_b) {
451 Now you need to supply the bug report. Try to make
452 the report concise but descriptive. Include any
453 relevant detail. If you are reporting something
454 that does not work as you think it should, please
455 try to include example of both the actual
456 result, and what you expected.
458 Some information about your local
459 perl configuration will automatically be included
460 at the end of the report. If you are using any
461 unusual version of perl, please try and confirm
462 exactly which versions are relevant.
464 You will probably want to use an editor to enter
465 the report. If "$ed" is the editor you want
466 to use, then just press Enter, otherwise type in
467 the name of the editor you would like to use.
469 If you would like to use a prepared file, type
470 "file", and you will be asked for the filename.
472 print "Editor [$ed]: ";
473 my $entry =scalar <>;
477 if ($entry eq "file") {
479 } elsif ($entry ne "") {
484 # Prompt for category of bug
485 $category ||= ask_for_alternatives('category');
487 # Prompt for severity of bug
488 $severity ||= ask_for_alternatives('severity');
490 # Generate scratch file to edit report in
491 $filename = filename();
493 # Prompt for file to read report from, if needed
494 if ($usefile and !$file) {
497 What is the name of the file that contains your report?
500 my $entry = scalar <>;
505 No filename? I'll let you go back and choose an editor again.
510 unless (-f $entry and -r $entry) {
512 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
513 the file? If you don't want to send a file, just enter a blank line and you
514 can get back to the editor selection.
522 open(REP,">$filename");
523 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
526 This is a $reptype report for perl from $from,
527 generated with the help of perlbug $Version running under perl $perl_version.
535 or die "Unable to read report file from `$file': $!\n";
543 -----------------------------------------------------------------
544 [Please enter your report here]
548 [Please do not change anything below this line]
549 -----------------------------------------------------------------
555 # read in the report template once so that
556 # we can track whether the user does any editing.
557 # yes, *all* whitespace is ignored.
558 open(REP, "<$filename");
576 print OUT "This perlbug was built using Perl $config_tag1\n",
577 "It is being executed now by Perl $config_tag2.\n\n"
578 if $config_tag2 ne $config_tag1;
581 Site configuration information for perl $perl_version:
584 if ($::Config{cf_by} and $::Config{cf_time}) {
585 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
587 print OUT Config::myconfig;
590 print OUT join "\n ", "Locally applied patches:", @patches;
597 \@INC for perl $perl_version:
606 Environment for perl $perl_version:
609 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
610 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
611 push @env, grep /^(?:PERL|LC_|LANG)/, keys %ENV;
614 for my $env (sort keys %env) {
616 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
620 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
622 foreach (sort keys %::Config) {
623 $value = $::Config{$_};
625 print OUT "$_='$value'\n";
632 if ($usefile || $body) {
634 Please make sure that the name of the editor you want to use is correct.
636 print "Editor [$ed]: ";
637 my $entry =scalar <>;
639 $ed = $entry unless $entry eq '';
643 my $sts = system("$ed $filename") unless $Is_MacOS;
645 require ExtUtils::MakeMaker;
646 ExtUtils::MM_MacOS::launch_file($filename);
648 Press Enter when done.
654 The editor you chose (`$ed') could apparently not be run!
655 Did you mistype the name of your editor? If so, please
656 correct it here, otherwise just press Enter.
658 print "Editor [$ed]: ";
659 my $entry =scalar <>;
667 You may want to save your report to a file, so you can edit and mail it
673 return if ($ok and not $::opt_n) || $body;
674 # Check that we have a report that has some, eh, report in it.
677 open(REP, "<$filename");
678 # a strange way to check whether any significant editing
679 # have been done: check whether any new non-empty lines
680 # have been added. Yes, the below code ignores *any* space
684 $unseen++ if $_ ne '' and not exists $REP{$_};
687 while ($unseen == 0) {
689 I am sorry but it looks like you did not report anything.
691 print "Action (Retry Edit/Cancel) ";
692 my ($action) = scalar(<>);
693 if ($action =~ /^[re]/i) { # <R>etry <E>dit
695 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
702 1 while unlink($filename); # remove all versions under VMS
703 print "\nCancelling.\n";
708 # Report is done, prompt for further action
712 Now that you have completed your report, would you like to send
713 the message to $address$andcc, display the message on
714 the screen, re-edit it, or cancel without sending anything?
715 You may also save the message as a file to mail at another time.
718 print "Action (Send/Display/Edit/Cancel/Save to File): ";
719 my $action = scalar <>;
722 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
723 print "\n\nName of file to save message in [perlbug.rep]: ";
724 my $file = scalar <>;
726 $file = "perlbug.rep" if $file eq "";
728 unless (open(FILE, ">$file")) {
729 print "\nError opening $file: $!\n\n";
732 open(REP, "<$filename");
733 print FILE "To: $address\nSubject: $subject\n";
734 print FILE "Cc: $cc\n" if $cc;
735 print FILE "Reply-To: $from\n" if $from;
737 while (<REP>) { print FILE }
741 print "\nMessage saved in `$file'.\n";
743 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
744 # Display the message
745 open(REP, "<$filename");
746 while (<REP>) { print $_ }
748 } elsif ($action =~ /^se/i) { # <S>end
750 print "Are you certain you want to send this message?\n"
751 . 'Please type "yes" if you are: ';
752 my $reply = scalar <STDIN>;
754 if ($reply eq "yes") {
758 That wasn't a clear "yes", so I won't send your message. If you are sure
759 your message should be sent, type in "yes" (without the quotes) at the
763 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
766 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
768 } elsif ($action =~ /^s/) {
770 I'm sorry, but I didn't understand that. Please type "send" or "save".
778 # Message has been accepted for transmission -- Send the message
780 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
784 $msg = new Mail::Send Subject => $subject, To => $address;
785 $msg->cc($cc) if $cc;
786 $msg->add("Reply-To",$from) if $from;
789 open(REP, "<$filename");
790 while (<REP>) { print $fh $_ }
794 print "\nMessage sent.\n";
796 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
797 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
799 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
800 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
802 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
803 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
805 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
806 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
810 (leaving bug report in $filename): $sts
815 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
816 $sendmail = $_, last if -e $_;
818 if ($^O eq 'os2' and $sendmail eq "") {
819 my $path = $ENV{PATH};
821 my @path = split /$Config{'path_sep'}/, $path;
823 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
824 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
828 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
829 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
830 the perl package Mail::Send has not been installed, so I can't send your bug
831 report. We apologize for the inconvenience.
833 So you may attempt to find some way of sending your message, it has
834 been left in the file `$filename'.
836 open(SENDMAIL, "|$sendmail -t") || die "'|$sendmail -t' failed: $!";
838 print SENDMAIL "To: $address\n";
839 print SENDMAIL "Subject: $subject\n";
840 print SENDMAIL "Cc: $cc\n" if $cc;
841 print SENDMAIL "Reply-To: $from\n" if $from;
842 print SENDMAIL "\n\n";
843 open(REP, "<$filename");
844 while (<REP>) { print SENDMAIL $_ }
847 if (close(SENDMAIL)) {
848 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
850 warn "\nSendmail returned status '", $? >> 8, "'\n";
853 1 while unlink($filename); # remove all versions under VMS
859 A program to help generate bug reports about perl5, and mail them.
860 It is designed to be used interactively. Normally no arguments will
864 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
865 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
866 $0 [-v] [-r returnaddress] [-ok | -okay | -nok | -nokay]
868 Simplest usage: run "$0", and follow the prompts.
872 -v Include Verbose configuration data in the report
873 -f File containing the body of the report. Use this to
874 quickly send a prepared message.
875 -F File to output the resulting mail message to, instead of mailing.
876 -S Send without asking for confirmation.
877 -a Address to send the report to. Defaults to `$address'.
878 -c Address to send copy of report to. Defaults to `$cc'.
879 -C Don't send copy to administrator.
880 -s Subject to include with the message. You will be prompted
881 if you don't supply one on the command line.
882 -b Body of the report. If not included on the command line, or
883 in a file with -f, you will get a chance to edit the message.
884 -r Your return address. The program will ask you to confirm
885 this if you don't give it here.
887 -t Test mode. The target address defaults to `$testaddress'.
888 -d Data mode (the default if you redirect or pipe output.)
889 This prints out your configuration data, without mailing
890 anything. You can use this with -v to get more complete data.
891 -ok Report successful build on this system to perl porters
892 (use alone or with -v). Only use -ok if *everything* was ok:
893 if there were *any* problems at all, use -nok.
894 -okay As -ok but allow report from old builds.
895 -nok Report unsuccessful build on this system to perl porters
896 (use alone or with -v). You must describe what went wrong
897 in the body of the report which you will be asked to edit.
898 -nokay As -nok but allow report from old builds.
899 -h Print this help message.
905 my $dir = $Is_VMS ? 'sys$scratch:'
906 : ($Is_MSWin32 && $ENV{'TEMP'}) ? $ENV{'TEMP'}
907 : $Is_MacOS ? $ENV{'TMPDIR'}
909 $filename = "bugrep0$$";
910 # $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
911 $filename++ while -e File::Spec->catfile($dir, $filename);
912 $filename = File::Spec->catfile($dir, $filename);
916 my @paragraphs = split /\n{2,}/, "@_";
918 for (@paragraphs) { # implicit local $_
926 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
934 perlbug - how to submit bug reports on Perl
938 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
939 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
940 S<[ B<-r> I<returnaddress> ]>
941 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
942 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]>
944 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
945 S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
949 A program to help generate bug reports about perl or the modules that
950 come with it, and mail them.
952 If you have found a bug with a non-standard port (one that was not part
953 of the I<standard distribution>), a binary distribution, or a
954 non-standard module (such as Tk, CGI, etc), then please see the
955 documentation that came with that distribution to determine the correct
956 place to report bugs.
958 C<perlbug> is designed to be used interactively. Normally no arguments
959 will be needed. Simply run it, and follow the prompts.
961 If you are unable to run B<perlbug> (most likely because you don't have
962 a working setup to send mail that perlbug recognizes), you may have to
963 compose your own report, and email it to B<perlbug@perl.com>. You might
964 find the B<-d> option useful to get summary information in that case.
966 In any case, when reporting a bug, please make sure you have run through
971 =item What version of Perl you are running?
973 Type C<perl -v> at the command line to find out.
975 =item Are you running the latest released version of perl?
977 Look at http://www.perl.com/ to find out. If it is not the latest
978 released version, get that one and see whether your bug has been
979 fixed. Note that bug reports about old versions of Perl, especially
980 those prior to the 5.0 release, are likely to fall upon deaf ears.
981 You are on your own if you continue to use perl1 .. perl4.
983 =item Are you sure what you have is a bug?
985 A significant number of the bug reports we get turn out to be documented
986 features in Perl. Make sure the behavior you are witnessing doesn't fall
987 under that category, by glancing through the documentation that comes
988 with Perl (we'll admit this is no mean task, given the sheer volume of
989 it all, but at least have a look at the sections that I<seem> relevant).
991 Be aware of the familiar traps that perl programmers of various hues
992 fall into. See L<perltrap>.
994 Check in L<perldiag> to see what any Perl error message(s) mean.
995 If message isn't in perldiag, it probably isn't generated by Perl.
996 Consult your operating system documentation instead.
998 If you are on a non-UNIX platform check also L<perlport>, as some
999 features may be unimplemented or work differently.
1001 Try to study the problem under the Perl debugger, if necessary.
1004 =item Do you have a proper test case?
1006 The easier it is to reproduce your bug, the more likely it will be
1007 fixed, because if no one can duplicate the problem, no one can fix it.
1008 A good test case has most of these attributes: fewest possible number
1009 of lines; few dependencies on external commands, modules, or
1010 libraries; runs on most platforms unimpeded; and is self-documenting.
1012 A good test case is almost always a good candidate to be on the perl
1013 test suite. If you have the time, consider making your test case so
1014 that it will readily fit into the standard test suite.
1016 Remember also to include the B<exact> error messages, if any.
1017 "Perl complained something" is not an exact error message.
1019 If you get a core dump (or equivalent), you may use a debugger
1020 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1021 report. NOTE: unless your Perl has been compiled with debug info
1022 (often B<-g>), the stack trace is likely to be somewhat hard to use
1023 because it will most probably contain only the function names and not
1024 their arguments. If possible, recompile your Perl with debug info and
1025 reproduce the dump and the stack trace.
1027 =item Can you describe the bug in plain English?
1029 The easier it is to understand a reproducible bug, the more likely it
1030 will be fixed. Anything you can provide by way of insight into the
1031 problem helps a great deal. In other words, try to analyze the
1032 problem (to the extent you can) and report your discoveries.
1034 =item Can you fix the bug yourself?
1036 A bug report which I<includes a patch to fix it> will almost
1037 definitely be fixed. Use the C<diff> program to generate your patches
1038 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1039 package, so you should be able to get it from any of the GNU software
1040 repositories). If you do submit a patch, the cool-dude counter at
1041 perlbug@perl.com will register you as a savior of the world. Your
1042 patch may be returned with requests for changes, or requests for more
1043 detailed explanations about your fix.
1045 Here are some clues for creating quality patches: Use the B<-c> or
1046 B<-u> switches to the diff program (to create a so-called context or
1047 unified diff). Make sure the patch is not reversed (the first
1048 argument to diff is typically the original file, the second argument
1049 your changed file). Make sure you test your patch by applying it with
1050 the C<patch> program before you send it on its way. Try to follow the
1051 same style as the code you are trying to patch. Make sure your patch
1052 really does work (C<make test>, if the thing you're patching supports
1055 =item Can you use C<perlbug> to submit the report?
1057 B<perlbug> will, amongst other things, ensure your report includes
1058 crucial information about your version of perl. If C<perlbug> is unable
1059 to mail your report after you have typed it in, you may have to compose
1060 the message yourself, add the output produced by C<perlbug -d> and email
1061 it to B<perlbug@perl.com>. If, for some reason, you cannot run
1062 C<perlbug> at all on your system, be sure to include the entire output
1063 produced by running C<perl -V> (note the uppercase V).
1065 Whether you use C<perlbug> or send the email manually, please make
1066 your Subject line informative. "a bug" not informative. Neither is
1067 "perl crashes" nor "HELP!!!". These don't help.
1068 A compact description of what's wrong is fine.
1072 Having done your bit, please be prepared to wait, to be told the bug
1073 is in your code, or even to get no reply at all. The Perl maintainers
1074 are busy folks, so if your problem is a small one or if it is difficult
1075 to understand or already known, they may not respond with a personal reply.
1076 If it is important to you that your bug be fixed, do monitor the
1077 C<Changes> file in any development releases since the time you submitted
1078 the bug, and encourage the maintainers with kind words (but never any
1079 flames!). Feel free to resend your bug report if the next released
1080 version of perl comes out and your bug is still present.
1088 Address to send the report to. Defaults to `perlbug@perl.com'.
1092 Body of the report. If not included on the command line, or
1093 in a file with B<-f>, you will get a chance to edit the message.
1097 Don't send copy to administrator.
1101 Address to send copy of report to. Defaults to the address of the
1102 local perl administrator (recorded when perl was built).
1106 Data mode (the default if you redirect or pipe output). This prints out
1107 your configuration data, without mailing anything. You can use this
1108 with B<-v> to get more complete data.
1116 File containing the body of the report. Use this to quickly send a
1121 File to output the results to instead of sending as an email. Useful
1122 particularly when running perlbug on a machine with no direct internet
1127 Prints a brief summary of the options.
1131 Report successful build on this system to perl porters. Forces B<-S>
1132 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1133 prompts for a return address if it cannot guess it (for use with
1134 B<make>). Honors return address specified with B<-r>. You can use this
1135 with B<-v> to get more complete data. Only makes a report if this
1136 system is less than 60 days old.
1140 As B<-ok> except it will report on older systems.
1144 Report unsuccessful build on this system. Forces B<-C>. Forces and
1145 supplies a value for B<-s>, then requires you to edit the report
1146 and say what went wrong. Alternatively, a prepared report may be
1147 supplied using B<-f>. Only prompts for a return address if it
1148 cannot guess it (for use with B<make>). Honors return address
1149 specified with B<-r>. You can use this with B<-v> to get more
1150 complete data. Only makes a report if this system is less than 60
1155 As B<-nok> except it will report on older systems.
1159 Your return address. The program will ask you to confirm its default
1160 if you don't use this option.
1164 Send without asking for confirmation.
1168 Subject to include with the message. You will be prompted if you don't
1169 supply one on the command line.
1173 Test mode. The target address defaults to `perlbug-test@perl.com'.
1177 Include verbose configuration data in the report.
1183 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1184 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1185 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1186 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1187 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1188 Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>),
1189 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1190 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1191 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1195 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1196 diff(1), patch(1), dbx(1), gdb(1)
1200 None known (guess what must have been used to report them?)
1206 close OUT or die "Can't close $file: $!";
1207 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1208 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';