Commit | Line | Data |
---|---|---|
68dc0745 | 1 | =head1 NAME |
2 | ||
04d666b1 | 3 | perlfaq3 - Programming Tools ($Revision: 1.32 $, $Date: 2003/01/26 17:41:53 $) |
68dc0745 | 4 | |
5 | =head1 DESCRIPTION | |
6 | ||
7 | This section of the FAQ answers questions related to programmer tools | |
8 | and programming support. | |
9 | ||
10 | =head2 How do I do (anything)? | |
11 | ||
12 | Have you looked at CPAN (see L<perlfaq2>)? The chances are that | |
13 | someone has already written a module that can solve your problem. | |
3958b146 | 14 | Have you read the appropriate manpages? Here's a brief index: |
68dc0745 | 15 | |
5a964f20 TC |
16 | Basics perldata, perlvar, perlsyn, perlop, perlsub |
17 | Execution perlrun, perldebug | |
18 | Functions perlfunc | |
68dc0745 | 19 | Objects perlref, perlmod, perlobj, perltie |
20 | Data Structures perlref, perllol, perldsc | |
f102b883 | 21 | Modules perlmod, perlmodlib, perlsub |
d92eb7b0 | 22 | Regexes perlre, perlfunc, perlop, perllocale |
68dc0745 | 23 | Moving to perl5 perltrap, perl |
24 | Linking w/C perlxstut, perlxs, perlcall, perlguts, perlembed | |
06a5f41f JH |
25 | Various http://www.cpan.org/misc/olddoc/FMTEYEWTK.tgz |
26 | (not a man-page but still useful, a collection | |
27 | of various essays on Perl techniques) | |
68dc0745 | 28 | |
3958b146 | 29 | A crude table of contents for the Perl manpage set is found in L<perltoc>. |
68dc0745 | 30 | |
31 | =head2 How can I use Perl interactively? | |
32 | ||
33 | The typical approach uses the Perl debugger, described in the | |
3958b146 | 34 | perldebug(1) manpage, on an ``empty'' program, like this: |
68dc0745 | 35 | |
36 | perl -de 42 | |
37 | ||
38 | Now just type in any legal Perl code, and it will be immediately | |
39 | evaluated. You can also examine the symbol table, get stack | |
40 | backtraces, check variable values, set breakpoints, and other | |
92c2ed05 | 41 | operations typically found in symbolic debuggers. |
68dc0745 | 42 | |
43 | =head2 Is there a Perl shell? | |
44 | ||
04d666b1 RGS |
45 | The psh (Perl sh) is currently at version 1.8. The Perl Shell is a |
46 | shell that combines the interactive nature of a Unix shell with the | |
47 | power of Perl. The goal is a full featured shell that behaves as | |
48 | expected for normal shell activity and uses Perl syntax and | |
49 | functionality for control-flow statements and other things. | |
50 | You can get psh at http://www.focusresearch.com/gregor/psh/ . | |
55e174a4 JH |
51 | |
52 | The Shell.pm module (distributed with Perl) makes Perl try commands | |
53 | which aren't part of the Perl language as shell commands. perlsh | |
54 | from the source distribution is simplistic and uninteresting, but | |
55 | may still be what you want. | |
68dc0745 | 56 | |
49d635f9 RGS |
57 | =head2 How do I find which modules are installed on my system? |
58 | ||
59 | You can use the ExtUtils::Installed module to show all | |
60 | installed distributions, although it can take awhile to do | |
61 | its magic. The standard library which comes with Perl just | |
62 | shows up as "Perl" (although you can get those with | |
63 | Mod::CoreList). | |
64 | ||
65 | use ExtUtils::Installed; | |
197aec24 | 66 | |
49d635f9 RGS |
67 | my $inst = ExtUtils::Installed->new(); |
68 | my @modules = $inst->modules(); | |
69 | ||
70 | If you want a list of all of the Perl module filenames, you | |
71 | can use File::Find::Rule. | |
72 | ||
73 | use File::Find::Rule; | |
197aec24 | 74 | |
49d635f9 RGS |
75 | my @files = File::Find::Rule->file()->name( '*.pm' )->in( @INC ); |
76 | ||
77 | If you do not have that module, you can do the same thing | |
197aec24 | 78 | with File::Find which is part of the standard library. |
49d635f9 RGS |
79 | |
80 | use File::Find; | |
81 | my @files; | |
82 | ||
83 | find sub { push @files, $File::Find::name if -f _ && /\.pm$/ }, | |
84 | @INC; | |
85 | ||
86 | print join "\n", @files; | |
197aec24 | 87 | |
49d635f9 RGS |
88 | If you simply need to quickly check to see if a module is |
89 | available, you can check for its documentation. If you can | |
197aec24 | 90 | read the documentation the module is most likely installed. |
49d635f9 RGS |
91 | If you cannot read the documentation, the module might not |
92 | have any (in rare cases). | |
93 | ||
94 | prompt% perldoc Module::Name | |
95 | ||
96 | You can also try to include the module in a one-liner to see if | |
97 | perl finds it. | |
98 | ||
99 | perl -MModule::Name -e1 | |
197aec24 | 100 | |
68dc0745 | 101 | =head2 How do I debug my Perl programs? |
102 | ||
197aec24 | 103 | Have you tried C<use warnings> or used C<-w>? They enable warnings |
a6dd486b | 104 | to detect dubious practices. |
68dc0745 | 105 | |
92c2ed05 GS |
106 | Have you tried C<use strict>? It prevents you from using symbolic |
107 | references, makes you predeclare any subroutines that you call as bare | |
108 | words, and (probably most importantly) forces you to predeclare your | |
a6dd486b | 109 | variables with C<my>, C<our>, or C<use vars>. |
68dc0745 | 110 | |
a6dd486b JB |
111 | Did you check the return values of each and every system call? The operating |
112 | system (and thus Perl) tells you whether they worked, and if not | |
92c2ed05 | 113 | why. |
68dc0745 | 114 | |
92c2ed05 GS |
115 | open(FH, "> /etc/cantwrite") |
116 | or die "Couldn't write to /etc/cantwrite: $!\n"; | |
68dc0745 | 117 | |
92c2ed05 | 118 | Did you read L<perltrap>? It's full of gotchas for old and new Perl |
a6dd486b | 119 | programmers and even has sections for those of you who are upgrading |
92c2ed05 GS |
120 | from languages like I<awk> and I<C>. |
121 | ||
122 | Have you tried the Perl debugger, described in L<perldebug>? You can | |
123 | step through your program and see what it's doing and thus work out | |
124 | why what it's doing isn't what it should be doing. | |
68dc0745 | 125 | |
126 | =head2 How do I profile my Perl programs? | |
127 | ||
e083a89c | 128 | You should get the Devel::DProf module from the standard distribution |
197aec24 RGS |
129 | (or separately on CPAN) and also use Benchmark.pm from the standard |
130 | distribution. The Benchmark module lets you time specific portions of | |
131 | your code, while Devel::DProf gives detailed breakdowns of where your | |
e083a89c | 132 | code spends its time. |
68dc0745 | 133 | |
92c2ed05 GS |
134 | Here's a sample use of Benchmark: |
135 | ||
136 | use Benchmark; | |
137 | ||
138 | @junk = `cat /etc/motd`; | |
139 | $count = 10_000; | |
140 | ||
141 | timethese($count, { | |
142 | 'map' => sub { my @a = @junk; | |
143 | map { s/a/b/ } @a; | |
144 | return @a | |
145 | }, | |
146 | 'for' => sub { my @a = @junk; | |
147 | local $_; | |
148 | for (@a) { s/a/b/ }; | |
149 | return @a }, | |
150 | }); | |
151 | ||
152 | This is what it prints (on one machine--your results will be dependent | |
153 | on your hardware, operating system, and the load on your machine): | |
154 | ||
155 | Benchmark: timing 10000 iterations of for, map... | |
156 | for: 4 secs ( 3.97 usr 0.01 sys = 3.98 cpu) | |
157 | map: 6 secs ( 4.97 usr 0.00 sys = 4.97 cpu) | |
158 | ||
65acb1b1 | 159 | Be aware that a good benchmark is very hard to write. It only tests the |
a6dd486b | 160 | data you give it and proves little about the differing complexities |
65acb1b1 TC |
161 | of contrasting algorithms. |
162 | ||
68dc0745 | 163 | =head2 How do I cross-reference my Perl programs? |
164 | ||
197aec24 | 165 | The B::Xref module can be used to generate cross-reference reports |
83ded9ee | 166 | for Perl programs. |
68dc0745 | 167 | |
c8db1d39 | 168 | perl -MO=Xref[,OPTIONS] scriptname.plx |
68dc0745 | 169 | |
170 | =head2 Is there a pretty-printer (formatter) for Perl? | |
171 | ||
55e174a4 JH |
172 | Perltidy is a Perl script which indents and reformats Perl scripts |
173 | to make them easier to read by trying to follow the rules of the | |
174 | L<perlstyle>. If you write Perl scripts, or spend much time reading | |
175 | them, you will probably find it useful. It is available at | |
176 | http://perltidy.sourceforge.net | |
177 | ||
178 | Of course, if you simply follow the guidelines in L<perlstyle>, | |
179 | you shouldn't need to reformat. The habit of formatting your code | |
180 | as you write it will help prevent bugs. Your editor can and should | |
181 | help you with this. The perl-mode or newer cperl-mode for emacs | |
182 | can provide remarkable amounts of help with most (but not all) | |
183 | code, and even less programmable editors can provide significant | |
184 | assistance. Tom Christiansen and many other VI users swear by | |
185 | the following settings in vi and its clones: | |
65acb1b1 TC |
186 | |
187 | set ai sw=4 | |
d92eb7b0 | 188 | map! ^O {^M}^[O^T |
65acb1b1 | 189 | |
55e174a4 | 190 | Put that in your F<.exrc> file (replacing the caret characters |
65acb1b1 | 191 | with control characters) and away you go. In insert mode, ^T is |
a6dd486b | 192 | for indenting, ^D is for undenting, and ^O is for blockdenting-- |
55e174a4 | 193 | as it were. A more complete example, with comments, can be found at |
213329dd | 194 | http://www.cpan.org/authors/id/TOMC/scripts/toms.exrc.gz |
92c2ed05 | 195 | |
49d635f9 | 196 | The a2ps http://www-inf.enst.fr/%7Edemaille/a2ps/black+white.ps.gz does |
06a5f41f | 197 | lots of things related to generating nicely printed output of |
f05bbc40 | 198 | documents, as does enscript at http://people.ssh.fi/mtr/genscript/ . |
65acb1b1 | 199 | |
d92eb7b0 | 200 | =head2 Is there a ctags for Perl? |
68dc0745 | 201 | |
bc06af74 JH |
202 | Recent versions of ctags do much more than older versions did. |
203 | EXUBERANT CTAGS is available from http://ctags.sourceforge.net/ | |
204 | and does a good job of making tags files for perl code. | |
205 | ||
206 | There is also a simple one at | |
a93751fa | 207 | http://www.cpan.org/authors/id/TOMC/scripts/ptags.gz which may do |
bc06af74 | 208 | the trick. It can be easy to hack this into what you want. |
65acb1b1 TC |
209 | |
210 | =head2 Is there an IDE or Windows Perl Editor? | |
211 | ||
6641ed39 JH |
212 | Perl programs are just plain text, so any editor will do. |
213 | ||
6641ed39 JH |
214 | If you're on Unix, you already have an IDE--Unix itself. The UNIX |
215 | philosophy is the philosophy of several small tools that each do one | |
216 | thing and do it well. It's like a carpenter's toolbox. | |
217 | ||
5ca69f12 | 218 | If you want an IDE, check the following: |
68fbfbd7 JH |
219 | |
220 | =over 4 | |
221 | ||
68fbfbd7 JH |
222 | =item Komodo |
223 | ||
5ca69f12 JH |
224 | ActiveState's cross-platform (as of April 2001 Windows and Linux), |
225 | multi-language IDE has Perl support, including a regular expression | |
226 | debugger and remote debugging | |
f224927c | 227 | ( http://www.ActiveState.com/Products/Komodo/index.html ). (Visual |
5ca69f12 | 228 | Perl, a Visual Studio.NET plug-in is currently (early 2001) in beta |
1577cd80 | 229 | ( http://www.ActiveState.com/Products/VisualPerl/index.html )). |
68fbfbd7 | 230 | |
06e809ab JH |
231 | =item The Object System |
232 | ||
bfeeaf1b | 233 | ( http://www.castlelink.co.uk/object_system/ ) is a Perl web |
06e809ab JH |
234 | applications development IDE, apparently for any platform |
235 | that runs Perl. | |
236 | ||
ac1094a1 JH |
237 | =item Open Perl IDE |
238 | ||
239 | ( http://open-perl-ide.sourceforge.net/ ) | |
240 | Open Perl IDE is an integrated development environment for writing | |
241 | and debugging Perl scripts with ActiveState's ActivePerl distribution | |
242 | under Windows 95/98/NT/2000. | |
243 | ||
5ca69f12 JH |
244 | =item PerlBuilder |
245 | ||
f224927c | 246 | ( http://www.solutionsoft.com/perl.htm ) is an integrated development |
5ca69f12 | 247 | environment for Windows that supports Perl development. |
8782d048 | 248 | |
68fbfbd7 JH |
249 | =item visiPerl+ |
250 | ||
ac1094a1 JH |
251 | ( http://helpconsulting.net/visiperl/ ) |
252 | From Help Consulting, for Windows. | |
68fbfbd7 | 253 | |
29b1171f JH |
254 | =item OptiPerl |
255 | ||
256 | ( http://www.optiperl.com/ ) is a Windows IDE with simulated CGI | |
257 | environment, including debugger and syntax highlighting editor. | |
258 | ||
68fbfbd7 JH |
259 | =back |
260 | ||
5a13f98a | 261 | For editors: if you're on Unix you probably have vi or a vi clone already, |
6641ed39 | 262 | and possibly an emacs too, so you may not need to download anything. |
5a13f98a | 263 | In any emacs the cperl-mode (M-x cperl-mode) gives you perhaps the |
6641ed39 JH |
264 | best available Perl editing mode in any editor. |
265 | ||
cc30d1a7 JH |
266 | If you are using Windows, you can use any editor that lets |
267 | you work with plain text, such as NotePad or WordPad. Word | |
268 | processors, such as Microsoft Word or WordPerfect, typically | |
269 | do not work since they insert all sorts of behind-the-scenes | |
270 | information, although some allow you to save files as "Text | |
271 | Only". You can also download text editors designed | |
272 | specifically for programming, such as Textpad | |
f224927c | 273 | ( http://www.textpad.com/ ) and UltraEdit |
bfeeaf1b | 274 | ( http://www.ultraedit.com/ ), among others. |
cc30d1a7 | 275 | |
49d635f9 | 276 | If you are using MacOS, the same concerns apply. MacPerl |
cc30d1a7 | 277 | (for Classic environments) comes with a simple editor. |
bfeeaf1b | 278 | Popular external editors are BBEdit ( http://www.bbedit.com/ ) |
49d635f9 | 279 | or Alpha ( http://www.kelehers.org/alpha/ ). MacOS X users can |
877ae92e | 280 | use Unix editors as well. |
68fbfbd7 JH |
281 | |
282 | =over 4 | |
283 | ||
284 | =item GNU Emacs | |
285 | ||
286 | http://www.gnu.org/software/emacs/windows/ntemacs.html | |
287 | ||
288 | =item MicroEMACS | |
289 | ||
49d635f9 | 290 | http://www.microemacs.de/ |
68fbfbd7 JH |
291 | |
292 | =item XEmacs | |
293 | ||
294 | http://www.xemacs.org/Download/index.html | |
295 | ||
49d635f9 RGS |
296 | =item Jed |
297 | ||
298 | http://space.mit.edu/~davis/jed/ | |
299 | ||
68fbfbd7 JH |
300 | =back |
301 | ||
302 | or a vi clone such as | |
303 | ||
304 | =over 4 | |
305 | ||
306 | =item Elvis | |
307 | ||
308 | ftp://ftp.cs.pdx.edu/pub/elvis/ http://www.fh-wedel.de/elvis/ | |
309 | ||
310 | =item Vile | |
311 | ||
49d635f9 | 312 | http://dickey.his.com/vile/vile.html |
68fbfbd7 JH |
313 | |
314 | =item Vim | |
315 | ||
316 | http://www.vim.org/ | |
317 | ||
68fbfbd7 JH |
318 | =back |
319 | ||
5a13f98a | 320 | For vi lovers in general, Windows or elsewhere: |
f05bbc40 JH |
321 | |
322 | http://www.thomer.com/thomer/vi/vi.html | |
6641ed39 | 323 | |
f224927c | 324 | nvi ( http://www.bostic.com/vi/ , available from CPAN in src/misc/) is |
5a13f98a | 325 | yet another vi clone, unfortunately not available for Windows, but in |
6641ed39 JH |
326 | UNIX platforms you might be interested in trying it out, firstly because |
327 | strictly speaking it is not a vi clone, it is the real vi, or the new | |
328 | incarnation of it, and secondly because you can embed Perl inside it | |
329 | to use Perl as the scripting language. nvi is not alone in this, | |
7c82de66 | 330 | though: at least also vim and vile offer an embedded Perl. |
614a1598 | 331 | |
68fbfbd7 JH |
332 | The following are Win32 multilanguage editor/IDESs that support Perl: |
333 | ||
334 | =over 4 | |
335 | ||
336 | =item Codewright | |
337 | ||
338 | http://www.starbase.com/ | |
339 | ||
340 | =item MultiEdit | |
341 | ||
342 | http://www.MultiEdit.com/ | |
343 | ||
344 | =item SlickEdit | |
345 | ||
346 | http://www.slickedit.com/ | |
347 | ||
348 | =back | |
8782d048 | 349 | |
6641ed39 JH |
350 | There is also a toyedit Text widget based editor written in Perl |
351 | that is distributed with the Tk module on CPAN. The ptkdb | |
f224927c | 352 | ( http://world.std.com/~aep/ptkdb/ ) is a Perl/tk based debugger that |
8782d048 | 353 | acts as a development environment of sorts. Perl Composer |
49d635f9 | 354 | ( http://perlcomposer.sourceforge.net/ ) is an IDE for Perl/Tk |
e083a89c JH |
355 | GUI creation. |
356 | ||
8782d048 | 357 | In addition to an editor/IDE you might be interested in a more |
68fbfbd7 JH |
358 | powerful shell environment for Win32. Your options include |
359 | ||
360 | =over 4 | |
361 | ||
362 | =item Bash | |
363 | ||
1577cd80 | 364 | from the Cygwin package ( http://sources.redhat.com/cygwin/ ) |
68fbfbd7 JH |
365 | |
366 | =item Ksh | |
367 | ||
f224927c | 368 | from the MKS Toolkit ( http://www.mks.com/ ), or the Bourne shell of |
1577cd80 | 369 | the U/WIN environment ( http://www.research.att.com/sw/tools/uwin/ ) |
68fbfbd7 JH |
370 | |
371 | =item Tcsh | |
372 | ||
f224927c | 373 | ftp://ftp.astron.com/pub/tcsh/ , see also |
68fbfbd7 JH |
374 | http://www.primate.wisc.edu/software/csh-tcsh-book/ |
375 | ||
376 | =item Zsh | |
377 | ||
f224927c | 378 | ftp://ftp.blarg.net/users/amol/zsh/ , see also http://www.zsh.org/ |
68fbfbd7 JH |
379 | |
380 | =back | |
381 | ||
614a1598 JH |
382 | MKS and U/WIN are commercial (U/WIN is free for educational and |
383 | research purposes), Cygwin is covered by the GNU Public License (but | |
384 | that shouldn't matter for Perl use). The Cygwin, MKS, and U/WIN all | |
385 | contain (in addition to the shells) a comprehensive set of standard | |
386 | UNIX toolkit utilities. | |
8782d048 | 387 | |
5a13f98a JH |
388 | If you're transferring text files between Unix and Windows using FTP |
389 | be sure to transfer them in ASCII mode so the ends of lines are | |
390 | appropriately converted. | |
391 | ||
e083a89c JH |
392 | On Mac OS the MacPerl Application comes with a simple 32k text editor |
393 | that behaves like a rudimentary IDE. In contrast to the MacPerl Application | |
733271b5 | 394 | the MPW Perl tool can make use of the MPW Shell itself as an editor (with |
68fbfbd7 JH |
395 | no 32k limit). |
396 | ||
397 | =over 4 | |
398 | ||
399 | =item BBEdit and BBEdit Lite | |
400 | ||
401 | are text editors for Mac OS that have a Perl sensitivity mode | |
1577cd80 | 402 | ( http://web.barebones.com/ ). |
68fbfbd7 JH |
403 | |
404 | =item Alpha | |
405 | ||
406 | is an editor, written and extensible in Tcl, that nonetheless has | |
733271b5 | 407 | built in support for several popular markup and programming languages |
1577cd80 | 408 | including Perl and HTML ( http://alpha.olm.net/ ). |
68fbfbd7 JH |
409 | |
410 | =back | |
411 | ||
412 | Pepper and Pe are programming language sensitive text editors for Mac | |
1577cd80 | 413 | OS X and BeOS respectively ( http://www.hekkelman.com/ ). |
68dc0745 | 414 | |
415 | =head2 Where can I get Perl macros for vi? | |
416 | ||
417 | For a complete version of Tom Christiansen's vi configuration file, | |
a93751fa | 418 | see http://www.cpan.org/authors/Tom_Christiansen/scripts/toms.exrc.gz , |
a6dd486b | 419 | the standard benchmark file for vi emulators. The file runs best with nvi, |
5a964f20 | 420 | the current version of vi out of Berkeley, which incidentally can be built |
bfeeaf1b | 421 | with an embedded Perl interpreter--see http://www.cpan.org/src/misc/ . |
68dc0745 | 422 | |
423 | =head2 Where can I get perl-mode for emacs? | |
424 | ||
425 | Since Emacs version 19 patchlevel 22 or so, there have been both a | |
87275199 | 426 | perl-mode.el and support for the Perl debugger built in. These should |
68dc0745 | 427 | come with the standard Emacs 19 distribution. |
428 | ||
87275199 | 429 | In the Perl source directory, you'll find a directory called "emacs", |
68dc0745 | 430 | which contains a cperl-mode that color-codes keywords, provides |
431 | context-sensitive help, and other nifty things. | |
432 | ||
92c2ed05 | 433 | Note that the perl-mode of emacs will have fits with C<"main'foo"> |
d92eb7b0 | 434 | (single quote), and mess up the indentation and highlighting. You |
65acb1b1 | 435 | are probably using C<"main::foo"> in new Perl code anyway, so this |
92c2ed05 | 436 | shouldn't be an issue. |
68dc0745 | 437 | |
438 | =head2 How can I use curses with Perl? | |
439 | ||
440 | The Curses module from CPAN provides a dynamically loadable object | |
5a964f20 | 441 | module interface to a curses library. A small demo can be found at the |
49d635f9 | 442 | directory http://www.cpan.org/authors/Tom_Christiansen/scripts/rep.gz ; |
5a964f20 TC |
443 | this program repeats a command and updates the screen as needed, rendering |
444 | B<rep ps axu> similar to B<top>. | |
68dc0745 | 445 | |
446 | =head2 How can I use X or Tk with Perl? | |
447 | ||
5a964f20 TC |
448 | Tk is a completely Perl-based, object-oriented interface to the Tk toolkit |
449 | that doesn't force you to use Tcl just to get at Tk. Sx is an interface | |
450 | to the Athena Widget set. Both are available from CPAN. See the | |
a93751fa | 451 | directory http://www.cpan.org/modules/by-category/08_User_Interfaces/ |
68dc0745 | 452 | |
a6dd486b | 453 | Invaluable for Perl/Tk programming are the Perl/Tk FAQ at |
87275199 | 454 | http://w4.lns.cornell.edu/%7Epvhp/ptk/ptkTOC.html , the Perl/Tk Reference |
92c2ed05 | 455 | Guide available at |
213329dd | 456 | http://www.cpan.org/authors/Stephen_O_Lidie/ , and the |
92c2ed05 | 457 | online manpages at |
87275199 | 458 | http://www-users.cs.umn.edu/%7Eamundson/perl/perltk/toc.html . |
92c2ed05 | 459 | |
68dc0745 | 460 | =head2 How can I generate simple menus without using CGI or Tk? |
461 | ||
a93751fa | 462 | The http://www.cpan.org/authors/id/SKUNZ/perlmenu.v4.0.tar.gz |
68dc0745 | 463 | module, which is curses-based, can help with this. |
464 | ||
68dc0745 | 465 | =head2 How can I make my Perl program run faster? |
466 | ||
92c2ed05 | 467 | The best way to do this is to come up with a better algorithm. This |
b73a15ae | 468 | can often make a dramatic difference. Jon Bentley's book |
92c2ed05 GS |
469 | ``Programming Pearls'' (that's not a misspelling!) has some good tips |
470 | on optimization, too. Advice on benchmarking boils down to: benchmark | |
471 | and profile to make sure you're optimizing the right part, look for | |
472 | better algorithms instead of microtuning your code, and when all else | |
57b19278 JS |
473 | fails consider just buying faster hardware. You will probably want to |
474 | read the answer to the earlier question ``How do I profile my Perl programs?'' | |
475 | if you haven't done so already. | |
68dc0745 | 476 | |
92c2ed05 | 477 | A different approach is to autoload seldom-used Perl code. See the |
68dc0745 | 478 | AutoSplit and AutoLoader modules in the standard distribution for |
479 | that. Or you could locate the bottleneck and think about writing just | |
480 | that part in C, the way we used to take bottlenecks in C code and | |
a6dd486b JB |
481 | write them in assembler. Similar to rewriting in C, |
482 | modules that have critical sections can be written in C (for instance, the | |
68dc0745 | 483 | PDL module from CPAN). |
484 | ||
485 | In some cases, it may be worth it to use the backend compiler to | |
486 | produce byte code (saving compilation time) or compile into C, which | |
487 | will certainly save compilation time and sometimes a small amount (but | |
488 | not much) execution time. See the question about compiling your Perl | |
92c2ed05 GS |
489 | programs for more on the compiler--the wins aren't as obvious as you'd |
490 | hope. | |
68dc0745 | 491 | |
92c2ed05 | 492 | If you're currently linking your perl executable to a shared I<libc.so>, |
68dc0745 | 493 | you can often gain a 10-25% performance benefit by rebuilding it to |
494 | link with a static libc.a instead. This will make a bigger perl | |
495 | executable, but your Perl programs (and programmers) may thank you for | |
496 | it. See the F<INSTALL> file in the source distribution for more | |
497 | information. | |
498 | ||
499 | Unsubstantiated reports allege that Perl interpreters that use sfio | |
87275199 | 500 | outperform those that don't (for I/O intensive applications). To try |
68dc0745 | 501 | this, see the F<INSTALL> file in the source distribution, especially |
87275199 | 502 | the ``Selecting File I/O mechanisms'' section. |
68dc0745 | 503 | |
504 | The undump program was an old attempt to speed up your Perl program | |
505 | by storing the already-compiled form to disk. This is no longer | |
506 | a viable option, as it only worked on a few architectures, and | |
507 | wasn't a good solution anyway. | |
508 | ||
509 | =head2 How can I make my Perl program take less memory? | |
510 | ||
511 | When it comes to time-space tradeoffs, Perl nearly always prefers to | |
512 | throw memory at a problem. Scalars in Perl use more memory than | |
65acb1b1 | 513 | strings in C, arrays take more than that, and hashes use even more. While |
68dc0745 | 514 | there's still a lot to be done, recent releases have been addressing |
515 | these issues. For example, as of 5.004, duplicate hash keys are | |
516 | shared amongst all hashes using them, so require no reallocation. | |
517 | ||
518 | In some cases, using substr() or vec() to simulate arrays can be | |
519 | highly beneficial. For example, an array of a thousand booleans will | |
520 | take at least 20,000 bytes of space, but it can be turned into one | |
a6dd486b | 521 | 125-byte bit vector--a considerable memory savings. The standard |
68dc0745 | 522 | Tie::SubstrHash module can also help for certain types of data |
523 | structure. If you're working with specialist data structures | |
524 | (matrices, for instance) modules that implement these in C may use | |
525 | less memory than equivalent Perl modules. | |
526 | ||
527 | Another thing to try is learning whether your Perl was compiled with | |
54310121 | 528 | the system malloc or with Perl's builtin malloc. Whichever one it |
68dc0745 | 529 | is, try using the other one and see whether this makes a difference. |
530 | Information about malloc is in the F<INSTALL> file in the source | |
531 | distribution. You can find out whether you are using perl's malloc by | |
532 | typing C<perl -V:usemymalloc>. | |
533 | ||
24f1ba9b JH |
534 | Of course, the best way to save memory is to not do anything to waste |
535 | it in the first place. Good programming practices can go a long way | |
536 | toward this: | |
537 | ||
538 | =over 4 | |
539 | ||
540 | =item * Don't slurp! | |
541 | ||
542 | Don't read an entire file into memory if you can process it line | |
543 | by line. Or more concretely, use a loop like this: | |
544 | ||
545 | # | |
546 | # Good Idea | |
547 | # | |
548 | while (<FILE>) { | |
549 | # ... | |
550 | } | |
551 | ||
552 | instead of this: | |
553 | ||
554 | # | |
555 | # Bad Idea | |
556 | # | |
557 | @data = <FILE>; | |
558 | foreach (@data) { | |
559 | # ... | |
560 | } | |
561 | ||
562 | When the files you're processing are small, it doesn't much matter which | |
563 | way you do it, but it makes a huge difference when they start getting | |
197aec24 | 564 | larger. |
24f1ba9b | 565 | |
bc06af74 JH |
566 | =item * Use map and grep selectively |
567 | ||
568 | Remember that both map and grep expect a LIST argument, so doing this: | |
569 | ||
570 | @wanted = grep {/pattern/} <FILE>; | |
571 | ||
572 | will cause the entire file to be slurped. For large files, it's better | |
573 | to loop: | |
574 | ||
575 | while (<FILE>) { | |
576 | push(@wanted, $_) if /pattern/; | |
577 | } | |
578 | ||
579 | =item * Avoid unnecessary quotes and stringification | |
580 | ||
581 | Don't quote large strings unless absolutely necessary: | |
582 | ||
583 | my $copy = "$large_string"; | |
584 | ||
585 | makes 2 copies of $large_string (one for $copy and another for the | |
586 | quotes), whereas | |
587 | ||
588 | my $copy = $large_string; | |
589 | ||
590 | only makes one copy. | |
591 | ||
592 | Ditto for stringifying large arrays: | |
593 | ||
594 | { | |
595 | local $, = "\n"; | |
596 | print @big_array; | |
597 | } | |
598 | ||
599 | is much more memory-efficient than either | |
600 | ||
601 | print join "\n", @big_array; | |
602 | ||
603 | or | |
604 | ||
605 | { | |
606 | local $" = "\n"; | |
607 | print "@big_array"; | |
608 | } | |
609 | ||
610 | ||
24f1ba9b JH |
611 | =item * Pass by reference |
612 | ||
613 | Pass arrays and hashes by reference, not by value. For one thing, it's | |
614 | the only way to pass multiple lists or hashes (or both) in a single | |
615 | call/return. It also avoids creating a copy of all the contents. This | |
616 | requires some judgment, however, because any changes will be propagated | |
617 | back to the original data. If you really want to mangle (er, modify) a | |
618 | copy, you'll have to sacrifice the memory needed to make one. | |
619 | ||
620 | =item * Tie large variables to disk. | |
621 | ||
622 | For "big" data stores (i.e. ones that exceed available memory) consider | |
623 | using one of the DB modules to store it on disk instead of in RAM. This | |
ed8cf1fe | 624 | will incur a penalty in access time, but that's probably better than |
24f1ba9b JH |
625 | causing your hard disk to thrash due to massive swapping. |
626 | ||
627 | =back | |
628 | ||
49d635f9 | 629 | =head2 Is it safe to return a reference to local or lexical data? |
68dc0745 | 630 | |
49d635f9 RGS |
631 | Yes. Perl's garbage collection system takes care of this so |
632 | everything works out right. | |
68dc0745 | 633 | |
634 | sub makeone { | |
635 | my @a = ( 1 .. 10 ); | |
636 | return \@a; | |
637 | } | |
638 | ||
197aec24 | 639 | for ( 1 .. 10 ) { |
68dc0745 | 640 | push @many, makeone(); |
641 | } | |
642 | ||
643 | print $many[4][5], "\n"; | |
644 | ||
645 | print "@many\n"; | |
646 | ||
647 | =head2 How can I free an array or hash so my program shrinks? | |
648 | ||
2c646907 JH |
649 | You usually can't. On most operating systems, memory |
650 | allocated to a program can never be returned to the system. | |
651 | That's why long-running programs sometimes re-exec | |
652 | themselves. Some operating systems (notably, systems that | |
653 | use mmap(2) for allocating large chunks of memory) can | |
654 | reclaim memory that is no longer used, but on such systems, | |
655 | perl must be configured and compiled to use the OS's malloc, | |
656 | not perl's. | |
68dc0745 | 657 | |
658 | However, judicious use of my() on your variables will help make sure | |
a6dd486b | 659 | that they go out of scope so that Perl can free up that space for |
92c2ed05 | 660 | use in other parts of your program. A global variable, of course, never |
68dc0745 | 661 | goes out of scope, so you can't get its space automatically reclaimed, |
662 | although undef()ing and/or delete()ing it will achieve the same effect. | |
46fc3d4c | 663 | In general, memory allocation and de-allocation isn't something you can |
68dc0745 | 664 | or should be worrying about much in Perl, but even this capability |
665 | (preallocation of data types) is in the works. | |
666 | ||
667 | =head2 How can I make my CGI script more efficient? | |
668 | ||
669 | Beyond the normal measures described to make general Perl programs | |
670 | faster or smaller, a CGI program has additional issues. It may be run | |
671 | several times per second. Given that each time it runs it will need | |
46fc3d4c | 672 | to be re-compiled and will often allocate a megabyte or more of system |
68dc0745 | 673 | memory, this can be a killer. Compiling into C B<isn't going to help |
46fc3d4c | 674 | you> because the process start-up overhead is where the bottleneck is. |
68dc0745 | 675 | |
92c2ed05 GS |
676 | There are two popular ways to avoid this overhead. One solution |
677 | involves running the Apache HTTP server (available from | |
f224927c | 678 | http://www.apache.org/ ) with either of the mod_perl or mod_fastcgi |
92c2ed05 GS |
679 | plugin modules. |
680 | ||
681 | With mod_perl and the Apache::Registry module (distributed with | |
682 | mod_perl), httpd will run with an embedded Perl interpreter which | |
683 | pre-compiles your script and then executes it within the same address | |
684 | space without forking. The Apache extension also gives Perl access to | |
685 | the internal server API, so modules written in Perl can do just about | |
686 | anything a module written in C can. For more on mod_perl, see | |
687 | http://perl.apache.org/ | |
688 | ||
65acb1b1 | 689 | With the FCGI module (from CPAN) and the mod_fastcgi |
bfeeaf1b | 690 | module (available from http://www.fastcgi.com/ ) each of your Perl |
87275199 | 691 | programs becomes a permanent CGI daemon process. |
68dc0745 | 692 | |
693 | Both of these solutions can have far-reaching effects on your system | |
87275199 | 694 | and on the way you write your CGI programs, so investigate them with |
68dc0745 | 695 | care. |
696 | ||
a93751fa | 697 | See http://www.cpan.org/modules/by-category/15_World_Wide_Web_HTML_HTTP_CGI/ . |
5a964f20 | 698 | |
65acb1b1 | 699 | A non-free, commercial product, ``The Velocity Engine for Perl'', |
a6dd486b JB |
700 | (http://www.binevolve.com/ or http://www.binevolve.com/velocigen/ ) |
701 | might also be worth looking at. It will allow you to increase the | |
702 | performance of your Perl programs, running programs up to 25 times | |
703 | faster than normal CGI Perl when running in persistent Perl mode or 4 | |
704 | to 5 times faster without any modification to your existing CGI | |
705 | programs. Fully functional evaluation copies are available from the | |
706 | web site. | |
c8db1d39 | 707 | |
68dc0745 | 708 | =head2 How can I hide the source for my Perl program? |
709 | ||
710 | Delete it. :-) Seriously, there are a number of (mostly | |
92c2ed05 | 711 | unsatisfactory) solutions with varying levels of ``security''. |
68dc0745 | 712 | |
713 | First of all, however, you I<can't> take away read permission, because | |
714 | the source code has to be readable in order to be compiled and | |
715 | interpreted. (That doesn't mean that a CGI script's source is | |
a6dd486b JB |
716 | readable by people on the web, though--only by people with access to |
717 | the filesystem.) So you have to leave the permissions at the socially | |
92c2ed05 | 718 | friendly 0755 level. |
68dc0745 | 719 | |
720 | Some people regard this as a security problem. If your program does | |
a6dd486b | 721 | insecure things and relies on people not knowing how to exploit those |
68dc0745 | 722 | insecurities, it is not secure. It is often possible for someone to |
723 | determine the insecure things and exploit them without viewing the | |
724 | source. Security through obscurity, the name for hiding your bugs | |
725 | instead of fixing them, is little security indeed. | |
726 | ||
83df6a1d JH |
727 | You can try using encryption via source filters (Starting from Perl |
728 | 5.8 the Filter::Simple and Filter::Util::Call modules are included in | |
729 | the standard distribution), but any decent programmer will be able to | |
730 | decrypt it. You can try using the byte code compiler and interpreter | |
731 | described below, but the curious might still be able to de-compile it. | |
732 | You can try using the native-code compiler described below, but | |
733 | crackers might be able to disassemble it. These pose varying degrees | |
734 | of difficulty to people wanting to get at your code, but none can | |
735 | definitively conceal it (true of every language, not just Perl). | |
68dc0745 | 736 | |
49d635f9 RGS |
737 | It is very easy to recover the source of Perl programs. You simply |
738 | feed the program to the perl interpreter and use the modules in | |
739 | the B:: hierarchy. The B::Deparse module should be able to | |
740 | defeat most attempts to hide source. Again, this is not | |
741 | unique to Perl. | |
742 | ||
68dc0745 | 743 | If you're concerned about people profiting from your code, then the |
d92eb7b0 | 744 | bottom line is that nothing but a restrictive license will give you |
68dc0745 | 745 | legal security. License your software and pepper it with threatening |
92c2ed05 | 746 | statements like ``This is unpublished proprietary software of XYZ Corp. |
68dc0745 | 747 | Your access to it does not give you permission to use it blah blah |
92c2ed05 | 748 | blah.'' We are not lawyers, of course, so you should see a lawyer if |
d92eb7b0 | 749 | you want to be sure your license's wording will stand up in court. |
68dc0745 | 750 | |
54310121 | 751 | =head2 How can I compile my Perl program into byte code or C? |
68dc0745 | 752 | |
753 | Malcolm Beattie has written a multifunction backend compiler, | |
5e3006a4 GS |
754 | available from CPAN, that can do both these things. It is included |
755 | in the perl5.005 release, but is still considered experimental. | |
756 | This means it's fun to play with if you're a programmer but not | |
757 | really for people looking for turn-key solutions. | |
68dc0745 | 758 | |
92c2ed05 GS |
759 | Merely compiling into C does not in and of itself guarantee that your |
760 | code will run very much faster. That's because except for lucky cases | |
761 | where a lot of native type inferencing is possible, the normal Perl | |
a6dd486b | 762 | run-time system is still present and so your program will take just as |
92c2ed05 GS |
763 | long to run and be just as big. Most programs save little more than |
764 | compilation time, leaving execution no more than 10-30% faster. A few | |
a6dd486b | 765 | rare programs actually benefit significantly (even running several times |
92c2ed05 | 766 | faster), but this takes some tweaking of your code. |
68dc0745 | 767 | |
68dc0745 | 768 | You'll probably be astonished to learn that the current version of the |
769 | compiler generates a compiled form of your script whose executable is | |
770 | just as big as the original perl executable, and then some. That's | |
771 | because as currently written, all programs are prepared for a full | |
772 | eval() statement. You can tremendously reduce this cost by building a | |
92c2ed05 | 773 | shared I<libperl.so> library and linking against that. See the |
87275199 | 774 | F<INSTALL> podfile in the Perl source distribution for details. If |
d92eb7b0 | 775 | you link your main perl binary with this, it will make it minuscule. |
92c2ed05 | 776 | For example, on one author's system, F</usr/bin/perl> is only 11k in |
68dc0745 | 777 | size! |
778 | ||
5a964f20 | 779 | In general, the compiler will do nothing to make a Perl program smaller, |
a6dd486b JB |
780 | faster, more portable, or more secure. In fact, it can make your |
781 | situation worse. The executable will be bigger, your VM system may take | |
5a964f20 TC |
782 | longer to load the whole thing, the binary is fragile and hard to fix, |
783 | and compilation never stopped software piracy in the form of crackers, | |
784 | viruses, or bootleggers. The real advantage of the compiler is merely | |
785 | packaging, and once you see the size of what it makes (well, unless | |
786 | you use a shared I<libperl.so>), you'll probably want a complete | |
5e3006a4 | 787 | Perl install anyway. |
5a964f20 | 788 | |
65acb1b1 TC |
789 | =head2 How can I compile Perl into Java? |
790 | ||
a6dd486b | 791 | You can also integrate Java and Perl with the |
65acb1b1 | 792 | Perl Resource Kit from O'Reilly and Associates. See |
a6dd486b JB |
793 | http://www.oreilly.com/catalog/prkunix/ . |
794 | ||
795 | Perl 5.6 comes with Java Perl Lingo, or JPL. JPL, still in | |
796 | development, allows Perl code to be called from Java. See jpl/README | |
797 | in the Perl source tree. | |
65acb1b1 | 798 | |
92c2ed05 | 799 | =head2 How can I get C<#!perl> to work on [MS-DOS,NT,...]? |
68dc0745 | 800 | |
801 | For OS/2 just use | |
802 | ||
803 | extproc perl -S -your_switches | |
804 | ||
805 | as the first line in C<*.cmd> file (C<-S> due to a bug in cmd.exe's | |
46fc3d4c | 806 | `extproc' handling). For DOS one should first invent a corresponding |
a6dd486b | 807 | batch file and codify it in C<ALTERNATIVE_SHEBANG> (see the |
68dc0745 | 808 | F<INSTALL> file in the source distribution for more information). |
809 | ||
92c2ed05 GS |
810 | The Win95/NT installation, when using the ActiveState port of Perl, |
811 | will modify the Registry to associate the C<.pl> extension with the | |
d92eb7b0 GS |
812 | perl interpreter. If you install another port, perhaps even building |
813 | your own Win95/NT Perl from the standard sources by using a Windows port | |
d702ae42 | 814 | of gcc (e.g., with cygwin or mingw32), then you'll have to modify |
d92eb7b0 GS |
815 | the Registry yourself. In addition to associating C<.pl> with the |
816 | interpreter, NT people can use: C<SET PATHEXT=%PATHEXT%;.PL> to let them | |
817 | run the program C<install-linux.pl> merely by typing C<install-linux>. | |
68dc0745 | 818 | |
87275199 GS |
819 | Macintosh Perl programs will have the appropriate Creator and |
820 | Type, so that double-clicking them will invoke the Perl application. | |
68dc0745 | 821 | |
822 | I<IMPORTANT!>: Whatever you do, PLEASE don't get frustrated, and just | |
823 | throw the perl interpreter into your cgi-bin directory, in order to | |
87275199 | 824 | get your programs working for a web server. This is an EXTREMELY big |
68dc0745 | 825 | security risk. Take the time to figure out how to do it correctly. |
826 | ||
87275199 | 827 | =head2 Can I write useful Perl programs on the command line? |
68dc0745 | 828 | |
829 | Yes. Read L<perlrun> for more information. Some examples follow. | |
830 | (These assume standard Unix shell quoting rules.) | |
831 | ||
832 | # sum first and last fields | |
5a964f20 | 833 | perl -lane 'print $F[0] + $F[-1]' * |
68dc0745 | 834 | |
835 | # identify text files | |
836 | perl -le 'for(@ARGV) {print if -f && -T _}' * | |
837 | ||
5a964f20 | 838 | # remove (most) comments from C program |
68dc0745 | 839 | perl -0777 -pe 's{/\*.*?\*/}{}gs' foo.c |
840 | ||
841 | # make file a month younger than today, defeating reaper daemons | |
842 | perl -e '$X=24*60*60; utime(time(),time() + 30 * $X,@ARGV)' * | |
843 | ||
844 | # find first unused uid | |
845 | perl -le '$i++ while getpwuid($i); print $i' | |
846 | ||
847 | # display reasonable manpath | |
848 | echo $PATH | perl -nl -072 -e ' | |
849 | s![^/+]*$!man!&&-d&&!$s{$_}++&&push@m,$_;END{print"@m"}' | |
850 | ||
87275199 | 851 | OK, the last one was actually an Obfuscated Perl Contest entry. :-) |
68dc0745 | 852 | |
87275199 | 853 | =head2 Why don't Perl one-liners work on my DOS/Mac/VMS system? |
68dc0745 | 854 | |
855 | The problem is usually that the command interpreters on those systems | |
856 | have rather different ideas about quoting than the Unix shells under | |
857 | which the one-liners were created. On some systems, you may have to | |
858 | change single-quotes to double ones, which you must I<NOT> do on Unix | |
859 | or Plan9 systems. You might also have to change a single % to a %%. | |
860 | ||
861 | For example: | |
862 | ||
863 | # Unix | |
864 | perl -e 'print "Hello world\n"' | |
865 | ||
46fc3d4c | 866 | # DOS, etc. |
68dc0745 | 867 | perl -e "print \"Hello world\n\"" |
868 | ||
46fc3d4c | 869 | # Mac |
68dc0745 | 870 | print "Hello world\n" |
871 | (then Run "Myscript" or Shift-Command-R) | |
872 | ||
d2321c93 JH |
873 | # MPW |
874 | perl -e 'print "Hello world\n"' | |
875 | ||
68dc0745 | 876 | # VMS |
877 | perl -e "print ""Hello world\n""" | |
878 | ||
a6dd486b | 879 | The problem is that none of these examples are reliable: they depend on the |
92c2ed05 | 880 | command interpreter. Under Unix, the first two often work. Under DOS, |
a6dd486b | 881 | it's entirely possible that neither works. If 4DOS was the command shell, |
92c2ed05 | 882 | you'd probably have better luck like this: |
68dc0745 | 883 | |
884 | perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>"" | |
885 | ||
46fc3d4c | 886 | Under the Mac, it depends which environment you are using. The MacPerl |
68dc0745 | 887 | shell, or MPW, is much like Unix shells in its support for several |
46fc3d4c | 888 | quoting variants, except that it makes free use of the Mac's non-ASCII |
68dc0745 | 889 | characters as control characters. |
890 | ||
65acb1b1 TC |
891 | Using qq(), q(), and qx(), instead of "double quotes", 'single |
892 | quotes', and `backticks`, may make one-liners easier to write. | |
893 | ||
d2321c93 | 894 | There is no general solution to all of this. It is a mess. |
68dc0745 | 895 | |
896 | [Some of this answer was contributed by Kenneth Albanowski.] | |
897 | ||
898 | =head2 Where can I learn about CGI or Web programming in Perl? | |
899 | ||
900 | For modules, get the CGI or LWP modules from CPAN. For textbooks, | |
901 | see the two especially dedicated to web stuff in the question on | |
92c2ed05 GS |
902 | books. For problems and questions related to the web, like ``Why |
903 | do I get 500 Errors'' or ``Why doesn't it run from the browser right | |
8305e449 JH |
904 | when it runs fine on the command line'', see the troubleshooting |
905 | guides and references in L<perlfaq9> or in the CGI MetaFAQ: | |
68dc0745 | 906 | |
8305e449 | 907 | http://www.perl.org/CGI_MetaFAQ.html |
0f542199 | 908 | |
68dc0745 | 909 | =head2 Where can I learn about object-oriented Perl programming? |
910 | ||
a6dd486b | 911 | A good place to start is L<perltoot>, and you can use L<perlobj>, |
06a5f41f JH |
912 | L<perlboot>, L<perltoot>, L<perltooc>, and L<perlbot> for reference. |
913 | (If you are using really old Perl, you may not have all of these, | |
914 | try http://www.perldoc.com/ , but consider upgrading your perl.) | |
915 | ||
916 | A good book on OO on Perl is the "Object-Oriented Perl" | |
197aec24 | 917 | by Damian Conway from Manning Publications, |
06a5f41f | 918 | http://www.manning.com/Conway/index.html |
68dc0745 | 919 | |
920 | =head2 Where can I learn about linking C with Perl? [h2xs, xsubpp] | |
921 | ||
922 | If you want to call C from Perl, start with L<perlxstut>, | |
923 | moving on to L<perlxs>, L<xsubpp>, and L<perlguts>. If you want to | |
924 | call Perl from C, then read L<perlembed>, L<perlcall>, and | |
925 | L<perlguts>. Don't forget that you can learn a lot from looking at | |
926 | how the authors of existing extension modules wrote their code and | |
927 | solved their problems. | |
928 | ||
929 | =head2 I've read perlembed, perlguts, etc., but I can't embed perl in | |
a6dd486b | 930 | my C program; what am I doing wrong? |
68dc0745 | 931 | |
932 | Download the ExtUtils::Embed kit from CPAN and run `make test'. If | |
933 | the tests pass, read the pods again and again and again. If they | |
87275199 | 934 | fail, see L<perlbug> and send a bug report with the output of |
68dc0745 | 935 | C<make test TEST_VERBOSE=1> along with C<perl -V>. |
936 | ||
83ded9ee | 937 | =head2 When I tried to run my script, I got this message. What does it mean? |
68dc0745 | 938 | |
87275199 GS |
939 | A complete list of Perl's error messages and warnings with explanatory |
940 | text can be found in L<perldiag>. You can also use the splain program | |
941 | (distributed with Perl) to explain the error messages: | |
68dc0745 | 942 | |
943 | perl program 2>diag.out | |
944 | splain [-v] [-p] diag.out | |
945 | ||
946 | or change your program to explain the messages for you: | |
947 | ||
948 | use diagnostics; | |
949 | ||
950 | or | |
951 | ||
952 | use diagnostics -verbose; | |
953 | ||
954 | =head2 What's MakeMaker? | |
955 | ||
87275199 | 956 | This module (part of the standard Perl distribution) is designed to |
68dc0745 | 957 | write a Makefile for an extension module from a Makefile.PL. For more |
958 | information, see L<ExtUtils::MakeMaker>. | |
959 | ||
960 | =head1 AUTHOR AND COPYRIGHT | |
961 | ||
0bc0ad85 | 962 | Copyright (c) 1997-2002 Tom Christiansen and Nathan Torkington. |
5a964f20 TC |
963 | All rights reserved. |
964 | ||
5a7beb56 JH |
965 | This documentation is free; you can redistribute it and/or modify it |
966 | under the same terms as Perl itself. | |
c8db1d39 | 967 | |
87275199 | 968 | Irrespective of its distribution, all code examples here are in the public |
c8db1d39 TC |
969 | domain. You are permitted and encouraged to use this code and any |
970 | derivatives thereof in your own programs for fun or for profit as you | |
971 | see fit. A simple comment in the code giving credit to the FAQ would | |
972 | be courteous but is not required. |