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