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+(?:const\s+)?char.*?local_patches\[\]\s*=\s*{\s*$/;
37 warn "Warning: local_patches section not found in patchlevel.h\n";
41 while (<PATCH_LEVEL>) {
47 push @patches, $_ unless $_ eq 'NULL';
49 my $patch_desc = "'" . join("',\n '", @patches) . "'";
50 my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches;
52 close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!";
54 # TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is
55 # used, compare $Config::config_sh with the stored version. If they differ then
56 # append a list of individual differences to the bug report.
59 print "Extracting $file (with variable substitutions)\n";
61 # In this section, perl variables will be expanded during extraction.
62 # You can use $Config{...} to use Configure variables.
64 my $extract_version = sprintf("%vd", $^V);
66 print OUT <<"!GROK!THIS!";
68 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
69 if \$running_under_some_shell;
71 my \$config_tag1 = '$extract_version - $Config{cf_time}';
73 my \$patchlevel_date = $patchlevel_date;
74 my \$patch_tags = '$patch_tags';
80 # In the following, perl variables are not expanded during extraction.
82 print OUT <<'!NO!SUBS!';
85 use File::Spec; # keep perlbug Perl 5.005 compatible
92 eval "use Mail::Send;";
93 $::HaveSend = ($@ eq "");
94 eval "use Mail::Util;";
95 $::HaveUtil = ($@ eq "");
96 # use secure tempfiles wherever possible
97 eval "require File::Temp;";
98 $::HaveTemp = ($@ eq "");
101 my $Version = "1.35";
103 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
104 # Changed in 1.07 to see more sendmail execs, and added pipe output.
105 # Changed in 1.08 to use correct address for sendmail.
106 # Changed in 1.09 to close the REP file before calling it up in the editor.
107 # Also removed some old comments duplicated elsewhere.
108 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
109 # temp filename generation.
110 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
111 # Changed in 1.12 to check for editor errors, make save/send distinction
112 # clearer and add $ENV{REPLYTO}.
113 # Changed in 1.13 to hopefully make it more difficult to accidentally
115 # Changed in 1.14 to make the prompts a little more clear on providing
116 # helpful information. Also let file read fail gracefully.
117 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
118 # Also report selected environment variables.
119 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
120 # Changed in 1.17 Win32 support added. GSAR 97-04-12
121 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
122 # Changed in 1.19 '-ok' default not '-v'
123 # add local patch information
124 # warn on '-ok' if this is an old system; add '-okay'
125 # Changed in 1.20 Added patchlevel.h reading and version/config checks
126 # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
127 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
128 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
129 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
130 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
131 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
132 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
133 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
134 # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000
135 # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000
136 # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000
137 # Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000
138 # Changed in 1.33 Don't require -t STDOUT for -ok.
139 # Changed in 1.34 Added Message-Id RFOLEY 18-06-2002
140 # Changed in 1.35 Use File::Temp (patch from Solar Designer) NWCLARK 28-02-2004
142 # TODO: - Allow the user to re-name the file on mail failure, and
143 # make sure failure (transmission-wise) of Mail::Send is
147 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $messageid, $domain,
148 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
149 $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS, $msg, $body, $andcc, %REP, $ok,
152 my $perl_version = $^V ? sprintf("%vd", $^V) : $];
154 my $config_tag2 = "$perl_version - $Config{cf_time}";
158 if ($::opt_h) { Help(); exit; }
159 if ($::opt_d) { Dump(*STDOUT); exit; }
160 if (!-t STDIN && !($ok and not $::opt_n)) {
162 Please use perlbug interactively. If you want to
163 include a file, you can use the -f switch.
169 Edit() unless $usefile || ($ok and not $::opt_n);
175 sub ask_for_alternatives { # (category|severity)
181 'opts' => [qw(core docs install library utilities)], # patch, notabug
186 'opts' => [qw(critical high medium low wishlist none)], # zero
189 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
192 $alt = $alts{$name}{'ok'};
194 my @alts = @{$alts{$name}{'opts'}};
196 Please pick a \u$name from the following:
204 die "Invalid $name: aborting.\n";
206 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
209 if ($alt =~ /^\s*$/) {
210 $alt = $alts{$name}{'default'};
212 } while !((($alt) = grep(/^$alt/i, @alts)));
218 # -------- Setup --------
220 $Is_MSWin32 = $^O eq 'MSWin32';
221 $Is_VMS = $^O eq 'VMS';
222 $Is_Linux = lc($^O) eq 'linux';
223 $Is_OpenBSD = lc($^O) eq 'openbsd';
224 $Is_MacOS = $^O eq 'MacOS';
226 @ARGV = split m/\s+/,
227 MacPerl::Ask('Provide command-line args here (-h for help):')
228 if $Is_MacOS && $MacPerl::Version =~ /App/;
230 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
232 # This comment is needed to notify metaconfig that we are
233 # using the $perladmin, $cf_by, and $cf_time definitions.
235 # -------- Configuration ---------
238 $perlbug = 'perlbug@perl.org';
241 $testaddress = 'perlbug-test@perl.org';
244 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
246 # Users address, used in message and in Reply-To header
247 $from = $::opt_r || "";
249 # Include verbose configuration information
250 $verbose = $::opt_v || 0;
252 # Subject of bug-report message
253 $subject = $::opt_s || "";
256 $usefile = ($::opt_f || 0);
258 # File to send as report
259 $file = $::opt_f || "";
262 $outfile = $::opt_F || "";
265 $body = $::opt_b || "";
268 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
269 || ($Is_VMS && "edit/tpu")
270 || ($Is_MSWin32 && "notepad")
274 # Not OK - provide build failure template by finessing OK report
276 if (substr($::opt_n, 0, 2) eq 'ok' ) {
277 $::opt_o = substr($::opt_n, 1);
284 # OK - send "OK" report for build on this system
287 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
288 my $age = time - $patchlevel_date;
289 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
290 my $date = localtime $patchlevel_date;
292 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
293 are more than 60 days old. This Perl version was constructed on
294 $date. If you really want to report this, use
295 "perlbug -okay" or "perlbug -nokay".
299 # force these options
301 $::opt_S = 1; # don't prompt for send
302 $::opt_b = 1; # we have a body
303 $body = "Perl reported to build OK on this system.\n";
305 $::opt_C = 1; # don't send a copy to the local admin
306 $::opt_s = 1; # we have a subject line
307 $subject = ($::opt_n ? 'Not ' : '')
308 . "OK: perl $perl_version ${patch_tags}on"
309 ." $::Config{'archname'} $::Config{'osvers'} $subject";
317 # Possible administrator addresses, in order of confidence
318 # (Note that cf_email is not mentioned to metaconfig, since
319 # we don't really want it. We'll just take it if we have to.)
321 # This has to be after the $ok stuff above because of the way
322 # that $::opt_C is forced.
323 $cc = $::opt_C ? "" : (
324 $::opt_c || $::Config{'perladmin'}
325 || $::Config{'cf_email'} || $::Config{'cf_by'}
329 $domain = Mail::Util::maildomain();
330 } elsif ($Is_MSWin32) {
331 $domain = $ENV{'USERDOMAIN'};
333 require Sys::Hostname;
334 $domain = Sys::Hostname::hostname();
338 $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>";
341 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
342 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
343 : $Is_MacOS ? $ENV{'USER'}
344 : eval { getpwuid($<) }; # May be missing
346 $from = $::Config{'cf_email'}
347 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
348 ($me eq $::Config{'cf_by'});
352 # Explain what perlbug is
355 This program provides an easy way to create a message reporting a bug
356 in perl, and e-mail it to $address. It is *NOT* intended for
357 sending test messages or simply verifying that perl works, *NOR* is it
358 intended for reporting bugs in third-party perl modules. It is *ONLY*
359 a means of reporting verifiable problems with the core perl distribution,
360 and any solutions to such problems, to the people who maintain perl.
362 If you're just looking for help with perl, try posting to the Usenet
363 newsgroup comp.lang.perl.misc. If you're looking for help with using
364 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
368 # Prompt for subject of message, if needed
370 if (TrivialSubject($subject)) {
376 First of all, please provide a subject for the
377 message. It should be a concise description of
378 the bug or problem. "perl bug" or "perl problem"
379 is not a concise description.
390 } while (TrivialSubject($subject));
393 # Prompt for return address, if needed
395 # Try and guess return address
398 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
400 require Mac::InternetConfig;
401 $guess = $Mac::InternetConfig::InternetConfig{
402 Mac::InternetConfig::kICEmail()
407 # move $domain to where we can use it elsewhere
409 if ($Is_VMS && !$::Config{'d_socket'}) {
410 $guess = "$domain\:\:$me";
412 $guess = "$me\@$domain" if $domain;
420 Your e-mail address will be useful if you need to be contacted. If the
421 default shown is not your full internet e-mail address, please correct it.
426 So that you may be contacted if necessary, please enter
427 your full internet e-mail address here.
436 print "Your address [$guess]: ";
439 $from = $guess if $from eq '';
443 if ($from eq $cc or $me eq $cc) {
444 # Try not to copy ourselves
448 # Prompt for administrator address, unless an override was given
449 if( !$::opt_C and !$::opt_c ) {
451 A copy of this report can be sent to your local
452 perl administrator. If the address is wrong, please
453 correct it, or enter 'none' or 'yourself' to not send
456 print "Local perl administrator [$cc]: ";
457 my $entry = scalar <>;
462 $cc = '' if $me eq $cc;
466 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
467 $andcc = " and $cc" if $cc;
469 # Prompt for editor, if no override is given
471 unless ($::opt_e || $::opt_f || $::opt_b) {
473 Now you need to supply the bug report. Try to make
474 the report concise but descriptive. Include any
475 relevant detail. If you are reporting something
476 that does not work as you think it should, please
477 try to include example of both the actual
478 result, and what you expected.
480 Some information about your local
481 perl configuration will automatically be included
482 at the end of the report. If you are using any
483 unusual version of perl, please try and confirm
484 exactly which versions are relevant.
486 You will probably want to use an editor to enter
487 the report. If "$ed" is the editor you want
488 to use, then just press Enter, otherwise type in
489 the name of the editor you would like to use.
491 If you would like to use a prepared file, type
492 "file", and you will be asked for the filename.
494 print "Editor [$ed]: ";
495 my $entry =scalar <>;
499 if ($entry eq "file") {
501 } elsif ($entry ne "") {
506 # Prompt for category of bug
507 $category ||= ask_for_alternatives('category');
509 # Prompt for severity of bug
510 $severity ||= ask_for_alternatives('severity');
512 # Generate scratch file to edit report in
513 $filename = filename();
515 # Prompt for file to read report from, if needed
516 if ($usefile and !$file) {
519 What is the name of the file that contains your report?
522 my $entry = scalar <>;
527 No filename? I'll let you go back and choose an editor again.
532 unless (-f $entry and -r $entry) {
534 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
535 the file? If you don't want to send a file, just enter a blank line and you
536 can get back to the editor selection.
544 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
545 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
548 This is a $reptype report for perl from $from,
549 generated with the help of perlbug $Version running under perl $perl_version.
557 or die "Unable to read report file from `$file': $!\n";
561 close(F) or die "Error closing `$file': $!";
565 -----------------------------------------------------------------
566 [Please enter your report here]
570 [Please do not change anything below this line]
571 -----------------------------------------------------------------
575 close(REP) or die "Error closing report file: $!";
577 # read in the report template once so that
578 # we can track whether the user does any editing.
579 # yes, *all* whitespace is ignored.
580 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
585 close(REP) or die "Error closing report file `$filename': $!";
605 print OUT "This perlbug was built using Perl $config_tag1\n",
606 "It is being executed now by Perl $config_tag2.\n\n"
607 if $config_tag2 ne $config_tag1;
610 Site configuration information for perl $perl_version:
613 if ($::Config{cf_by} and $::Config{cf_time}) {
614 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
616 print OUT Config::myconfig;
619 print OUT join "\n ", "Locally applied patches:", @patches;
626 \@INC for perl $perl_version:
635 Environment for perl $perl_version:
638 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
639 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
640 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
643 for my $env (sort keys %env) {
645 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
649 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
651 foreach (sort keys %::Config) {
652 $value = $::Config{$_};
654 print OUT "$_='$value'\n";
661 if ($usefile || $body) {
663 Please make sure that the name of the editor you want to use is correct.
665 print "Editor [$ed]: ";
666 my $entry =scalar <>;
668 $ed = $entry unless $entry eq '';
673 $sts = system("$ed $filename") unless $Is_MacOS;
675 require ExtUtils::MakeMaker;
676 ExtUtils::MM_MacOS::launch_file($filename);
678 Press Enter when done.
684 The editor you chose (`$ed') could apparently not be run!
685 Did you mistype the name of your editor? If so, please
686 correct it here, otherwise just press Enter.
688 print "Editor [$ed]: ";
689 my $entry =scalar <>;
697 You may want to save your report to a file, so you can edit and mail it
703 return if ($ok and not $::opt_n) || $body;
704 # Check that we have a report that has some, eh, report in it.
707 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
708 # a strange way to check whether any significant editing
709 # have been done: check whether any new non-empty lines
710 # have been added. Yes, the below code ignores *any* space
714 $unseen++ if $_ ne '' and not exists $REP{$_};
717 while ($unseen == 0) {
719 I am sorry but it looks like you did not report anything.
721 print "Action (Retry Edit/Cancel) ";
722 my ($action) = scalar(<>);
723 if ($action =~ /^[re]/i) { # <R>etry <E>dit
725 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
732 1 while unlink($filename); # remove all versions under VMS
733 print "\nCancelling.\n";
738 # Report is done, prompt for further action
742 Now that you have completed your report, would you like to send
743 the message to $address$andcc, display the message on
744 the screen, re-edit it, display/change the subject,
745 or cancel without sending anything?
746 You may also save the message as a file to mail at another time.
749 print "Action (Send/Display/Edit/Subject/Save to File): ";
750 my $action = scalar <>;
753 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
754 my $file_save = $outfile || "perlbug.rep";
755 print "\n\nName of file to save message in [$file_save]: ";
756 my $file = scalar <>;
758 $file = $file_save if $file eq "";
760 unless (open(FILE, ">$file")) {
761 print "\nError opening $file: $!\n\n";
764 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
765 print FILE "To: $address\nSubject: $subject\n";
766 print FILE "Cc: $cc\n" if $cc;
767 print FILE "Reply-To: $from\n" if $from;
768 print FILE "Message-Id: $messageid\n" if $messageid;
770 while (<REP>) { print FILE }
771 close(REP) or die "Error closing report file `$filename': $!";
772 close(FILE) or die "Error closing $file: $!";
774 print "\nMessage saved in `$file'.\n";
776 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
777 # Display the message
778 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
779 while (<REP>) { print $_ }
780 close(REP) or die "Error closing report file `$filename': $!";
781 } elsif ($action =~ /^su/i) { # <Su>bject
782 print "Subject: $subject\n";
783 print "If the above subject is fine, just press Enter.\n";
784 print "If not, type in the new subject.\n";
786 my $reply = scalar <STDIN>;
789 unless (TrivialSubject($reply)) {
791 print "Subject: $subject\n";
794 } elsif ($action =~ /^se/i) { # <S>end
796 print "Are you certain you want to send this message?\n"
797 . 'Please type "yes" if you are: ';
798 my $reply = scalar <STDIN>;
800 if ($reply eq "yes") {
804 That wasn't a clear "yes", so I won't send your message. If you are sure
805 your message should be sent, type in "yes" (without the quotes) at the
809 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
812 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
814 } elsif ($action =~ /^s/i) {
816 I'm sorry, but I didn't understand that. Please type "send" or "save".
826 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
827 length($subject) < 4 ||
829 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
837 # Message has been accepted for transmission -- Send the message
839 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
843 # on linux certain mail implementations won't accept the subject
844 # as "~s subject" and thus the Subject header will be corrupted
845 # so don't use Mail::Send to be safe
846 if ($::HaveSend && !$Is_Linux && !$Is_OpenBSD) {
847 $msg = new Mail::Send Subject => $subject, To => $address;
848 $msg->cc($cc) if $cc;
849 $msg->add("Reply-To",$from) if $from;
852 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
853 while (<REP>) { print $fh $_ }
854 close(REP) or die "Error closing $filename: $!";
857 print "\nMessage sent.\n";
859 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
860 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
862 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
863 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
865 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
866 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
868 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
869 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
873 (leaving bug report in $filename): $sts
878 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
879 $sendmail = $_, last if -e $_;
881 if ($^O eq 'os2' and $sendmail eq "") {
882 my $path = $ENV{PATH};
884 my @path = split /$Config{'path_sep'}/, $path;
886 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
887 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
891 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
892 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
893 the perl package Mail::Send has not been installed, so I can't send your bug
894 report. We apologize for the inconvenience.
896 So you may attempt to find some way of sending your message, it has
897 been left in the file `$filename'.
899 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
901 print SENDMAIL "To: $address\n";
902 print SENDMAIL "Subject: $subject\n";
903 print SENDMAIL "Cc: $cc\n" if $cc;
904 print SENDMAIL "Reply-To: $from\n" if $from;
905 print SENDMAIL "Message-Id: $messageid\n" if $messageid;
906 print SENDMAIL "\n\n";
907 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
908 while (<REP>) { print SENDMAIL $_ }
909 close(REP) or die "Error closing $filename: $!";
911 if (close(SENDMAIL)) {
912 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
914 warn "\nSendmail returned status '", $? >> 8, "'\n";
917 1 while unlink($filename); # remove all versions under VMS
923 A program to help generate bug reports about perl5, and mail them.
924 It is designed to be used interactively. Normally no arguments will
928 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
929 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
930 $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
932 Simplest usage: run "$0", and follow the prompts.
936 -v Include Verbose configuration data in the report
937 -f File containing the body of the report. Use this to
938 quickly send a prepared message.
939 -F File to output the resulting mail message to, instead of mailing.
940 -S Send without asking for confirmation.
941 -a Address to send the report to. Defaults to `$address'.
942 -c Address to send copy of report to. Defaults to `$cc'.
943 -C Don't send copy to administrator.
944 -s Subject to include with the message. You will be prompted
945 if you don't supply one on the command line.
946 -b Body of the report. If not included on the command line, or
947 in a file with -f, you will get a chance to edit the message.
948 -r Your return address. The program will ask you to confirm
949 this if you don't give it here.
951 -t Test mode. The target address defaults to `$testaddress'.
952 -d Data mode. This prints out your configuration data, without mailing
953 anything. You can use this with -v to get more complete data.
954 -A Don't send a bug received acknowledgement to the return address.
955 -ok Report successful build on this system to perl porters
956 (use alone or with -v). Only use -ok if *everything* was ok:
957 if there were *any* problems at all, use -nok.
958 -okay As -ok but allow report from old builds.
959 -nok Report unsuccessful build on this system to perl porters
960 (use alone or with -v). You must describe what went wrong
961 in the body of the report which you will be asked to edit.
962 -nokay As -nok but allow report from old builds.
963 -h Print this help message.
970 # Good. Use a secure temp file
971 my ($fh, $filename) = File::Temp::tempfile(UNLINK => 1);
975 # Bah. Fall back to doing things less securely.
976 my $dir = File::Spec->tmpdir();
977 $filename = "bugrep0$$";
978 $filename++ while -e File::Spec->catfile($dir, $filename);
979 $filename = File::Spec->catfile($dir, $filename);
984 my @paragraphs = split /\n{2,}/, "@_";
986 for (@paragraphs) { # implicit local $_
994 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
1002 perlbug - how to submit bug reports on Perl
1006 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
1007 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
1008 S<[ B<-r> I<returnaddress> ]>
1009 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
1010 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
1012 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
1013 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
1017 A program to help generate bug reports about perl or the modules that
1018 come with it, and mail them.
1020 If you have found a bug with a non-standard port (one that was not part
1021 of the I<standard distribution>), a binary distribution, or a
1022 non-standard module (such as Tk, CGI, etc), then please see the
1023 documentation that came with that distribution to determine the correct
1024 place to report bugs.
1026 C<perlbug> is designed to be used interactively. Normally no arguments
1027 will be needed. Simply run it, and follow the prompts.
1029 If you are unable to run B<perlbug> (most likely because you don't have
1030 a working setup to send mail that perlbug recognizes), you may have to
1031 compose your own report, and email it to B<perlbug@perl.org>. You might
1032 find the B<-d> option useful to get summary information in that case.
1034 In any case, when reporting a bug, please make sure you have run through
1039 =item What version of Perl you are running?
1041 Type C<perl -v> at the command line to find out.
1043 =item Are you running the latest released version of perl?
1045 Look at http://www.perl.com/ to find out. If it is not the latest
1046 released version, get that one and see whether your bug has been
1047 fixed. Note that bug reports about old versions of Perl, especially
1048 those prior to the 5.0 release, are likely to fall upon deaf ears.
1049 You are on your own if you continue to use perl1 .. perl4.
1051 =item Are you sure what you have is a bug?
1053 A significant number of the bug reports we get turn out to be documented
1054 features in Perl. Make sure the behavior you are witnessing doesn't fall
1055 under that category, by glancing through the documentation that comes
1056 with Perl (we'll admit this is no mean task, given the sheer volume of
1057 it all, but at least have a look at the sections that I<seem> relevant).
1059 Be aware of the familiar traps that perl programmers of various hues
1060 fall into. See L<perltrap>.
1062 Check in L<perldiag> to see what any Perl error message(s) mean.
1063 If message isn't in perldiag, it probably isn't generated by Perl.
1064 Consult your operating system documentation instead.
1066 If you are on a non-UNIX platform check also L<perlport>, as some
1067 features may be unimplemented or work differently.
1069 Try to study the problem under the Perl debugger, if necessary.
1072 =item Do you have a proper test case?
1074 The easier it is to reproduce your bug, the more likely it will be
1075 fixed, because if no one can duplicate the problem, no one can fix it.
1076 A good test case has most of these attributes: fewest possible number
1077 of lines; few dependencies on external commands, modules, or
1078 libraries; runs on most platforms unimpeded; and is self-documenting.
1080 A good test case is almost always a good candidate to be on the perl
1081 test suite. If you have the time, consider making your test case so
1082 that it will readily fit into the standard test suite.
1084 Remember also to include the B<exact> error messages, if any.
1085 "Perl complained something" is not an exact error message.
1087 If you get a core dump (or equivalent), you may use a debugger
1088 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1089 report. NOTE: unless your Perl has been compiled with debug info
1090 (often B<-g>), the stack trace is likely to be somewhat hard to use
1091 because it will most probably contain only the function names and not
1092 their arguments. If possible, recompile your Perl with debug info and
1093 reproduce the dump and the stack trace.
1095 =item Can you describe the bug in plain English?
1097 The easier it is to understand a reproducible bug, the more likely it
1098 will be fixed. Anything you can provide by way of insight into the
1099 problem helps a great deal. In other words, try to analyze the
1100 problem (to the extent you can) and report your discoveries.
1102 =item Can you fix the bug yourself?
1104 A bug report which I<includes a patch to fix it> will almost
1105 definitely be fixed. Use the C<diff> program to generate your patches
1106 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1107 package, so you should be able to get it from any of the GNU software
1108 repositories). If you do submit a patch, the cool-dude counter at
1109 perlbug@perl.org will register you as a savior of the world. Your
1110 patch may be returned with requests for changes, or requests for more
1111 detailed explanations about your fix.
1113 Here are some clues for creating quality patches: Use the B<-c> or
1114 B<-u> switches to the diff program (to create a so-called context or
1115 unified diff). Make sure the patch is not reversed (the first
1116 argument to diff is typically the original file, the second argument
1117 your changed file). Make sure you test your patch by applying it with
1118 the C<patch> program before you send it on its way. Try to follow the
1119 same style as the code you are trying to patch. Make sure your patch
1120 really does work (C<make test>, if the thing you're patching supports
1123 =item Can you use C<perlbug> to submit the report?
1125 B<perlbug> will, amongst other things, ensure your report includes
1126 crucial information about your version of perl. If C<perlbug> is unable
1127 to mail your report after you have typed it in, you may have to compose
1128 the message yourself, add the output produced by C<perlbug -d> and email
1129 it to B<perlbug@perl.org>. If, for some reason, you cannot run
1130 C<perlbug> at all on your system, be sure to include the entire output
1131 produced by running C<perl -V> (note the uppercase V).
1133 Whether you use C<perlbug> or send the email manually, please make
1134 your Subject line informative. "a bug" not informative. Neither is
1135 "perl crashes" nor "HELP!!!". These don't help.
1136 A compact description of what's wrong is fine.
1140 Having done your bit, please be prepared to wait, to be told the bug
1141 is in your code, or even to get no reply at all. The Perl maintainers
1142 are busy folks, so if your problem is a small one or if it is difficult
1143 to understand or already known, they may not respond with a personal reply.
1144 If it is important to you that your bug be fixed, do monitor the
1145 C<Changes> file in any development releases since the time you submitted
1146 the bug, and encourage the maintainers with kind words (but never any
1147 flames!). Feel free to resend your bug report if the next released
1148 version of perl comes out and your bug is still present.
1156 Address to send the report to. Defaults to B<perlbug@perl.org>.
1160 Don't send a bug received acknowledgement to the reply address.
1161 Generally it is only a sensible to use this option if you are a
1162 perl maintainer actively watching perl porters for your message to
1167 Body of the report. If not included on the command line, or
1168 in a file with B<-f>, you will get a chance to edit the message.
1172 Don't send copy to administrator.
1176 Address to send copy of report to. Defaults to the address of the
1177 local perl administrator (recorded when perl was built).
1181 Data mode (the default if you redirect or pipe output). This prints out
1182 your configuration data, without mailing anything. You can use this
1183 with B<-v> to get more complete data.
1191 File containing the body of the report. Use this to quickly send a
1196 File to output the results to instead of sending as an email. Useful
1197 particularly when running perlbug on a machine with no direct internet
1202 Prints a brief summary of the options.
1206 Report successful build on this system to perl porters. Forces B<-S>
1207 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1208 prompts for a return address if it cannot guess it (for use with
1209 B<make>). Honors return address specified with B<-r>. You can use this
1210 with B<-v> to get more complete data. Only makes a report if this
1211 system is less than 60 days old.
1215 As B<-ok> except it will report on older systems.
1219 Report unsuccessful build on this system. Forces B<-C>. Forces and
1220 supplies a value for B<-s>, then requires you to edit the report
1221 and say what went wrong. Alternatively, a prepared report may be
1222 supplied using B<-f>. Only prompts for a return address if it
1223 cannot guess it (for use with B<make>). Honors return address
1224 specified with B<-r>. You can use this with B<-v> to get more
1225 complete data. Only makes a report if this system is less than 60
1230 As B<-nok> except it will report on older systems.
1234 Your return address. The program will ask you to confirm its default
1235 if you don't use this option.
1239 Send without asking for confirmation.
1243 Subject to include with the message. You will be prompted if you don't
1244 supply one on the command line.
1248 Test mode. The target address defaults to B<perlbug-test@perl.org>.
1252 Include verbose configuration data in the report.
1258 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1259 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1260 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1261 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1262 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1263 Hugo van der Sanden (E<lt>hv@crypt.org<gt>),
1264 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1265 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1266 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1270 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1271 diff(1), patch(1), dbx(1), gdb(1)
1275 None known (guess what must have been used to report them?)
1281 close OUT or die "Can't close $file: $!";
1282 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1283 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';