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,
144 my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
146 my $config_tag2 = "$perl_version - $Config{cf_time}";
150 if ($::opt_h) { Help(); exit; }
151 if ($::opt_d) { Dump(*STDOUT); exit; }
152 if (!-t STDIN && !($ok and not $::opt_n)) {
154 Please use perlbug interactively. If you want to
155 include a file, you can use the -f switch.
161 Edit() unless $usefile || ($ok and not $::opt_n);
167 sub ask_for_alternatives { # (category|severity)
173 'opts' => [qw(core docs install library utilities)], # patch, notabug
178 'opts' => [qw(critical high medium low wishlist none)], # zero
181 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
184 $alt = $alts{$name}{'ok'};
186 my @alts = @{$alts{$name}{'opts'}};
188 Please pick a \u$name from the following:
196 die "Invalid $name: aborting.\n";
198 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
201 if ($alt =~ /^\s*$/) {
202 $alt = $alts{$name}{'default'};
204 } while !((($alt) = grep(/^$alt/i, @alts)));
210 # -------- Setup --------
212 $Is_MSWin32 = $^O eq 'MSWin32';
213 $Is_VMS = $^O eq 'VMS';
214 $Is_Linux = lc($^O) eq 'linux';
215 $Is_OpenBSD = lc($^O) eq 'openbsd';
216 $Is_MacOS = $^O eq 'MacOS';
218 @ARGV = split m/\s+/,
219 MacPerl::Ask('Provide command-line args here (-h for help):')
220 if $Is_MacOS && $MacPerl::Version =~ /App/;
222 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
224 # This comment is needed to notify metaconfig that we are
225 # using the $perladmin, $cf_by, and $cf_time definitions.
227 # -------- Configuration ---------
230 $perlbug = 'perlbug@perl.org';
233 $testaddress = 'perlbug-test@perl.org';
236 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
238 # Users address, used in message and in Reply-To header
239 $from = $::opt_r || "";
241 # Include verbose configuration information
242 $verbose = $::opt_v || 0;
244 # Subject of bug-report message
245 $subject = $::opt_s || "";
248 $usefile = ($::opt_f || 0);
250 # File to send as report
251 $file = $::opt_f || "";
254 $outfile = $::opt_F || "";
257 $body = $::opt_b || "";
260 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
261 || ($Is_VMS && "edit/tpu")
262 || ($Is_MSWin32 && "notepad")
266 # Not OK - provide build failure template by finessing OK report
268 if (substr($::opt_n, 0, 2) eq 'ok' ) {
269 $::opt_o = substr($::opt_n, 1);
276 # OK - send "OK" report for build on this system
279 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
280 my $age = time - $patchlevel_date;
281 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
282 my $date = localtime $patchlevel_date;
284 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
285 are more than 60 days old. This Perl version was constructed on
286 $date. If you really want to report this, use
287 "perlbug -okay" or "perlbug -nokay".
291 # force these options
293 $::opt_S = 1; # don't prompt for send
294 $::opt_b = 1; # we have a body
295 $body = "Perl reported to build OK on this system.\n";
297 $::opt_C = 1; # don't send a copy to the local admin
298 $::opt_s = 1; # we have a subject line
299 $subject = ($::opt_n ? 'Not ' : '')
300 . "OK: perl $perl_version ${patch_tags}on"
301 ." $::Config{'archname'} $::Config{'osvers'} $subject";
309 # Possible administrator addresses, in order of confidence
310 # (Note that cf_email is not mentioned to metaconfig, since
311 # we don't really want it. We'll just take it if we have to.)
313 # This has to be after the $ok stuff above because of the way
314 # that $::opt_C is forced.
315 $cc = $::opt_C ? "" : (
316 $::opt_c || $::Config{'perladmin'}
317 || $::Config{'cf_email'} || $::Config{'cf_by'}
321 $domain = Mail::Util::maildomain();
322 } elsif ($Is_MSWin32) {
323 $domain = $ENV{'USERDOMAIN'};
325 require Sys::Hostname;
326 $domain = Sys::Hostname::hostname();
330 $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>";
333 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
334 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
335 : $Is_MacOS ? $ENV{'USER'}
336 : eval { getpwuid($<) }; # May be missing
338 $from = $::Config{'cf_email'}
339 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
340 ($me eq $::Config{'cf_by'});
344 # Explain what perlbug is
347 This program provides an easy way to create a message reporting a bug
348 in perl, and e-mail it to $address. It is *NOT* intended for
349 sending test messages or simply verifying that perl works, *NOR* is it
350 intended for reporting bugs in third-party perl modules. It is *ONLY*
351 a means of reporting verifiable problems with the core perl distribution,
352 and any solutions to such problems, to the people who maintain perl.
354 If you're just looking for help with perl, try posting to the Usenet
355 newsgroup comp.lang.perl.misc. If you're looking for help with using
356 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
360 # Prompt for subject of message, if needed
362 if (TrivialSubject($subject)) {
368 First of all, please provide a subject for the
369 message. It should be a concise description of
370 the bug or problem. "perl bug" or "perl problem"
371 is not a concise description.
382 } while (TrivialSubject($subject));
385 # Prompt for return address, if needed
387 # Try and guess return address
390 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
392 require Mac::InternetConfig;
393 $guess = $Mac::InternetConfig::InternetConfig{
394 Mac::InternetConfig::kICEmail()
399 # move $domain to where we can use it elsewhere
401 if ($Is_VMS && !$::Config{'d_socket'}) {
402 $guess = "$domain\:\:$me";
404 $guess = "$me\@$domain" if $domain;
412 Your e-mail address will be useful if you need to be contacted. If the
413 default shown is not your full internet e-mail address, please correct it.
418 So that you may be contacted if necessary, please enter
419 your full internet e-mail address here.
428 print "Your address [$guess]: ";
431 $from = $guess if $from eq '';
435 if ($from eq $cc or $me eq $cc) {
436 # Try not to copy ourselves
440 # Prompt for administrator address, unless an override was given
441 if( !$::opt_C and !$::opt_c ) {
443 A copy of this report can be sent to your local
444 perl administrator. If the address is wrong, please
445 correct it, or enter 'none' or 'yourself' to not send
448 print "Local perl administrator [$cc]: ";
449 my $entry = scalar <>;
454 $cc = '' if $me eq $cc;
458 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
459 $andcc = " and $cc" if $cc;
461 # Prompt for editor, if no override is given
463 unless ($::opt_e || $::opt_f || $::opt_b) {
465 Now you need to supply the bug report. Try to make
466 the report concise but descriptive. Include any
467 relevant detail. If you are reporting something
468 that does not work as you think it should, please
469 try to include example of both the actual
470 result, and what you expected.
472 Some information about your local
473 perl configuration will automatically be included
474 at the end of the report. If you are using any
475 unusual version of perl, please try and confirm
476 exactly which versions are relevant.
478 You will probably want to use an editor to enter
479 the report. If "$ed" is the editor you want
480 to use, then just press Enter, otherwise type in
481 the name of the editor you would like to use.
483 If you would like to use a prepared file, type
484 "file", and you will be asked for the filename.
486 print "Editor [$ed]: ";
487 my $entry =scalar <>;
491 if ($entry eq "file") {
493 } elsif ($entry ne "") {
498 # Prompt for category of bug
499 $category ||= ask_for_alternatives('category');
501 # Prompt for severity of bug
502 $severity ||= ask_for_alternatives('severity');
504 # Generate scratch file to edit report in
505 $filename = filename();
507 # Prompt for file to read report from, if needed
508 if ($usefile and !$file) {
511 What is the name of the file that contains your report?
514 my $entry = scalar <>;
519 No filename? I'll let you go back and choose an editor again.
524 unless (-f $entry and -r $entry) {
526 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
527 the file? If you don't want to send a file, just enter a blank line and you
528 can get back to the editor selection.
536 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
537 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
540 This is a $reptype report for perl from $from,
541 generated with the help of perlbug $Version running under perl $perl_version.
549 or die "Unable to read report file from `$file': $!\n";
553 close(F) or die "Error closing `$file': $!";
557 -----------------------------------------------------------------
558 [Please enter your report here]
562 [Please do not change anything below this line]
563 -----------------------------------------------------------------
567 close(REP) or die "Error closing report file: $!";
569 # read in the report template once so that
570 # we can track whether the user does any editing.
571 # yes, *all* whitespace is ignored.
572 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
577 close(REP) or die "Error closing report file `$filename': $!";
597 print OUT "This perlbug was built using Perl $config_tag1\n",
598 "It is being executed now by Perl $config_tag2.\n\n"
599 if $config_tag2 ne $config_tag1;
602 Site configuration information for perl $perl_version:
605 if ($::Config{cf_by} and $::Config{cf_time}) {
606 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
608 print OUT Config::myconfig;
611 print OUT join "\n ", "Locally applied patches:", @patches;
618 \@INC for perl $perl_version:
627 Environment for perl $perl_version:
630 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
631 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
632 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
635 for my $env (sort keys %env) {
637 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
641 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
643 foreach (sort keys %::Config) {
644 $value = $::Config{$_};
646 print OUT "$_='$value'\n";
653 if ($usefile || $body) {
655 Please make sure that the name of the editor you want to use is correct.
657 print "Editor [$ed]: ";
658 my $entry =scalar <>;
660 $ed = $entry unless $entry eq '';
665 $sts = system("$ed $filename") unless $Is_MacOS;
667 require ExtUtils::MakeMaker;
668 ExtUtils::MM_MacOS::launch_file($filename);
670 Press Enter when done.
676 The editor you chose (`$ed') could apparently not be run!
677 Did you mistype the name of your editor? If so, please
678 correct it here, otherwise just press Enter.
680 print "Editor [$ed]: ";
681 my $entry =scalar <>;
689 You may want to save your report to a file, so you can edit and mail it
695 return if ($ok and not $::opt_n) || $body;
696 # Check that we have a report that has some, eh, report in it.
699 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
700 # a strange way to check whether any significant editing
701 # have been done: check whether any new non-empty lines
702 # have been added. Yes, the below code ignores *any* space
706 $unseen++ if $_ ne '' and not exists $REP{$_};
709 while ($unseen == 0) {
711 I am sorry but it looks like you did not report anything.
713 print "Action (Retry Edit/Cancel) ";
714 my ($action) = scalar(<>);
715 if ($action =~ /^[re]/i) { # <R>etry <E>dit
717 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
724 1 while unlink($filename); # remove all versions under VMS
725 print "\nCancelling.\n";
730 # Report is done, prompt for further action
734 Now that you have completed your report, would you like to send
735 the message to $address$andcc, display the message on
736 the screen, re-edit it, display/change the subject,
737 or cancel without sending anything?
738 You may also save the message as a file to mail at another time.
741 print "Action (Send/Display/Edit/Subject/Save to File): ";
742 my $action = scalar <>;
745 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
746 my $file_save = $outfile || "perlbug.rep";
747 print "\n\nName of file to save message in [$file_save]: ";
748 my $file = scalar <>;
750 $file = $file_save if $file eq "";
752 unless (open(FILE, ">$file")) {
753 print "\nError opening $file: $!\n\n";
756 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
757 print FILE "To: $address\nSubject: $subject\n";
758 print FILE "Cc: $cc\n" if $cc;
759 print FILE "Reply-To: $from\n" if $from;
760 print FILE "Message-Id: $messageid\n" if $messageid;
762 while (<REP>) { print FILE }
763 close(REP) or die "Error closing report file `$filename': $!";
764 close(FILE) or die "Error closing $file: $!";
766 print "\nMessage saved in `$file'.\n";
768 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
769 # Display the message
770 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
771 while (<REP>) { print $_ }
772 close(REP) or die "Error closing report file `$filename': $!";
773 } elsif ($action =~ /^su/i) { # <Su>bject
774 print "Subject: $subject\n";
775 print "If the above subject is fine, just press Enter.\n";
776 print "If not, type in the new subject.\n";
778 my $reply = scalar <STDIN>;
781 unless (TrivialSubject($reply)) {
783 print "Subject: $subject\n";
786 } elsif ($action =~ /^se/i) { # <S>end
788 print "Are you certain you want to send this message?\n"
789 . 'Please type "yes" if you are: ';
790 my $reply = scalar <STDIN>;
792 if ($reply eq "yes") {
796 That wasn't a clear "yes", so I won't send your message. If you are sure
797 your message should be sent, type in "yes" (without the quotes) at the
801 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
804 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
806 } elsif ($action =~ /^s/i) {
808 I'm sorry, but I didn't understand that. Please type "send" or "save".
818 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
819 length($subject) < 4 ||
821 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
829 # Message has been accepted for transmission -- Send the message
831 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
835 # on linux certain mail implementations won't accept the subject
836 # as "~s subject" and thus the Subject header will be corrupted
837 # so don't use Mail::Send to be safe
838 if ($::HaveSend && !$Is_Linux && !$Is_OpenBSD) {
839 $msg = new Mail::Send Subject => $subject, To => $address;
840 $msg->cc($cc) if $cc;
841 $msg->add("Reply-To",$from) if $from;
844 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
845 while (<REP>) { print $fh $_ }
846 close(REP) or die "Error closing $filename: $!";
849 print "\nMessage sent.\n";
851 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
852 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
854 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
855 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
857 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
858 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
860 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
861 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
865 (leaving bug report in $filename): $sts
870 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
871 $sendmail = $_, last if -e $_;
873 if ($^O eq 'os2' and $sendmail eq "") {
874 my $path = $ENV{PATH};
876 my @path = split /$Config{'path_sep'}/, $path;
878 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
879 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
883 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
884 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
885 the perl package Mail::Send has not been installed, so I can't send your bug
886 report. We apologize for the inconvenience.
888 So you may attempt to find some way of sending your message, it has
889 been left in the file `$filename'.
891 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
893 print SENDMAIL "To: $address\n";
894 print SENDMAIL "Subject: $subject\n";
895 print SENDMAIL "Cc: $cc\n" if $cc;
896 print SENDMAIL "Reply-To: $from\n" if $from;
897 print SENDMAIL "Message-Id: $messageid\n" if $messageid;
898 print SENDMAIL "\n\n";
899 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
900 while (<REP>) { print SENDMAIL $_ }
901 close(REP) or die "Error closing $filename: $!";
903 if (close(SENDMAIL)) {
904 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
906 warn "\nSendmail returned status '", $? >> 8, "'\n";
909 1 while unlink($filename); # remove all versions under VMS
915 A program to help generate bug reports about perl5, and mail them.
916 It is designed to be used interactively. Normally no arguments will
920 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
921 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
922 $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
924 Simplest usage: run "$0", and follow the prompts.
928 -v Include Verbose configuration data in the report
929 -f File containing the body of the report. Use this to
930 quickly send a prepared message.
931 -F File to output the resulting mail message to, instead of mailing.
932 -S Send without asking for confirmation.
933 -a Address to send the report to. Defaults to `$address'.
934 -c Address to send copy of report to. Defaults to `$cc'.
935 -C Don't send copy to administrator.
936 -s Subject to include with the message. You will be prompted
937 if you don't supply one on the command line.
938 -b Body of the report. If not included on the command line, or
939 in a file with -f, you will get a chance to edit the message.
940 -r Your return address. The program will ask you to confirm
941 this if you don't give it here.
943 -t Test mode. The target address defaults to `$testaddress'.
944 -d Data mode. This prints out your configuration data, without mailing
945 anything. You can use this with -v to get more complete data.
946 -A Don't send a bug received acknowledgement to the return address.
947 -ok Report successful build on this system to perl porters
948 (use alone or with -v). Only use -ok if *everything* was ok:
949 if there were *any* problems at all, use -nok.
950 -okay As -ok but allow report from old builds.
951 -nok Report unsuccessful build on this system to perl porters
952 (use alone or with -v). You must describe what went wrong
953 in the body of the report which you will be asked to edit.
954 -nokay As -nok but allow report from old builds.
955 -h Print this help message.
961 my $dir = File::Spec->tmpdir();
962 $filename = "bugrep0$$";
963 $filename++ while -e File::Spec->catfile($dir, $filename);
964 $filename = File::Spec->catfile($dir, $filename);
968 my @paragraphs = split /\n{2,}/, "@_";
970 for (@paragraphs) { # implicit local $_
978 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
986 perlbug - how to submit bug reports on Perl
990 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
991 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
992 S<[ B<-r> I<returnaddress> ]>
993 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
994 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
996 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
997 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
1001 A program to help generate bug reports about perl or the modules that
1002 come with it, and mail them.
1004 If you have found a bug with a non-standard port (one that was not part
1005 of the I<standard distribution>), a binary distribution, or a
1006 non-standard module (such as Tk, CGI, etc), then please see the
1007 documentation that came with that distribution to determine the correct
1008 place to report bugs.
1010 C<perlbug> is designed to be used interactively. Normally no arguments
1011 will be needed. Simply run it, and follow the prompts.
1013 If you are unable to run B<perlbug> (most likely because you don't have
1014 a working setup to send mail that perlbug recognizes), you may have to
1015 compose your own report, and email it to B<perlbug@perl.org>. You might
1016 find the B<-d> option useful to get summary information in that case.
1018 In any case, when reporting a bug, please make sure you have run through
1023 =item What version of Perl you are running?
1025 Type C<perl -v> at the command line to find out.
1027 =item Are you running the latest released version of perl?
1029 Look at http://www.perl.com/ to find out. If it is not the latest
1030 released version, get that one and see whether your bug has been
1031 fixed. Note that bug reports about old versions of Perl, especially
1032 those prior to the 5.0 release, are likely to fall upon deaf ears.
1033 You are on your own if you continue to use perl1 .. perl4.
1035 =item Are you sure what you have is a bug?
1037 A significant number of the bug reports we get turn out to be documented
1038 features in Perl. Make sure the behavior you are witnessing doesn't fall
1039 under that category, by glancing through the documentation that comes
1040 with Perl (we'll admit this is no mean task, given the sheer volume of
1041 it all, but at least have a look at the sections that I<seem> relevant).
1043 Be aware of the familiar traps that perl programmers of various hues
1044 fall into. See L<perltrap>.
1046 Check in L<perldiag> to see what any Perl error message(s) mean.
1047 If message isn't in perldiag, it probably isn't generated by Perl.
1048 Consult your operating system documentation instead.
1050 If you are on a non-UNIX platform check also L<perlport>, as some
1051 features may be unimplemented or work differently.
1053 Try to study the problem under the Perl debugger, if necessary.
1056 =item Do you have a proper test case?
1058 The easier it is to reproduce your bug, the more likely it will be
1059 fixed, because if no one can duplicate the problem, no one can fix it.
1060 A good test case has most of these attributes: fewest possible number
1061 of lines; few dependencies on external commands, modules, or
1062 libraries; runs on most platforms unimpeded; and is self-documenting.
1064 A good test case is almost always a good candidate to be on the perl
1065 test suite. If you have the time, consider making your test case so
1066 that it will readily fit into the standard test suite.
1068 Remember also to include the B<exact> error messages, if any.
1069 "Perl complained something" is not an exact error message.
1071 If you get a core dump (or equivalent), you may use a debugger
1072 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1073 report. NOTE: unless your Perl has been compiled with debug info
1074 (often B<-g>), the stack trace is likely to be somewhat hard to use
1075 because it will most probably contain only the function names and not
1076 their arguments. If possible, recompile your Perl with debug info and
1077 reproduce the dump and the stack trace.
1079 =item Can you describe the bug in plain English?
1081 The easier it is to understand a reproducible bug, the more likely it
1082 will be fixed. Anything you can provide by way of insight into the
1083 problem helps a great deal. In other words, try to analyze the
1084 problem (to the extent you can) and report your discoveries.
1086 =item Can you fix the bug yourself?
1088 A bug report which I<includes a patch to fix it> will almost
1089 definitely be fixed. Use the C<diff> program to generate your patches
1090 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1091 package, so you should be able to get it from any of the GNU software
1092 repositories). If you do submit a patch, the cool-dude counter at
1093 perlbug@perl.org will register you as a savior of the world. Your
1094 patch may be returned with requests for changes, or requests for more
1095 detailed explanations about your fix.
1097 Here are some clues for creating quality patches: Use the B<-c> or
1098 B<-u> switches to the diff program (to create a so-called context or
1099 unified diff). Make sure the patch is not reversed (the first
1100 argument to diff is typically the original file, the second argument
1101 your changed file). Make sure you test your patch by applying it with
1102 the C<patch> program before you send it on its way. Try to follow the
1103 same style as the code you are trying to patch. Make sure your patch
1104 really does work (C<make test>, if the thing you're patching supports
1107 =item Can you use C<perlbug> to submit the report?
1109 B<perlbug> will, amongst other things, ensure your report includes
1110 crucial information about your version of perl. If C<perlbug> is unable
1111 to mail your report after you have typed it in, you may have to compose
1112 the message yourself, add the output produced by C<perlbug -d> and email
1113 it to B<perlbug@perl.org>. If, for some reason, you cannot run
1114 C<perlbug> at all on your system, be sure to include the entire output
1115 produced by running C<perl -V> (note the uppercase V).
1117 Whether you use C<perlbug> or send the email manually, please make
1118 your Subject line informative. "a bug" not informative. Neither is
1119 "perl crashes" nor "HELP!!!". These don't help.
1120 A compact description of what's wrong is fine.
1124 Having done your bit, please be prepared to wait, to be told the bug
1125 is in your code, or even to get no reply at all. The Perl maintainers
1126 are busy folks, so if your problem is a small one or if it is difficult
1127 to understand or already known, they may not respond with a personal reply.
1128 If it is important to you that your bug be fixed, do monitor the
1129 C<Changes> file in any development releases since the time you submitted
1130 the bug, and encourage the maintainers with kind words (but never any
1131 flames!). Feel free to resend your bug report if the next released
1132 version of perl comes out and your bug is still present.
1140 Address to send the report to. Defaults to B<perlbug@perl.org>.
1144 Don't send a bug received acknowledgement to the reply address.
1145 Generally it is only a sensible to use this option if you are a
1146 perl maintainer actively watching perl porters for your message to
1151 Body of the report. If not included on the command line, or
1152 in a file with B<-f>, you will get a chance to edit the message.
1156 Don't send copy to administrator.
1160 Address to send copy of report to. Defaults to the address of the
1161 local perl administrator (recorded when perl was built).
1165 Data mode (the default if you redirect or pipe output). This prints out
1166 your configuration data, without mailing anything. You can use this
1167 with B<-v> to get more complete data.
1175 File containing the body of the report. Use this to quickly send a
1180 File to output the results to instead of sending as an email. Useful
1181 particularly when running perlbug on a machine with no direct internet
1186 Prints a brief summary of the options.
1190 Report successful build on this system to perl porters. Forces B<-S>
1191 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1192 prompts for a return address if it cannot guess it (for use with
1193 B<make>). Honors return address specified with B<-r>. You can use this
1194 with B<-v> to get more complete data. Only makes a report if this
1195 system is less than 60 days old.
1199 As B<-ok> except it will report on older systems.
1203 Report unsuccessful build on this system. Forces B<-C>. Forces and
1204 supplies a value for B<-s>, then requires you to edit the report
1205 and say what went wrong. Alternatively, a prepared report may be
1206 supplied using B<-f>. Only prompts for a return address if it
1207 cannot guess it (for use with B<make>). Honors return address
1208 specified with B<-r>. You can use this with B<-v> to get more
1209 complete data. Only makes a report if this system is less than 60
1214 As B<-nok> except it will report on older systems.
1218 Your return address. The program will ask you to confirm its default
1219 if you don't use this option.
1223 Send without asking for confirmation.
1227 Subject to include with the message. You will be prompted if you don't
1228 supply one on the command line.
1232 Test mode. The target address defaults to B<perlbug-test@perl.org>.
1236 Include verbose configuration data in the report.
1242 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1243 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1244 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1245 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1246 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1247 Hugo van der Sanden (E<lt>hv@crypt.org<gt>),
1248 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1249 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1250 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1254 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1255 diff(1), patch(1), dbx(1), gdb(1)
1259 None known (guess what must have been used to report them?)
1265 close OUT or die "Can't close $file: $!";
1266 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1267 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';