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