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 "");
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
128 # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000
129 # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000
130 # Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000
131 # Changed in 1.33 Don't require -t STDOUT for -ok.
132 # Changed in 1.34 Added Message-Id RFOLEY 18-06-2002
134 # TODO: - Allow the user to re-name the file on mail failure, and
135 # make sure failure (transmission-wise) of Mail::Send is
139 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $messageid, $domain,
140 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
141 $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
143 my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
145 my $config_tag2 = "$perl_version - $Config{cf_time}";
149 if ($::opt_h) { Help(); exit; }
150 if ($::opt_d) { Dump(*STDOUT); exit; }
151 if (!-t STDIN && !($ok and not $::opt_n)) {
153 Please use perlbug interactively. If you want to
154 include a file, you can use the -f switch.
160 Edit() unless $usefile || ($ok and not $::opt_n);
166 sub ask_for_alternatives { # (category|severity)
172 'opts' => [qw(core docs install library utilities)], # patch, notabug
177 'opts' => [qw(critical high medium low wishlist none)], # zero
180 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
183 $alt = $alts{$name}{'ok'};
185 my @alts = @{$alts{$name}{'opts'}};
187 Please pick a \u$name from the following:
195 die "Invalid $name: aborting.\n";
197 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
200 if ($alt =~ /^\s*$/) {
201 $alt = $alts{$name}{'default'};
203 } while !((($alt) = grep(/^$alt/i, @alts)));
209 # -------- Setup --------
211 $Is_MSWin32 = $^O eq 'MSWin32';
212 $Is_VMS = $^O eq 'VMS';
213 $Is_Linux = lc($^O) eq 'linux';
214 $Is_MacOS = $^O eq 'MacOS';
216 @ARGV = split m/\s+/,
217 MacPerl::Ask('Provide command-line args here (-h for help):')
218 if $Is_MacOS && $MacPerl::Version =~ /App/;
220 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
222 # This comment is needed to notify metaconfig that we are
223 # using the $perladmin, $cf_by, and $cf_time definitions.
225 # -------- Configuration ---------
228 $perlbug = 'perlbug@perl.org';
231 $testaddress = 'perlbug-test@perl.org';
234 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
236 # Users address, used in message and in Reply-To header
237 $from = $::opt_r || "";
239 # Include verbose configuration information
240 $verbose = $::opt_v || 0;
242 # Subject of bug-report message
243 $subject = $::opt_s || "";
246 $usefile = ($::opt_f || 0);
248 # File to send as report
249 $file = $::opt_f || "";
252 $outfile = $::opt_F || "";
255 $body = $::opt_b || "";
258 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
259 || ($Is_VMS && "edit/tpu")
260 || ($Is_MSWin32 && "notepad")
264 # Not OK - provide build failure template by finessing OK report
266 if (substr($::opt_n, 0, 2) eq 'ok' ) {
267 $::opt_o = substr($::opt_n, 1);
274 # OK - send "OK" report for build on this system
277 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
278 my $age = time - $patchlevel_date;
279 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
280 my $date = localtime $patchlevel_date;
282 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
283 are more than 60 days old. This Perl version was constructed on
284 $date. If you really want to report this, use
285 "perlbug -okay" or "perlbug -nokay".
289 # force these options
291 $::opt_S = 1; # don't prompt for send
292 $::opt_b = 1; # we have a body
293 $body = "Perl reported to build OK on this system.\n";
295 $::opt_C = 1; # don't send a copy to the local admin
296 $::opt_s = 1; # we have a subject line
297 $subject = ($::opt_n ? 'Not ' : '')
298 . "OK: perl $perl_version ${patch_tags}on"
299 ." $::Config{'archname'} $::Config{'osvers'} $subject";
307 # Possible administrator addresses, in order of confidence
308 # (Note that cf_email is not mentioned to metaconfig, since
309 # we don't really want it. We'll just take it if we have to.)
311 # This has to be after the $ok stuff above because of the way
312 # that $::opt_C is forced.
313 $cc = $::opt_C ? "" : (
314 $::opt_c || $::Config{'perladmin'}
315 || $::Config{'cf_email'} || $::Config{'cf_by'}
319 $domain = Mail::Util::maildomain();
320 } elsif ($Is_MSWin32) {
321 $domain = $ENV{'USERDOMAIN'};
323 require Sys::Hostname;
324 $domain = Sys::Hostname::hostname();
328 $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>";
331 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
332 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
333 : $Is_MacOS ? $ENV{'USER'}
334 : eval { getpwuid($<) }; # May be missing
336 $from = $::Config{'cf_email'}
337 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
338 ($me eq $::Config{'cf_by'});
342 # Explain what perlbug is
345 This program provides an easy way to create a message reporting a bug
346 in perl, and e-mail it to $address. It is *NOT* intended for
347 sending test messages or simply verifying that perl works, *NOR* is it
348 intended for reporting bugs in third-party perl modules. It is *ONLY*
349 a means of reporting verifiable problems with the core perl distribution,
350 and any solutions to such problems, to the people who maintain perl.
352 If you're just looking for help with perl, try posting to the Usenet
353 newsgroup comp.lang.perl.misc. If you're looking for help with using
354 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
358 # Prompt for subject of message, if needed
360 if (TrivialSubject($subject)) {
366 First of all, please provide a subject for the
367 message. It should be a concise description of
368 the bug or problem. "perl bug" or "perl problem"
369 is not a concise description.
380 } while (TrivialSubject($subject));
383 # Prompt for return address, if needed
385 # Try and guess return address
388 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
390 require Mac::InternetConfig;
391 $guess = $Mac::InternetConfig::InternetConfig{
392 Mac::InternetConfig::kICEmail()
397 # move $domain to where we can use it elsewhere
399 if ($Is_VMS && !$::Config{'d_socket'}) {
400 $guess = "$domain\:\:$me";
402 $guess = "$me\@$domain" if $domain;
410 Your e-mail address will be useful if you need to be contacted. If the
411 default shown is not your full internet e-mail address, please correct it.
416 So that you may be contacted if necessary, please enter
417 your full internet e-mail address here.
426 print "Your address [$guess]: ";
429 $from = $guess if $from eq '';
433 if ($from eq $cc or $me eq $cc) {
434 # Try not to copy ourselves
438 # Prompt for administrator address, unless an override was given
439 if( !$::opt_C and !$::opt_c ) {
441 A copy of this report can be sent to your local
442 perl administrator. If the address is wrong, please
443 correct it, or enter 'none' or 'yourself' to not send
446 print "Local perl administrator [$cc]: ";
447 my $entry = scalar <>;
452 $cc = '' if $me eq $cc;
456 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
457 $andcc = " and $cc" if $cc;
459 # Prompt for editor, if no override is given
461 unless ($::opt_e || $::opt_f || $::opt_b) {
463 Now you need to supply the bug report. Try to make
464 the report concise but descriptive. Include any
465 relevant detail. If you are reporting something
466 that does not work as you think it should, please
467 try to include example of both the actual
468 result, and what you expected.
470 Some information about your local
471 perl configuration will automatically be included
472 at the end of the report. If you are using any
473 unusual version of perl, please try and confirm
474 exactly which versions are relevant.
476 You will probably want to use an editor to enter
477 the report. If "$ed" is the editor you want
478 to use, then just press Enter, otherwise type in
479 the name of the editor you would like to use.
481 If you would like to use a prepared file, type
482 "file", and you will be asked for the filename.
484 print "Editor [$ed]: ";
485 my $entry =scalar <>;
489 if ($entry eq "file") {
491 } elsif ($entry ne "") {
496 # Prompt for category of bug
497 $category ||= ask_for_alternatives('category');
499 # Prompt for severity of bug
500 $severity ||= ask_for_alternatives('severity');
502 # Generate scratch file to edit report in
503 $filename = filename();
505 # Prompt for file to read report from, if needed
506 if ($usefile and !$file) {
509 What is the name of the file that contains your report?
512 my $entry = scalar <>;
517 No filename? I'll let you go back and choose an editor again.
522 unless (-f $entry and -r $entry) {
524 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
525 the file? If you don't want to send a file, just enter a blank line and you
526 can get back to the editor selection.
534 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
535 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
538 This is a $reptype report for perl from $from,
539 generated with the help of perlbug $Version running under perl $perl_version.
547 or die "Unable to read report file from `$file': $!\n";
551 close(F) or die "Error closing `$file': $!";
555 -----------------------------------------------------------------
556 [Please enter your report here]
560 [Please do not change anything below this line]
561 -----------------------------------------------------------------
565 close(REP) or die "Error closing report file: $!";
567 # read in the report template once so that
568 # we can track whether the user does any editing.
569 # yes, *all* whitespace is ignored.
570 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
575 close(REP) or die "Error closing report file `$filename': $!";
595 print OUT "This perlbug was built using Perl $config_tag1\n",
596 "It is being executed now by Perl $config_tag2.\n\n"
597 if $config_tag2 ne $config_tag1;
600 Site configuration information for perl $perl_version:
603 if ($::Config{cf_by} and $::Config{cf_time}) {
604 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
606 print OUT Config::myconfig;
609 print OUT join "\n ", "Locally applied patches:", @patches;
616 \@INC for perl $perl_version:
625 Environment for perl $perl_version:
628 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
629 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
630 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
633 for my $env (sort keys %env) {
635 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
639 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
641 foreach (sort keys %::Config) {
642 $value = $::Config{$_};
644 print OUT "$_='$value'\n";
651 if ($usefile || $body) {
653 Please make sure that the name of the editor you want to use is correct.
655 print "Editor [$ed]: ";
656 my $entry =scalar <>;
658 $ed = $entry unless $entry eq '';
663 $sts = system("$ed $filename") unless $Is_MacOS;
665 require ExtUtils::MakeMaker;
666 ExtUtils::MM_MacOS::launch_file($filename);
668 Press Enter when done.
674 The editor you chose (`$ed') could apparently not be run!
675 Did you mistype the name of your editor? If so, please
676 correct it here, otherwise just press Enter.
678 print "Editor [$ed]: ";
679 my $entry =scalar <>;
687 You may want to save your report to a file, so you can edit and mail it
693 return if ($ok and not $::opt_n) || $body;
694 # Check that we have a report that has some, eh, report in it.
697 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
698 # a strange way to check whether any significant editing
699 # have been done: check whether any new non-empty lines
700 # have been added. Yes, the below code ignores *any* space
704 $unseen++ if $_ ne '' and not exists $REP{$_};
707 while ($unseen == 0) {
709 I am sorry but it looks like you did not report anything.
711 print "Action (Retry Edit/Cancel) ";
712 my ($action) = scalar(<>);
713 if ($action =~ /^[re]/i) { # <R>etry <E>dit
715 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
722 1 while unlink($filename); # remove all versions under VMS
723 print "\nCancelling.\n";
728 # Report is done, prompt for further action
732 Now that you have completed your report, would you like to send
733 the message to $address$andcc, display the message on
734 the screen, re-edit it, display/change the subject,
735 or cancel without sending anything?
736 You may also save the message as a file to mail at another time.
739 print "Action (Send/Display/Edit/Subject/Save to File): ";
740 my $action = scalar <>;
743 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
744 my $file_save = $outfile || "perlbug.rep";
745 print "\n\nName of file to save message in [$file_save]: ";
746 my $file = scalar <>;
748 $file = $file_save if $file eq "";
750 unless (open(FILE, ">$file")) {
751 print "\nError opening $file: $!\n\n";
754 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
755 print FILE "To: $address\nSubject: $subject\n";
756 print FILE "Cc: $cc\n" if $cc;
757 print FILE "Reply-To: $from\n" if $from;
758 print FILE "Message-Id: $messageid\n" if $messageid;
760 while (<REP>) { print FILE }
761 close(REP) or die "Error closing report file `$filename': $!";
762 close(FILE) or die "Error closing $file: $!";
764 print "\nMessage saved in `$file'.\n";
766 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
767 # Display the message
768 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
769 while (<REP>) { print $_ }
770 close(REP) or die "Error closing report file `$filename': $!";
771 } elsif ($action =~ /^su/i) { # <Su>bject
772 print "Subject: $subject\n";
773 print "If the above subject is fine, just press Enter.\n";
774 print "If not, type in the new subject.\n";
776 my $reply = scalar <STDIN>;
779 unless (TrivialSubject($reply)) {
781 print "Subject: $subject\n";
784 } elsif ($action =~ /^se/i) { # <S>end
786 print "Are you certain you want to send this message?\n"
787 . 'Please type "yes" if you are: ';
788 my $reply = scalar <STDIN>;
790 if ($reply eq "yes") {
794 That wasn't a clear "yes", so I won't send your message. If you are sure
795 your message should be sent, type in "yes" (without the quotes) at the
799 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
802 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
804 } elsif ($action =~ /^s/i) {
806 I'm sorry, but I didn't understand that. Please type "send" or "save".
816 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
817 length($subject) < 4 ||
819 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
827 # Message has been accepted for transmission -- Send the message
829 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
833 # on linux certain mail implementations won't accept the subject
834 # as "~s subject" and thus the Subject header will be corrupted
835 # so don't use Mail::Send to be safe
836 if ($::HaveSend && !$Is_Linux) {
837 $msg = new Mail::Send Subject => $subject, To => $address;
838 $msg->cc($cc) if $cc;
839 $msg->add("Reply-To",$from) if $from;
842 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
843 while (<REP>) { print $fh $_ }
844 close(REP) or die "Error closing $filename: $!";
847 print "\nMessage sent.\n";
849 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
850 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
852 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
853 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
855 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
856 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
858 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
859 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
863 (leaving bug report in $filename): $sts
868 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
869 $sendmail = $_, last if -e $_;
871 if ($^O eq 'os2' and $sendmail eq "") {
872 my $path = $ENV{PATH};
874 my @path = split /$Config{'path_sep'}/, $path;
876 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
877 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
881 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
882 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
883 the perl package Mail::Send has not been installed, so I can't send your bug
884 report. We apologize for the inconvenience.
886 So you may attempt to find some way of sending your message, it has
887 been left in the file `$filename'.
889 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
891 print SENDMAIL "To: $address\n";
892 print SENDMAIL "Subject: $subject\n";
893 print SENDMAIL "Cc: $cc\n" if $cc;
894 print SENDMAIL "Reply-To: $from\n" if $from;
895 print SENDMAIL "Message-Id: $messageid\n" if $messageid;
896 print SENDMAIL "\n\n";
897 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
898 while (<REP>) { print SENDMAIL $_ }
899 close(REP) or die "Error closing $filename: $!";
901 if (close(SENDMAIL)) {
902 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
904 warn "\nSendmail returned status '", $? >> 8, "'\n";
907 1 while unlink($filename); # remove all versions under VMS
913 A program to help generate bug reports about perl5, and mail them.
914 It is designed to be used interactively. Normally no arguments will
918 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
919 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
920 $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
922 Simplest usage: run "$0", and follow the prompts.
926 -v Include Verbose configuration data in the report
927 -f File containing the body of the report. Use this to
928 quickly send a prepared message.
929 -F File to output the resulting mail message to, instead of mailing.
930 -S Send without asking for confirmation.
931 -a Address to send the report to. Defaults to `$address'.
932 -c Address to send copy of report to. Defaults to `$cc'.
933 -C Don't send copy to administrator.
934 -s Subject to include with the message. You will be prompted
935 if you don't supply one on the command line.
936 -b Body of the report. If not included on the command line, or
937 in a file with -f, you will get a chance to edit the message.
938 -r Your return address. The program will ask you to confirm
939 this if you don't give it here.
941 -t Test mode. The target address defaults to `$testaddress'.
942 -d Data mode. This prints out your configuration data, without mailing
943 anything. You can use this with -v to get more complete data.
944 -A Don't send a bug received acknowledgement to the return address.
945 -ok Report successful build on this system to perl porters
946 (use alone or with -v). Only use -ok if *everything* was ok:
947 if there were *any* problems at all, use -nok.
948 -okay As -ok but allow report from old builds.
949 -nok Report unsuccessful build on this system to perl porters
950 (use alone or with -v). You must describe what went wrong
951 in the body of the report which you will be asked to edit.
952 -nokay As -nok but allow report from old builds.
953 -h Print this help message.
959 my $dir = File::Spec->tmpdir();
960 $filename = "bugrep0$$";
961 $filename++ while -e File::Spec->catfile($dir, $filename);
962 $filename = File::Spec->catfile($dir, $filename);
966 my @paragraphs = split /\n{2,}/, "@_";
968 for (@paragraphs) { # implicit local $_
976 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
984 perlbug - how to submit bug reports on Perl
988 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
989 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
990 S<[ B<-r> I<returnaddress> ]>
991 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
992 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
994 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
995 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
999 A program to help generate bug reports about perl or the modules that
1000 come with it, and mail them.
1002 If you have found a bug with a non-standard port (one that was not part
1003 of the I<standard distribution>), a binary distribution, or a
1004 non-standard module (such as Tk, CGI, etc), then please see the
1005 documentation that came with that distribution to determine the correct
1006 place to report bugs.
1008 C<perlbug> is designed to be used interactively. Normally no arguments
1009 will be needed. Simply run it, and follow the prompts.
1011 If you are unable to run B<perlbug> (most likely because you don't have
1012 a working setup to send mail that perlbug recognizes), you may have to
1013 compose your own report, and email it to B<perlbug@perl.org>. You might
1014 find the B<-d> option useful to get summary information in that case.
1016 In any case, when reporting a bug, please make sure you have run through
1021 =item What version of Perl you are running?
1023 Type C<perl -v> at the command line to find out.
1025 =item Are you running the latest released version of perl?
1027 Look at http://www.perl.com/ to find out. If it is not the latest
1028 released version, get that one and see whether your bug has been
1029 fixed. Note that bug reports about old versions of Perl, especially
1030 those prior to the 5.0 release, are likely to fall upon deaf ears.
1031 You are on your own if you continue to use perl1 .. perl4.
1033 =item Are you sure what you have is a bug?
1035 A significant number of the bug reports we get turn out to be documented
1036 features in Perl. Make sure the behavior you are witnessing doesn't fall
1037 under that category, by glancing through the documentation that comes
1038 with Perl (we'll admit this is no mean task, given the sheer volume of
1039 it all, but at least have a look at the sections that I<seem> relevant).
1041 Be aware of the familiar traps that perl programmers of various hues
1042 fall into. See L<perltrap>.
1044 Check in L<perldiag> to see what any Perl error message(s) mean.
1045 If message isn't in perldiag, it probably isn't generated by Perl.
1046 Consult your operating system documentation instead.
1048 If you are on a non-UNIX platform check also L<perlport>, as some
1049 features may be unimplemented or work differently.
1051 Try to study the problem under the Perl debugger, if necessary.
1054 =item Do you have a proper test case?
1056 The easier it is to reproduce your bug, the more likely it will be
1057 fixed, because if no one can duplicate the problem, no one can fix it.
1058 A good test case has most of these attributes: fewest possible number
1059 of lines; few dependencies on external commands, modules, or
1060 libraries; runs on most platforms unimpeded; and is self-documenting.
1062 A good test case is almost always a good candidate to be on the perl
1063 test suite. If you have the time, consider making your test case so
1064 that it will readily fit into the standard test suite.
1066 Remember also to include the B<exact> error messages, if any.
1067 "Perl complained something" is not an exact error message.
1069 If you get a core dump (or equivalent), you may use a debugger
1070 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1071 report. NOTE: unless your Perl has been compiled with debug info
1072 (often B<-g>), the stack trace is likely to be somewhat hard to use
1073 because it will most probably contain only the function names and not
1074 their arguments. If possible, recompile your Perl with debug info and
1075 reproduce the dump and the stack trace.
1077 =item Can you describe the bug in plain English?
1079 The easier it is to understand a reproducible bug, the more likely it
1080 will be fixed. Anything you can provide by way of insight into the
1081 problem helps a great deal. In other words, try to analyze the
1082 problem (to the extent you can) and report your discoveries.
1084 =item Can you fix the bug yourself?
1086 A bug report which I<includes a patch to fix it> will almost
1087 definitely be fixed. Use the C<diff> program to generate your patches
1088 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1089 package, so you should be able to get it from any of the GNU software
1090 repositories). If you do submit a patch, the cool-dude counter at
1091 perlbug@perl.org will register you as a savior of the world. Your
1092 patch may be returned with requests for changes, or requests for more
1093 detailed explanations about your fix.
1095 Here are some clues for creating quality patches: Use the B<-c> or
1096 B<-u> switches to the diff program (to create a so-called context or
1097 unified diff). Make sure the patch is not reversed (the first
1098 argument to diff is typically the original file, the second argument
1099 your changed file). Make sure you test your patch by applying it with
1100 the C<patch> program before you send it on its way. Try to follow the
1101 same style as the code you are trying to patch. Make sure your patch
1102 really does work (C<make test>, if the thing you're patching supports
1105 =item Can you use C<perlbug> to submit the report?
1107 B<perlbug> will, amongst other things, ensure your report includes
1108 crucial information about your version of perl. If C<perlbug> is unable
1109 to mail your report after you have typed it in, you may have to compose
1110 the message yourself, add the output produced by C<perlbug -d> and email
1111 it to B<perlbug@perl.org>. If, for some reason, you cannot run
1112 C<perlbug> at all on your system, be sure to include the entire output
1113 produced by running C<perl -V> (note the uppercase V).
1115 Whether you use C<perlbug> or send the email manually, please make
1116 your Subject line informative. "a bug" not informative. Neither is
1117 "perl crashes" nor "HELP!!!". These don't help.
1118 A compact description of what's wrong is fine.
1122 Having done your bit, please be prepared to wait, to be told the bug
1123 is in your code, or even to get no reply at all. The Perl maintainers
1124 are busy folks, so if your problem is a small one or if it is difficult
1125 to understand or already known, they may not respond with a personal reply.
1126 If it is important to you that your bug be fixed, do monitor the
1127 C<Changes> file in any development releases since the time you submitted
1128 the bug, and encourage the maintainers with kind words (but never any
1129 flames!). Feel free to resend your bug report if the next released
1130 version of perl comes out and your bug is still present.
1138 Address to send the report to. Defaults to B<perlbug@perl.org>.
1142 Don't send a bug received acknowledgement to the reply address.
1143 Generally it is only a sensible to use this option if you are a
1144 perl maintainer actively watching perl porters for your message to
1149 Body of the report. If not included on the command line, or
1150 in a file with B<-f>, you will get a chance to edit the message.
1154 Don't send copy to administrator.
1158 Address to send copy of report to. Defaults to the address of the
1159 local perl administrator (recorded when perl was built).
1163 Data mode (the default if you redirect or pipe output). This prints out
1164 your configuration data, without mailing anything. You can use this
1165 with B<-v> to get more complete data.
1173 File containing the body of the report. Use this to quickly send a
1178 File to output the results to instead of sending as an email. Useful
1179 particularly when running perlbug on a machine with no direct internet
1184 Prints a brief summary of the options.
1188 Report successful build on this system to perl porters. Forces B<-S>
1189 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1190 prompts for a return address if it cannot guess it (for use with
1191 B<make>). Honors return address specified with B<-r>. You can use this
1192 with B<-v> to get more complete data. Only makes a report if this
1193 system is less than 60 days old.
1197 As B<-ok> except it will report on older systems.
1201 Report unsuccessful build on this system. Forces B<-C>. Forces and
1202 supplies a value for B<-s>, then requires you to edit the report
1203 and say what went wrong. Alternatively, a prepared report may be
1204 supplied using B<-f>. Only prompts for a return address if it
1205 cannot guess it (for use with B<make>). Honors return address
1206 specified with B<-r>. You can use this with B<-v> to get more
1207 complete data. Only makes a report if this system is less than 60
1212 As B<-nok> except it will report on older systems.
1216 Your return address. The program will ask you to confirm its default
1217 if you don't use this option.
1221 Send without asking for confirmation.
1225 Subject to include with the message. You will be prompted if you don't
1226 supply one on the command line.
1230 Test mode. The target address defaults to B<perlbug-test@perl.org>.
1234 Include verbose configuration data in the report.
1240 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1241 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1242 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1243 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1244 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1245 Hugo van der Sanden (E<lt>hv@crypt.org<gt>),
1246 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1247 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1248 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1252 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1253 diff(1), patch(1), dbx(1), gdb(1)
1257 None known (guess what must have been used to report them?)
1263 close OUT or die "Can't close $file: $!";
1264 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1265 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';