This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate changes #8687,8736 from maintperl.
[perl5.git] / pod / perlfaq3.pod
CommitLineData
68dc0745 1=head1 NAME
2
d92eb7b0 3perlfaq3 - Programming Tools ($Revision: 1.38 $, $Date: 1999/05/23 16:08:30 $)
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.
46fc3d4c 14Have you read the appropriate man pages? 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
25 Various http://www.perl.com/CPAN/doc/FMTEYEWTK/index.html
26 (not a man-page but still useful)
27
87275199 28A crude table of contents for the Perl man page set is found in L<perltoc>.
68dc0745 29
30=head2 How can I use Perl interactively?
31
32The typical approach uses the Perl debugger, described in the
92c2ed05 33perldebug(1) man page, on an ``empty'' program, like this:
68dc0745 34
35 perl -de 42
36
37Now just type in any legal Perl code, and it will be immediately
38evaluated. You can also examine the symbol table, get stack
39backtraces, check variable values, set breakpoints, and other
92c2ed05 40operations typically found in symbolic debuggers.
68dc0745 41
42=head2 Is there a Perl shell?
43
87275199
GS
44In general, no. The Shell.pm module (distributed with Perl) makes
45Perl try commands which aren't part of the Perl language as shell
68dc0745 46commands. perlsh from the source distribution is simplistic and
47uninteresting, but may still be what you want.
48
49=head2 How do I debug my Perl programs?
50
9f1b1f2d 51Have you tried C<use warnings> or used C<-w>? They enable warnings
a6dd486b 52to detect dubious practices.
68dc0745 53
92c2ed05
GS
54Have you tried C<use strict>? It prevents you from using symbolic
55references, makes you predeclare any subroutines that you call as bare
56words, and (probably most importantly) forces you to predeclare your
a6dd486b 57variables with C<my>, C<our>, or C<use vars>.
68dc0745 58
a6dd486b
JB
59Did you check the return values of each and every system call? The operating
60system (and thus Perl) tells you whether they worked, and if not
92c2ed05 61why.
68dc0745 62
92c2ed05
GS
63 open(FH, "> /etc/cantwrite")
64 or die "Couldn't write to /etc/cantwrite: $!\n";
68dc0745 65
92c2ed05 66Did you read L<perltrap>? It's full of gotchas for old and new Perl
a6dd486b 67programmers and even has sections for those of you who are upgrading
92c2ed05
GS
68from languages like I<awk> and I<C>.
69
70Have you tried the Perl debugger, described in L<perldebug>? You can
71step through your program and see what it's doing and thus work out
72why what it's doing isn't what it should be doing.
68dc0745 73
74=head2 How do I profile my Perl programs?
75
e083a89c 76You should get the Devel::DProf module from the standard distribution
733271b5
PK
77(or separately on CPAN) and also use Benchmark.pm from the standard
78distribution. The Benchmark module lets you time specific portions of
79your code, while Devel::DProf gives detailed breakdowns of where your
e083a89c 80code spends its time.
68dc0745 81
92c2ed05
GS
82Here's a sample use of Benchmark:
83
84 use Benchmark;
85
86 @junk = `cat /etc/motd`;
87 $count = 10_000;
88
89 timethese($count, {
90 'map' => sub { my @a = @junk;
91 map { s/a/b/ } @a;
92 return @a
93 },
94 'for' => sub { my @a = @junk;
95 local $_;
96 for (@a) { s/a/b/ };
97 return @a },
98 });
99
100This is what it prints (on one machine--your results will be dependent
101on your hardware, operating system, and the load on your machine):
102
103 Benchmark: timing 10000 iterations of for, map...
104 for: 4 secs ( 3.97 usr 0.01 sys = 3.98 cpu)
105 map: 6 secs ( 4.97 usr 0.00 sys = 4.97 cpu)
106
65acb1b1 107Be aware that a good benchmark is very hard to write. It only tests the
a6dd486b 108data you give it and proves little about the differing complexities
65acb1b1
TC
109of contrasting algorithms.
110
68dc0745 111=head2 How do I cross-reference my Perl programs?
112
113The B::Xref module, shipped with the new, alpha-release Perl compiler
5a964f20
TC
114(not the general distribution prior to the 5.005 release), can be used
115to generate cross-reference reports for Perl programs.
68dc0745 116
c8db1d39 117 perl -MO=Xref[,OPTIONS] scriptname.plx
68dc0745 118
119=head2 Is there a pretty-printer (formatter) for Perl?
120
92c2ed05
GS
121There is no program that will reformat Perl as much as indent(1) does
122for C. The complex feedback between the scanner and the parser (this
123feedback is what confuses the vgrind and emacs programs) makes it
68dc0745 124challenging at best to write a stand-alone Perl parser.
125
126Of course, if you simply follow the guidelines in L<perlstyle>, you
92c2ed05
GS
127shouldn't need to reformat. The habit of formatting your code as you
128write it will help prevent bugs. Your editor can and should help you
a6dd486b
JB
129with this. The perl-mode or newer cperl-mode for emacs can provide
130remarkable amounts of help with most (but not all) code, and even less
131programmable editors can provide significant assistance. Tom swears
132by the following settings in vi and its clones:
65acb1b1
TC
133
134 set ai sw=4
d92eb7b0 135 map! ^O {^M}^[O^T
65acb1b1
TC
136
137Now put that in your F<.exrc> file (replacing the caret characters
138with control characters) and away you go. In insert mode, ^T is
a6dd486b 139for indenting, ^D is for undenting, and ^O is for blockdenting--
65acb1b1
TC
140as it were. If you haven't used the last one, you're missing
141a lot. A more complete example, with comments, can be found at
142http://www.perl.com/CPAN-local/authors/id/TOMC/scripts/toms.exrc.gz
92c2ed05 143
65acb1b1 144If you are used to using the I<vgrind> program for printing out nice code
92c2ed05 145to a laser printer, you can take a stab at this using
68dc0745 146http://www.perl.com/CPAN/doc/misc/tips/working.vgrind.entry, but the
147results are not particularly satisfying for sophisticated code.
148
87275199 149The a2ps at http://www.infres.enst.fr/%7Edemaille/a2ps/ does lots of things
65acb1b1
TC
150related to generating nicely printed output of documents.
151
d92eb7b0 152=head2 Is there a ctags for Perl?
68dc0745 153
d92eb7b0 154There's a simple one at
68dc0745 155http://www.perl.com/CPAN/authors/id/TOMC/scripts/ptags.gz which may do
65acb1b1
TC
156the trick. And if not, it's easy to hack into what you want.
157
158=head2 Is there an IDE or Windows Perl Editor?
159
6641ed39
JH
160Perl programs are just plain text, so any editor will do.
161
6641ed39
JH
162If you're on Unix, you already have an IDE--Unix itself. The UNIX
163philosophy is the philosophy of several small tools that each do one
164thing and do it well. It's like a carpenter's toolbox.
165
5a13f98a
JH
166If you want a Windows IDE, check the following: PerlBuilder
167(http://www.solutionsoft.com/perl.htm) is an integrated development
168environment for Windows that supports Perl development. Komodo,
169ActiveState's cross-platform, multi-language IDE has Perl support,
170including a regular expression debugger and remote debugging
171(http://www.ActiveState.com/Products/Komodo/index.html).
172(Visual Perl, a Visual Studio.NET plug-in is currently (late 2000)
173in beta (http://www.ActiveState.com/Products/VisualPerl/index.html)).
12134a58 174The visiPerl+ IDE is available from Help Consulting
6641ed39
JH
175(http://helpconsulting.net/visiperl/). Perl code magic is another IDE
176(http://www.petes-place.com/codemagic.html). CodeMagicCD
12134a58 177(http://www.codemagiccd.com/) is another IDE. The Object System
8782d048 178(http://www.castlelink.co.uk/object_system/) is a Perl web
614a1598 179applications development IDE.
8782d048 180
5a13f98a 181For editors: if you're on Unix you probably have vi or a vi clone already,
6641ed39 182and possibly an emacs too, so you may not need to download anything.
5a13f98a 183In any emacs the cperl-mode (M-x cperl-mode) gives you perhaps the
6641ed39
JH
184best available Perl editing mode in any editor.
185
5a13f98a 186For Windows editors: you can download GNU Emacs
6641ed39
JH
187(http://www.gnu.org/software/emacs/windows/ntemacs.html) or XEmacs
188(http://www.xemacs.org/Download/index.html), or a vi clone such as
189Elvis (ftp://ftp.cs.pdx.edu/pub/elvis/, http://www.fh-wedel.de/elvis/),
190Vile (http://www.clark.net/pub/dickey/vile/vile.html), or
191Vim (http://www.vim.org/) (win32: http://www.cs.vu.nl/%7Etmgil/vi.html).
5a13f98a
JH
192For vi lovers in general, Windows or elsewhere:
193http://www.thomer.com/thomer/vi/vi.html.
6641ed39
JH
194
195nvi (http://www.bostic.com/vi/, available from CPAN in src/misc/) is
5a13f98a 196yet another vi clone, unfortunately not available for Windows, but in
6641ed39
JH
197UNIX platforms you might be interested in trying it out, firstly because
198strictly speaking it is not a vi clone, it is the real vi, or the new
199incarnation of it, and secondly because you can embed Perl inside it
200to use Perl as the scripting language. nvi is not alone in this,
201though: at least also vim offers an embedded Perl.
614a1598
JH
202
203The following are Win32 multilanguage editor/IDESs that support Perl:
204Codewright (http://www.starbase.com/), MultiEdit (http://www.MultiEdit.com/),
205SlickEdit (http://www.slickedit.com/).
8782d048 206
6641ed39
JH
207There is also a toyedit Text widget based editor written in Perl
208that is distributed with the Tk module on CPAN. The ptkdb
8782d048
JH
209(http://world.std.com/~aep/ptkdb/) is a Perl/tk based debugger that
210acts as a development environment of sorts. Perl Composer
e083a89c
JH
211(http://perlcomposer.sourceforge.net/vperl.html) is an IDE for Perl/Tk
212GUI creation.
213
8782d048
JH
214In addition to an editor/IDE you might be interested in a more
215powerful shell environment for Win32. Your options include the Bash
216from the Cygwin package (http://sources.redhat.com/cygwin/), or the
217Ksh from the MKS Toolkit (http://www.mks.com/), or the Bourne shell of
218the U/WIN environment (http://www.research.att.com/sw/tools/uwin/), or
614a1598
JH
219the Tcsh (ftp://ftp.astron.com/pub/tcsh/, see also
220http://www.primate.wisc.edu/software/csh-tcsh-book/), or the Zsh
221(ftp://ftp.blarg.net/users/amol/zsh/, see also http://www.zsh.org/).
222MKS and U/WIN are commercial (U/WIN is free for educational and
223research purposes), Cygwin is covered by the GNU Public License (but
224that shouldn't matter for Perl use). The Cygwin, MKS, and U/WIN all
225contain (in addition to the shells) a comprehensive set of standard
226UNIX toolkit utilities.
8782d048 227
5a13f98a
JH
228If you're transferring text files between Unix and Windows using FTP
229be sure to transfer them in ASCII mode so the ends of lines are
230appropriately converted.
231
e083a89c
JH
232On Mac OS the MacPerl Application comes with a simple 32k text editor
233that behaves like a rudimentary IDE. In contrast to the MacPerl Application
733271b5 234the MPW Perl tool can make use of the MPW Shell itself as an editor (with
e083a89c 235no 32k limit). BBEdit and BBEdit Lite are text editors for Mac OS
733271b5
PK
236that have a Perl sensitivity mode (http://web.barebones.com/).
237Alpha is an editor, written and extensible in Tcl, that nonetheless has
238built in support for several popular markup and programming languages
239including Perl and HTML (http://alpha.olm.net/).
68dc0745 240
241=head2 Where can I get Perl macros for vi?
242
243For a complete version of Tom Christiansen's vi configuration file,
a6dd486b
JB
244see http://www.perl.com/CPAN/authors/Tom_Christiansen/scripts/toms.exrc.gz ,
245the standard benchmark file for vi emulators. The file runs best with nvi,
5a964f20 246the current version of vi out of Berkeley, which incidentally can be built
a6dd486b 247with an embedded Perl interpreter--see http://www.perl.com/CPAN/src/misc.
68dc0745 248
249=head2 Where can I get perl-mode for emacs?
250
251Since Emacs version 19 patchlevel 22 or so, there have been both a
87275199 252perl-mode.el and support for the Perl debugger built in. These should
68dc0745 253come with the standard Emacs 19 distribution.
254
87275199 255In the Perl source directory, you'll find a directory called "emacs",
68dc0745 256which contains a cperl-mode that color-codes keywords, provides
257context-sensitive help, and other nifty things.
258
92c2ed05 259Note that the perl-mode of emacs will have fits with C<"main'foo">
d92eb7b0 260(single quote), and mess up the indentation and highlighting. You
65acb1b1 261are probably using C<"main::foo"> in new Perl code anyway, so this
92c2ed05 262shouldn't be an issue.
68dc0745 263
264=head2 How can I use curses with Perl?
265
266The Curses module from CPAN provides a dynamically loadable object
5a964f20
TC
267module interface to a curses library. A small demo can be found at the
268directory http://www.perl.com/CPAN/authors/Tom_Christiansen/scripts/rep;
269this program repeats a command and updates the screen as needed, rendering
270B<rep ps axu> similar to B<top>.
68dc0745 271
272=head2 How can I use X or Tk with Perl?
273
5a964f20
TC
274Tk is a completely Perl-based, object-oriented interface to the Tk toolkit
275that doesn't force you to use Tcl just to get at Tk. Sx is an interface
276to the Athena Widget set. Both are available from CPAN. See the
277directory http://www.perl.com/CPAN/modules/by-category/08_User_Interfaces/
68dc0745 278
a6dd486b 279Invaluable for Perl/Tk programming are the Perl/Tk FAQ at
87275199 280http://w4.lns.cornell.edu/%7Epvhp/ptk/ptkTOC.html , the Perl/Tk Reference
92c2ed05
GS
281Guide available at
282http://www.perl.com/CPAN-local/authors/Stephen_O_Lidie/ , and the
283online manpages at
87275199 284http://www-users.cs.umn.edu/%7Eamundson/perl/perltk/toc.html .
92c2ed05 285
68dc0745 286=head2 How can I generate simple menus without using CGI or Tk?
287
288The http://www.perl.com/CPAN/authors/id/SKUNZ/perlmenu.v4.0.tar.gz
289module, which is curses-based, can help with this.
290
68dc0745 291=head2 What is undump?
292
a6dd486b 293See the next question on ``How can I make my Perl program run faster?''
68dc0745 294
295=head2 How can I make my Perl program run faster?
296
92c2ed05 297The best way to do this is to come up with a better algorithm. This
b73a15ae 298can often make a dramatic difference. Jon Bentley's book
92c2ed05
GS
299``Programming Pearls'' (that's not a misspelling!) has some good tips
300on optimization, too. Advice on benchmarking boils down to: benchmark
301and profile to make sure you're optimizing the right part, look for
302better algorithms instead of microtuning your code, and when all else
303fails consider just buying faster hardware.
68dc0745 304
92c2ed05 305A different approach is to autoload seldom-used Perl code. See the
68dc0745 306AutoSplit and AutoLoader modules in the standard distribution for
307that. Or you could locate the bottleneck and think about writing just
308that part in C, the way we used to take bottlenecks in C code and
a6dd486b
JB
309write them in assembler. Similar to rewriting in C,
310modules that have critical sections can be written in C (for instance, the
68dc0745 311PDL module from CPAN).
312
313In some cases, it may be worth it to use the backend compiler to
314produce byte code (saving compilation time) or compile into C, which
315will certainly save compilation time and sometimes a small amount (but
316not much) execution time. See the question about compiling your Perl
92c2ed05
GS
317programs for more on the compiler--the wins aren't as obvious as you'd
318hope.
68dc0745 319
92c2ed05 320If you're currently linking your perl executable to a shared I<libc.so>,
68dc0745 321you can often gain a 10-25% performance benefit by rebuilding it to
322link with a static libc.a instead. This will make a bigger perl
323executable, but your Perl programs (and programmers) may thank you for
324it. See the F<INSTALL> file in the source distribution for more
325information.
326
327Unsubstantiated reports allege that Perl interpreters that use sfio
87275199 328outperform those that don't (for I/O intensive applications). To try
68dc0745 329this, see the F<INSTALL> file in the source distribution, especially
87275199 330the ``Selecting File I/O mechanisms'' section.
68dc0745 331
332The undump program was an old attempt to speed up your Perl program
333by storing the already-compiled form to disk. This is no longer
334a viable option, as it only worked on a few architectures, and
335wasn't a good solution anyway.
336
337=head2 How can I make my Perl program take less memory?
338
339When it comes to time-space tradeoffs, Perl nearly always prefers to
340throw memory at a problem. Scalars in Perl use more memory than
65acb1b1 341strings in C, arrays take more than that, and hashes use even more. While
68dc0745 342there's still a lot to be done, recent releases have been addressing
343these issues. For example, as of 5.004, duplicate hash keys are
344shared amongst all hashes using them, so require no reallocation.
345
346In some cases, using substr() or vec() to simulate arrays can be
347highly beneficial. For example, an array of a thousand booleans will
348take at least 20,000 bytes of space, but it can be turned into one
a6dd486b 349125-byte bit vector--a considerable memory savings. The standard
68dc0745 350Tie::SubstrHash module can also help for certain types of data
351structure. If you're working with specialist data structures
352(matrices, for instance) modules that implement these in C may use
353less memory than equivalent Perl modules.
354
355Another thing to try is learning whether your Perl was compiled with
54310121 356the system malloc or with Perl's builtin malloc. Whichever one it
68dc0745 357is, try using the other one and see whether this makes a difference.
358Information about malloc is in the F<INSTALL> file in the source
359distribution. You can find out whether you are using perl's malloc by
360typing C<perl -V:usemymalloc>.
361
362=head2 Is it unsafe to return a pointer to local data?
363
364No, Perl's garbage collection system takes care of this.
365
366 sub makeone {
367 my @a = ( 1 .. 10 );
368 return \@a;
369 }
370
371 for $i ( 1 .. 10 ) {
372 push @many, makeone();
373 }
374
375 print $many[4][5], "\n";
376
377 print "@many\n";
378
379=head2 How can I free an array or hash so my program shrinks?
380
c8db1d39
TC
381You can't. On most operating systems, memory allocated to a program
382can never be returned to the system. That's why long-running programs
65acb1b1
TC
383sometimes re-exec themselves. Some operating systems (notably,
384FreeBSD and Linux) allegedly reclaim large chunks of memory that is no
385longer used, but it doesn't appear to happen with Perl (yet). The Mac
386appears to be the only platform that will reliably (albeit, slowly)
387return memory to the OS.
388
389We've had reports that on Linux (Redhat 5.1) on Intel, C<undef
390$scalar> will return memory to the system, while on Solaris 2.6 it
391won't. In general, try it yourself and see.
68dc0745 392
393However, judicious use of my() on your variables will help make sure
a6dd486b 394that they go out of scope so that Perl can free up that space for
92c2ed05 395use in other parts of your program. A global variable, of course, never
68dc0745 396goes out of scope, so you can't get its space automatically reclaimed,
397although undef()ing and/or delete()ing it will achieve the same effect.
46fc3d4c 398In general, memory allocation and de-allocation isn't something you can
68dc0745 399or should be worrying about much in Perl, but even this capability
400(preallocation of data types) is in the works.
401
402=head2 How can I make my CGI script more efficient?
403
404Beyond the normal measures described to make general Perl programs
405faster or smaller, a CGI program has additional issues. It may be run
406several times per second. Given that each time it runs it will need
46fc3d4c 407to be re-compiled and will often allocate a megabyte or more of system
68dc0745 408memory, this can be a killer. Compiling into C B<isn't going to help
46fc3d4c 409you> because the process start-up overhead is where the bottleneck is.
68dc0745 410
92c2ed05
GS
411There are two popular ways to avoid this overhead. One solution
412involves running the Apache HTTP server (available from
68dc0745 413http://www.apache.org/) with either of the mod_perl or mod_fastcgi
92c2ed05
GS
414plugin modules.
415
416With mod_perl and the Apache::Registry module (distributed with
417mod_perl), httpd will run with an embedded Perl interpreter which
418pre-compiles your script and then executes it within the same address
419space without forking. The Apache extension also gives Perl access to
420the internal server API, so modules written in Perl can do just about
421anything a module written in C can. For more on mod_perl, see
422http://perl.apache.org/
423
65acb1b1 424With the FCGI module (from CPAN) and the mod_fastcgi
87275199
GS
425module (available from http://www.fastcgi.com/) each of your Perl
426programs becomes a permanent CGI daemon process.
68dc0745 427
428Both of these solutions can have far-reaching effects on your system
87275199 429and on the way you write your CGI programs, so investigate them with
68dc0745 430care.
431
92c2ed05 432See http://www.perl.com/CPAN/modules/by-category/15_World_Wide_Web_HTML_HTTP_CGI/ .
5a964f20 433
65acb1b1 434A non-free, commercial product, ``The Velocity Engine for Perl'',
a6dd486b
JB
435(http://www.binevolve.com/ or http://www.binevolve.com/velocigen/ )
436might also be worth looking at. It will allow you to increase the
437performance of your Perl programs, running programs up to 25 times
438faster than normal CGI Perl when running in persistent Perl mode or 4
439to 5 times faster without any modification to your existing CGI
440programs. Fully functional evaluation copies are available from the
441web site.
c8db1d39 442
68dc0745 443=head2 How can I hide the source for my Perl program?
444
445Delete it. :-) Seriously, there are a number of (mostly
92c2ed05 446unsatisfactory) solutions with varying levels of ``security''.
68dc0745 447
448First of all, however, you I<can't> take away read permission, because
449the source code has to be readable in order to be compiled and
450interpreted. (That doesn't mean that a CGI script's source is
a6dd486b
JB
451readable by people on the web, though--only by people with access to
452the filesystem.) So you have to leave the permissions at the socially
92c2ed05 453friendly 0755 level.
68dc0745 454
455Some people regard this as a security problem. If your program does
a6dd486b 456insecure things and relies on people not knowing how to exploit those
68dc0745 457insecurities, it is not secure. It is often possible for someone to
458determine the insecure things and exploit them without viewing the
459source. Security through obscurity, the name for hiding your bugs
460instead of fixing them, is little security indeed.
461
92c2ed05 462You can try using encryption via source filters (Filter::* from CPAN),
65acb1b1
TC
463but any decent programmer will be able to decrypt it. You can try using
464the byte code compiler and interpreter described below, but the curious
465might still be able to de-compile it. You can try using the native-code
466compiler described below, but crackers might be able to disassemble it.
467These pose varying degrees of difficulty to people wanting to get at
a6dd486b 468your code, but none can definitively conceal it (true of every
68dc0745 469language, not just Perl).
470
471If you're concerned about people profiting from your code, then the
d92eb7b0 472bottom line is that nothing but a restrictive license will give you
68dc0745 473legal security. License your software and pepper it with threatening
92c2ed05 474statements like ``This is unpublished proprietary software of XYZ Corp.
68dc0745 475Your access to it does not give you permission to use it blah blah
92c2ed05 476blah.'' We are not lawyers, of course, so you should see a lawyer if
d92eb7b0 477you want to be sure your license's wording will stand up in court.
68dc0745 478
54310121 479=head2 How can I compile my Perl program into byte code or C?
68dc0745 480
481Malcolm Beattie has written a multifunction backend compiler,
5e3006a4
GS
482available from CPAN, that can do both these things. It is included
483in the perl5.005 release, but is still considered experimental.
484This means it's fun to play with if you're a programmer but not
485really for people looking for turn-key solutions.
68dc0745 486
92c2ed05
GS
487Merely compiling into C does not in and of itself guarantee that your
488code will run very much faster. That's because except for lucky cases
489where a lot of native type inferencing is possible, the normal Perl
a6dd486b 490run-time system is still present and so your program will take just as
92c2ed05
GS
491long to run and be just as big. Most programs save little more than
492compilation time, leaving execution no more than 10-30% faster. A few
a6dd486b 493rare programs actually benefit significantly (even running several times
92c2ed05 494faster), but this takes some tweaking of your code.
68dc0745 495
68dc0745 496You'll probably be astonished to learn that the current version of the
497compiler generates a compiled form of your script whose executable is
498just as big as the original perl executable, and then some. That's
499because as currently written, all programs are prepared for a full
500eval() statement. You can tremendously reduce this cost by building a
92c2ed05 501shared I<libperl.so> library and linking against that. See the
87275199 502F<INSTALL> podfile in the Perl source distribution for details. If
d92eb7b0 503you link your main perl binary with this, it will make it minuscule.
92c2ed05 504For example, on one author's system, F</usr/bin/perl> is only 11k in
68dc0745 505size!
506
5a964f20 507In general, the compiler will do nothing to make a Perl program smaller,
a6dd486b
JB
508faster, more portable, or more secure. In fact, it can make your
509situation worse. The executable will be bigger, your VM system may take
5a964f20
TC
510longer to load the whole thing, the binary is fragile and hard to fix,
511and compilation never stopped software piracy in the form of crackers,
512viruses, or bootleggers. The real advantage of the compiler is merely
513packaging, and once you see the size of what it makes (well, unless
514you use a shared I<libperl.so>), you'll probably want a complete
5e3006a4 515Perl install anyway.
5a964f20 516
65acb1b1
TC
517=head2 How can I compile Perl into Java?
518
a6dd486b 519You can also integrate Java and Perl with the
65acb1b1 520Perl Resource Kit from O'Reilly and Associates. See
a6dd486b
JB
521http://www.oreilly.com/catalog/prkunix/ .
522
523Perl 5.6 comes with Java Perl Lingo, or JPL. JPL, still in
524development, allows Perl code to be called from Java. See jpl/README
525in the Perl source tree.
65acb1b1 526
92c2ed05 527=head2 How can I get C<#!perl> to work on [MS-DOS,NT,...]?
68dc0745 528
529For OS/2 just use
530
531 extproc perl -S -your_switches
532
533as the first line in C<*.cmd> file (C<-S> due to a bug in cmd.exe's
46fc3d4c 534`extproc' handling). For DOS one should first invent a corresponding
a6dd486b 535batch file and codify it in C<ALTERNATIVE_SHEBANG> (see the
68dc0745 536F<INSTALL> file in the source distribution for more information).
537
92c2ed05
GS
538The Win95/NT installation, when using the ActiveState port of Perl,
539will modify the Registry to associate the C<.pl> extension with the
d92eb7b0
GS
540perl interpreter. If you install another port, perhaps even building
541your own Win95/NT Perl from the standard sources by using a Windows port
d702ae42 542of gcc (e.g., with cygwin or mingw32), then you'll have to modify
d92eb7b0
GS
543the Registry yourself. In addition to associating C<.pl> with the
544interpreter, NT people can use: C<SET PATHEXT=%PATHEXT%;.PL> to let them
545run the program C<install-linux.pl> merely by typing C<install-linux>.
68dc0745 546
87275199
GS
547Macintosh Perl programs will have the appropriate Creator and
548Type, so that double-clicking them will invoke the Perl application.
68dc0745 549
550I<IMPORTANT!>: Whatever you do, PLEASE don't get frustrated, and just
551throw the perl interpreter into your cgi-bin directory, in order to
87275199 552get your programs working for a web server. This is an EXTREMELY big
68dc0745 553security risk. Take the time to figure out how to do it correctly.
554
87275199 555=head2 Can I write useful Perl programs on the command line?
68dc0745 556
557Yes. Read L<perlrun> for more information. Some examples follow.
558(These assume standard Unix shell quoting rules.)
559
560 # sum first and last fields
5a964f20 561 perl -lane 'print $F[0] + $F[-1]' *
68dc0745 562
563 # identify text files
564 perl -le 'for(@ARGV) {print if -f && -T _}' *
565
5a964f20 566 # remove (most) comments from C program
68dc0745 567 perl -0777 -pe 's{/\*.*?\*/}{}gs' foo.c
568
569 # make file a month younger than today, defeating reaper daemons
570 perl -e '$X=24*60*60; utime(time(),time() + 30 * $X,@ARGV)' *
571
572 # find first unused uid
573 perl -le '$i++ while getpwuid($i); print $i'
574
575 # display reasonable manpath
576 echo $PATH | perl -nl -072 -e '
577 s![^/+]*$!man!&&-d&&!$s{$_}++&&push@m,$_;END{print"@m"}'
578
87275199 579OK, the last one was actually an Obfuscated Perl Contest entry. :-)
68dc0745 580
87275199 581=head2 Why don't Perl one-liners work on my DOS/Mac/VMS system?
68dc0745 582
583The problem is usually that the command interpreters on those systems
584have rather different ideas about quoting than the Unix shells under
585which the one-liners were created. On some systems, you may have to
586change single-quotes to double ones, which you must I<NOT> do on Unix
587or Plan9 systems. You might also have to change a single % to a %%.
588
589For example:
590
591 # Unix
592 perl -e 'print "Hello world\n"'
593
46fc3d4c 594 # DOS, etc.
68dc0745 595 perl -e "print \"Hello world\n\""
596
46fc3d4c 597 # Mac
68dc0745 598 print "Hello world\n"
599 (then Run "Myscript" or Shift-Command-R)
600
601 # VMS
602 perl -e "print ""Hello world\n"""
603
a6dd486b 604The problem is that none of these examples are reliable: they depend on the
92c2ed05 605command interpreter. Under Unix, the first two often work. Under DOS,
a6dd486b 606it's entirely possible that neither works. If 4DOS was the command shell,
92c2ed05 607you'd probably have better luck like this:
68dc0745 608
609 perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>""
610
46fc3d4c 611Under the Mac, it depends which environment you are using. The MacPerl
68dc0745 612shell, or MPW, is much like Unix shells in its support for several
46fc3d4c 613quoting variants, except that it makes free use of the Mac's non-ASCII
68dc0745 614characters as control characters.
615
65acb1b1
TC
616Using qq(), q(), and qx(), instead of "double quotes", 'single
617quotes', and `backticks`, may make one-liners easier to write.
618
92c2ed05
GS
619There is no general solution to all of this. It is a mess, pure and
620simple. Sucks to be away from Unix, huh? :-)
68dc0745 621
622[Some of this answer was contributed by Kenneth Albanowski.]
623
624=head2 Where can I learn about CGI or Web programming in Perl?
625
626For modules, get the CGI or LWP modules from CPAN. For textbooks,
627see the two especially dedicated to web stuff in the question on
92c2ed05
GS
628books. For problems and questions related to the web, like ``Why
629do I get 500 Errors'' or ``Why doesn't it run from the browser right
630when it runs fine on the command line'', see these sources:
68dc0745 631
5a964f20
TC
632 WWW Security FAQ
633 http://www.w3.org/Security/Faq/
68dc0745 634
5a964f20
TC
635 Web FAQ
636 http://www.boutell.com/faq/
68dc0745 637
5a964f20 638 CGI FAQ
6cecdcac 639 http://www.webthing.com/tutorials/cgifaq.html
68dc0745 640
5a964f20
TC
641 HTTP Spec
642 http://www.w3.org/pub/WWW/Protocols/HTTP/
643
644 HTML Spec
645 http://www.w3.org/TR/REC-html40/
646 http://www.w3.org/pub/WWW/MarkUp/
647
648 CGI Spec
649 http://www.w3.org/CGI/
650
651 CGI Security FAQ
652 http://www.go2net.com/people/paulp/cgi-security/safe-cgi.txt
68dc0745 653
68dc0745 654=head2 Where can I learn about object-oriented Perl programming?
655
a6dd486b
JB
656A good place to start is L<perltoot>, and you can use L<perlobj>,
657L<perlboot>, and L<perlbot> for reference. Perltoot didn't come out
658until the 5.004 release; you can get a copy (in pod, html, or
659postscript) from http://www.perl.com/CPAN/doc/FMTEYEWTK/ .
68dc0745 660
661=head2 Where can I learn about linking C with Perl? [h2xs, xsubpp]
662
663If you want to call C from Perl, start with L<perlxstut>,
664moving on to L<perlxs>, L<xsubpp>, and L<perlguts>. If you want to
665call Perl from C, then read L<perlembed>, L<perlcall>, and
666L<perlguts>. Don't forget that you can learn a lot from looking at
667how the authors of existing extension modules wrote their code and
668solved their problems.
669
670=head2 I've read perlembed, perlguts, etc., but I can't embed perl in
a6dd486b 671my C program; what am I doing wrong?
68dc0745 672
673Download the ExtUtils::Embed kit from CPAN and run `make test'. If
674the tests pass, read the pods again and again and again. If they
87275199 675fail, see L<perlbug> and send a bug report with the output of
68dc0745 676C<make test TEST_VERBOSE=1> along with C<perl -V>.
677
678=head2 When I tried to run my script, I got this message. What does it
679mean?
680
87275199
GS
681A complete list of Perl's error messages and warnings with explanatory
682text can be found in L<perldiag>. You can also use the splain program
683(distributed with Perl) to explain the error messages:
68dc0745 684
685 perl program 2>diag.out
686 splain [-v] [-p] diag.out
687
688or change your program to explain the messages for you:
689
690 use diagnostics;
691
692or
693
694 use diagnostics -verbose;
695
696=head2 What's MakeMaker?
697
87275199 698This module (part of the standard Perl distribution) is designed to
68dc0745 699write a Makefile for an extension module from a Makefile.PL. For more
700information, see L<ExtUtils::MakeMaker>.
701
702=head1 AUTHOR AND COPYRIGHT
703
65acb1b1 704Copyright (c) 1997-1999 Tom Christiansen and Nathan Torkington.
5a964f20
TC
705All rights reserved.
706
c8db1d39 707When included as an integrated part of the Standard Distribution
d92eb7b0
GS
708of Perl or of its documentation (printed or otherwise), this works is
709covered under Perl's Artistic License. For separate distributions of
c8db1d39
TC
710all or part of this FAQ outside of that, see L<perlfaq>.
711
87275199 712Irrespective of its distribution, all code examples here are in the public
c8db1d39
TC
713domain. You are permitted and encouraged to use this code and any
714derivatives thereof in your own programs for fun or for profit as you
715see fit. A simple comment in the code giving credit to the FAQ would
716be courteous but is not required.