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