This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Unicode properties: allow also intra(wordbreak)name whitespace,
[perl5.git] / pod / perlfaq3.pod
CommitLineData
68dc0745 1=head1 NAME
2
24f1ba9b 3perlfaq3 - Programming Tools ($Revision: 1.2 $, $Date: 2001/09/29 03:13:13 $)
68dc0745 4
5=head1 DESCRIPTION
6
7This section of the FAQ answers questions related to programmer tools
8and programming support.
9
10=head2 How do I do (anything)?
11
12Have you looked at CPAN (see L<perlfaq2>)? The chances are that
13someone has already written a module that can solve your problem.
3958b146 14Have you read the appropriate manpages? Here's a brief index:
68dc0745 15
5a964f20
TC
16 Basics perldata, perlvar, perlsyn, perlop, perlsub
17 Execution perlrun, perldebug
18 Functions perlfunc
68dc0745 19 Objects perlref, perlmod, perlobj, perltie
20 Data Structures perlref, perllol, perldsc
f102b883 21 Modules perlmod, perlmodlib, perlsub
d92eb7b0 22 Regexes perlre, perlfunc, perlop, perllocale
68dc0745 23 Moving to perl5 perltrap, perl
24 Linking w/C perlxstut, perlxs, perlcall, perlguts, perlembed
25 Various http://www.perl.com/CPAN/doc/FMTEYEWTK/index.html
26 (not a man-page but still useful)
27
3958b146 28A crude table of contents for the Perl manpage 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
3958b146 33perldebug(1) manpage, 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
57b19278
JS
416fails consider just buying faster hardware. You will probably want to
417read the answer to the earlier question ``How do I profile my Perl programs?''
418if you haven't done so already.
68dc0745 419
92c2ed05 420A different approach is to autoload seldom-used Perl code. See the
68dc0745 421AutoSplit and AutoLoader modules in the standard distribution for
422that. Or you could locate the bottleneck and think about writing just
423that part in C, the way we used to take bottlenecks in C code and
a6dd486b
JB
424write them in assembler. Similar to rewriting in C,
425modules that have critical sections can be written in C (for instance, the
68dc0745 426PDL module from CPAN).
427
428In some cases, it may be worth it to use the backend compiler to
429produce byte code (saving compilation time) or compile into C, which
430will certainly save compilation time and sometimes a small amount (but
431not much) execution time. See the question about compiling your Perl
92c2ed05
GS
432programs for more on the compiler--the wins aren't as obvious as you'd
433hope.
68dc0745 434
92c2ed05 435If you're currently linking your perl executable to a shared I<libc.so>,
68dc0745 436you can often gain a 10-25% performance benefit by rebuilding it to
437link with a static libc.a instead. This will make a bigger perl
438executable, but your Perl programs (and programmers) may thank you for
439it. See the F<INSTALL> file in the source distribution for more
440information.
441
442Unsubstantiated reports allege that Perl interpreters that use sfio
87275199 443outperform those that don't (for I/O intensive applications). To try
68dc0745 444this, see the F<INSTALL> file in the source distribution, especially
87275199 445the ``Selecting File I/O mechanisms'' section.
68dc0745 446
447The undump program was an old attempt to speed up your Perl program
448by storing the already-compiled form to disk. This is no longer
449a viable option, as it only worked on a few architectures, and
450wasn't a good solution anyway.
451
452=head2 How can I make my Perl program take less memory?
453
454When it comes to time-space tradeoffs, Perl nearly always prefers to
455throw memory at a problem. Scalars in Perl use more memory than
65acb1b1 456strings in C, arrays take more than that, and hashes use even more. While
68dc0745 457there's still a lot to be done, recent releases have been addressing
458these issues. For example, as of 5.004, duplicate hash keys are
459shared amongst all hashes using them, so require no reallocation.
460
461In some cases, using substr() or vec() to simulate arrays can be
462highly beneficial. For example, an array of a thousand booleans will
463take at least 20,000 bytes of space, but it can be turned into one
a6dd486b 464125-byte bit vector--a considerable memory savings. The standard
68dc0745 465Tie::SubstrHash module can also help for certain types of data
466structure. If you're working with specialist data structures
467(matrices, for instance) modules that implement these in C may use
468less memory than equivalent Perl modules.
469
470Another thing to try is learning whether your Perl was compiled with
54310121 471the system malloc or with Perl's builtin malloc. Whichever one it
68dc0745 472is, try using the other one and see whether this makes a difference.
473Information about malloc is in the F<INSTALL> file in the source
474distribution. You can find out whether you are using perl's malloc by
475typing C<perl -V:usemymalloc>.
476
24f1ba9b
JH
477Of course, the best way to save memory is to not do anything to waste
478it in the first place. Good programming practices can go a long way
479toward this:
480
481=over 4
482
483=item * Don't slurp!
484
485Don't read an entire file into memory if you can process it line
486by line. Or more concretely, use a loop like this:
487
488 #
489 # Good Idea
490 #
491 while (<FILE>) {
492 # ...
493 }
494
495instead of this:
496
497 #
498 # Bad Idea
499 #
500 @data = <FILE>;
501 foreach (@data) {
502 # ...
503 }
504
505When the files you're processing are small, it doesn't much matter which
506way you do it, but it makes a huge difference when they start getting
507larger.
508
509=item * Pass by reference
510
511Pass arrays and hashes by reference, not by value. For one thing, it's
512the only way to pass multiple lists or hashes (or both) in a single
513call/return. It also avoids creating a copy of all the contents. This
514requires some judgment, however, because any changes will be propagated
515back to the original data. If you really want to mangle (er, modify) a
516copy, you'll have to sacrifice the memory needed to make one.
517
518=item * Tie large variables to disk.
519
520For "big" data stores (i.e. ones that exceed available memory) consider
521using one of the DB modules to store it on disk instead of in RAM. This
522will incur a penalty in access time, but that's probably better that
523causing your hard disk to thrash due to massive swapping.
524
525=back
526
68dc0745 527=head2 Is it unsafe to return a pointer to local data?
528
529No, Perl's garbage collection system takes care of this.
530
531 sub makeone {
532 my @a = ( 1 .. 10 );
533 return \@a;
534 }
535
536 for $i ( 1 .. 10 ) {
537 push @many, makeone();
538 }
539
540 print $many[4][5], "\n";
541
542 print "@many\n";
543
544=head2 How can I free an array or hash so my program shrinks?
545
c8db1d39
TC
546You can't. On most operating systems, memory allocated to a program
547can never be returned to the system. That's why long-running programs
65acb1b1
TC
548sometimes re-exec themselves. Some operating systems (notably,
549FreeBSD and Linux) allegedly reclaim large chunks of memory that is no
550longer used, but it doesn't appear to happen with Perl (yet). The Mac
551appears to be the only platform that will reliably (albeit, slowly)
552return memory to the OS.
553
554We've had reports that on Linux (Redhat 5.1) on Intel, C<undef
555$scalar> will return memory to the system, while on Solaris 2.6 it
556won't. In general, try it yourself and see.
68dc0745 557
558However, judicious use of my() on your variables will help make sure
a6dd486b 559that they go out of scope so that Perl can free up that space for
92c2ed05 560use in other parts of your program. A global variable, of course, never
68dc0745 561goes out of scope, so you can't get its space automatically reclaimed,
562although undef()ing and/or delete()ing it will achieve the same effect.
46fc3d4c 563In general, memory allocation and de-allocation isn't something you can
68dc0745 564or should be worrying about much in Perl, but even this capability
565(preallocation of data types) is in the works.
566
567=head2 How can I make my CGI script more efficient?
568
569Beyond the normal measures described to make general Perl programs
570faster or smaller, a CGI program has additional issues. It may be run
571several times per second. Given that each time it runs it will need
46fc3d4c 572to be re-compiled and will often allocate a megabyte or more of system
68dc0745 573memory, this can be a killer. Compiling into C B<isn't going to help
46fc3d4c 574you> because the process start-up overhead is where the bottleneck is.
68dc0745 575
92c2ed05
GS
576There are two popular ways to avoid this overhead. One solution
577involves running the Apache HTTP server (available from
68dc0745 578http://www.apache.org/) with either of the mod_perl or mod_fastcgi
92c2ed05
GS
579plugin modules.
580
581With mod_perl and the Apache::Registry module (distributed with
582mod_perl), httpd will run with an embedded Perl interpreter which
583pre-compiles your script and then executes it within the same address
584space without forking. The Apache extension also gives Perl access to
585the internal server API, so modules written in Perl can do just about
586anything a module written in C can. For more on mod_perl, see
587http://perl.apache.org/
588
65acb1b1 589With the FCGI module (from CPAN) and the mod_fastcgi
87275199
GS
590module (available from http://www.fastcgi.com/) each of your Perl
591programs becomes a permanent CGI daemon process.
68dc0745 592
593Both of these solutions can have far-reaching effects on your system
87275199 594and on the way you write your CGI programs, so investigate them with
68dc0745 595care.
596
92c2ed05 597See http://www.perl.com/CPAN/modules/by-category/15_World_Wide_Web_HTML_HTTP_CGI/ .
5a964f20 598
65acb1b1 599A non-free, commercial product, ``The Velocity Engine for Perl'',
a6dd486b
JB
600(http://www.binevolve.com/ or http://www.binevolve.com/velocigen/ )
601might also be worth looking at. It will allow you to increase the
602performance of your Perl programs, running programs up to 25 times
603faster than normal CGI Perl when running in persistent Perl mode or 4
604to 5 times faster without any modification to your existing CGI
605programs. Fully functional evaluation copies are available from the
606web site.
c8db1d39 607
68dc0745 608=head2 How can I hide the source for my Perl program?
609
610Delete it. :-) Seriously, there are a number of (mostly
92c2ed05 611unsatisfactory) solutions with varying levels of ``security''.
68dc0745 612
613First of all, however, you I<can't> take away read permission, because
614the source code has to be readable in order to be compiled and
615interpreted. (That doesn't mean that a CGI script's source is
a6dd486b
JB
616readable by people on the web, though--only by people with access to
617the filesystem.) So you have to leave the permissions at the socially
92c2ed05 618friendly 0755 level.
68dc0745 619
620Some people regard this as a security problem. If your program does
a6dd486b 621insecure things and relies on people not knowing how to exploit those
68dc0745 622insecurities, it is not secure. It is often possible for someone to
623determine the insecure things and exploit them without viewing the
624source. Security through obscurity, the name for hiding your bugs
625instead of fixing them, is little security indeed.
626
83df6a1d
JH
627You can try using encryption via source filters (Starting from Perl
6285.8 the Filter::Simple and Filter::Util::Call modules are included in
629the standard distribution), but any decent programmer will be able to
630decrypt it. You can try using the byte code compiler and interpreter
631described below, but the curious might still be able to de-compile it.
632You can try using the native-code compiler described below, but
633crackers might be able to disassemble it. These pose varying degrees
634of difficulty to people wanting to get at your code, but none can
635definitively conceal it (true of every language, not just Perl).
68dc0745 636
637If you're concerned about people profiting from your code, then the
d92eb7b0 638bottom line is that nothing but a restrictive license will give you
68dc0745 639legal security. License your software and pepper it with threatening
92c2ed05 640statements like ``This is unpublished proprietary software of XYZ Corp.
68dc0745 641Your access to it does not give you permission to use it blah blah
92c2ed05 642blah.'' We are not lawyers, of course, so you should see a lawyer if
d92eb7b0 643you want to be sure your license's wording will stand up in court.
68dc0745 644
54310121 645=head2 How can I compile my Perl program into byte code or C?
68dc0745 646
647Malcolm Beattie has written a multifunction backend compiler,
5e3006a4
GS
648available from CPAN, that can do both these things. It is included
649in the perl5.005 release, but is still considered experimental.
650This means it's fun to play with if you're a programmer but not
651really for people looking for turn-key solutions.
68dc0745 652
92c2ed05
GS
653Merely compiling into C does not in and of itself guarantee that your
654code will run very much faster. That's because except for lucky cases
655where a lot of native type inferencing is possible, the normal Perl
a6dd486b 656run-time system is still present and so your program will take just as
92c2ed05
GS
657long to run and be just as big. Most programs save little more than
658compilation time, leaving execution no more than 10-30% faster. A few
a6dd486b 659rare programs actually benefit significantly (even running several times
92c2ed05 660faster), but this takes some tweaking of your code.
68dc0745 661
68dc0745 662You'll probably be astonished to learn that the current version of the
663compiler generates a compiled form of your script whose executable is
664just as big as the original perl executable, and then some. That's
665because as currently written, all programs are prepared for a full
666eval() statement. You can tremendously reduce this cost by building a
92c2ed05 667shared I<libperl.so> library and linking against that. See the
87275199 668F<INSTALL> podfile in the Perl source distribution for details. If
d92eb7b0 669you link your main perl binary with this, it will make it minuscule.
92c2ed05 670For example, on one author's system, F</usr/bin/perl> is only 11k in
68dc0745 671size!
672
5a964f20 673In general, the compiler will do nothing to make a Perl program smaller,
a6dd486b
JB
674faster, more portable, or more secure. In fact, it can make your
675situation worse. The executable will be bigger, your VM system may take
5a964f20
TC
676longer to load the whole thing, the binary is fragile and hard to fix,
677and compilation never stopped software piracy in the form of crackers,
678viruses, or bootleggers. The real advantage of the compiler is merely
679packaging, and once you see the size of what it makes (well, unless
680you use a shared I<libperl.so>), you'll probably want a complete
5e3006a4 681Perl install anyway.
5a964f20 682
65acb1b1
TC
683=head2 How can I compile Perl into Java?
684
a6dd486b 685You can also integrate Java and Perl with the
65acb1b1 686Perl Resource Kit from O'Reilly and Associates. See
a6dd486b
JB
687http://www.oreilly.com/catalog/prkunix/ .
688
689Perl 5.6 comes with Java Perl Lingo, or JPL. JPL, still in
690development, allows Perl code to be called from Java. See jpl/README
691in the Perl source tree.
65acb1b1 692
92c2ed05 693=head2 How can I get C<#!perl> to work on [MS-DOS,NT,...]?
68dc0745 694
695For OS/2 just use
696
697 extproc perl -S -your_switches
698
699as the first line in C<*.cmd> file (C<-S> due to a bug in cmd.exe's
46fc3d4c 700`extproc' handling). For DOS one should first invent a corresponding
a6dd486b 701batch file and codify it in C<ALTERNATIVE_SHEBANG> (see the
68dc0745 702F<INSTALL> file in the source distribution for more information).
703
92c2ed05
GS
704The Win95/NT installation, when using the ActiveState port of Perl,
705will modify the Registry to associate the C<.pl> extension with the
d92eb7b0
GS
706perl interpreter. If you install another port, perhaps even building
707your own Win95/NT Perl from the standard sources by using a Windows port
d702ae42 708of gcc (e.g., with cygwin or mingw32), then you'll have to modify
d92eb7b0
GS
709the Registry yourself. In addition to associating C<.pl> with the
710interpreter, NT people can use: C<SET PATHEXT=%PATHEXT%;.PL> to let them
711run the program C<install-linux.pl> merely by typing C<install-linux>.
68dc0745 712
87275199
GS
713Macintosh Perl programs will have the appropriate Creator and
714Type, so that double-clicking them will invoke the Perl application.
68dc0745 715
716I<IMPORTANT!>: Whatever you do, PLEASE don't get frustrated, and just
717throw the perl interpreter into your cgi-bin directory, in order to
87275199 718get your programs working for a web server. This is an EXTREMELY big
68dc0745 719security risk. Take the time to figure out how to do it correctly.
720
87275199 721=head2 Can I write useful Perl programs on the command line?
68dc0745 722
723Yes. Read L<perlrun> for more information. Some examples follow.
724(These assume standard Unix shell quoting rules.)
725
726 # sum first and last fields
5a964f20 727 perl -lane 'print $F[0] + $F[-1]' *
68dc0745 728
729 # identify text files
730 perl -le 'for(@ARGV) {print if -f && -T _}' *
731
5a964f20 732 # remove (most) comments from C program
68dc0745 733 perl -0777 -pe 's{/\*.*?\*/}{}gs' foo.c
734
735 # make file a month younger than today, defeating reaper daemons
736 perl -e '$X=24*60*60; utime(time(),time() + 30 * $X,@ARGV)' *
737
738 # find first unused uid
739 perl -le '$i++ while getpwuid($i); print $i'
740
741 # display reasonable manpath
742 echo $PATH | perl -nl -072 -e '
743 s![^/+]*$!man!&&-d&&!$s{$_}++&&push@m,$_;END{print"@m"}'
744
87275199 745OK, the last one was actually an Obfuscated Perl Contest entry. :-)
68dc0745 746
87275199 747=head2 Why don't Perl one-liners work on my DOS/Mac/VMS system?
68dc0745 748
749The problem is usually that the command interpreters on those systems
750have rather different ideas about quoting than the Unix shells under
751which the one-liners were created. On some systems, you may have to
752change single-quotes to double ones, which you must I<NOT> do on Unix
753or Plan9 systems. You might also have to change a single % to a %%.
754
755For example:
756
757 # Unix
758 perl -e 'print "Hello world\n"'
759
46fc3d4c 760 # DOS, etc.
68dc0745 761 perl -e "print \"Hello world\n\""
762
46fc3d4c 763 # Mac
68dc0745 764 print "Hello world\n"
765 (then Run "Myscript" or Shift-Command-R)
766
767 # VMS
768 perl -e "print ""Hello world\n"""
769
a6dd486b 770The problem is that none of these examples are reliable: they depend on the
92c2ed05 771command interpreter. Under Unix, the first two often work. Under DOS,
a6dd486b 772it's entirely possible that neither works. If 4DOS was the command shell,
92c2ed05 773you'd probably have better luck like this:
68dc0745 774
775 perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>""
776
46fc3d4c 777Under the Mac, it depends which environment you are using. The MacPerl
68dc0745 778shell, or MPW, is much like Unix shells in its support for several
46fc3d4c 779quoting variants, except that it makes free use of the Mac's non-ASCII
68dc0745 780characters as control characters.
781
65acb1b1
TC
782Using qq(), q(), and qx(), instead of "double quotes", 'single
783quotes', and `backticks`, may make one-liners easier to write.
784
92c2ed05
GS
785There is no general solution to all of this. It is a mess, pure and
786simple. Sucks to be away from Unix, huh? :-)
68dc0745 787
788[Some of this answer was contributed by Kenneth Albanowski.]
789
790=head2 Where can I learn about CGI or Web programming in Perl?
791
792For modules, get the CGI or LWP modules from CPAN. For textbooks,
793see the two especially dedicated to web stuff in the question on
92c2ed05
GS
794books. For problems and questions related to the web, like ``Why
795do I get 500 Errors'' or ``Why doesn't it run from the browser right
796when it runs fine on the command line'', see these sources:
68dc0745 797
5a964f20
TC
798 WWW Security FAQ
799 http://www.w3.org/Security/Faq/
68dc0745 800
5a964f20
TC
801 Web FAQ
802 http://www.boutell.com/faq/
68dc0745 803
5a964f20 804 CGI FAQ
6cecdcac 805 http://www.webthing.com/tutorials/cgifaq.html
68dc0745 806
5a964f20
TC
807 HTTP Spec
808 http://www.w3.org/pub/WWW/Protocols/HTTP/
809
810 HTML Spec
811 http://www.w3.org/TR/REC-html40/
812 http://www.w3.org/pub/WWW/MarkUp/
813
814 CGI Spec
815 http://www.w3.org/CGI/
816
817 CGI Security FAQ
818 http://www.go2net.com/people/paulp/cgi-security/safe-cgi.txt
68dc0745 819
68dc0745 820=head2 Where can I learn about object-oriented Perl programming?
821
a6dd486b
JB
822A good place to start is L<perltoot>, and you can use L<perlobj>,
823L<perlboot>, and L<perlbot> for reference. Perltoot didn't come out
824until the 5.004 release; you can get a copy (in pod, html, or
825postscript) from http://www.perl.com/CPAN/doc/FMTEYEWTK/ .
68dc0745 826
827=head2 Where can I learn about linking C with Perl? [h2xs, xsubpp]
828
829If you want to call C from Perl, start with L<perlxstut>,
830moving on to L<perlxs>, L<xsubpp>, and L<perlguts>. If you want to
831call Perl from C, then read L<perlembed>, L<perlcall>, and
832L<perlguts>. Don't forget that you can learn a lot from looking at
833how the authors of existing extension modules wrote their code and
834solved their problems.
835
836=head2 I've read perlembed, perlguts, etc., but I can't embed perl in
a6dd486b 837my C program; what am I doing wrong?
68dc0745 838
839Download the ExtUtils::Embed kit from CPAN and run `make test'. If
840the tests pass, read the pods again and again and again. If they
87275199 841fail, see L<perlbug> and send a bug report with the output of
68dc0745 842C<make test TEST_VERBOSE=1> along with C<perl -V>.
843
844=head2 When I tried to run my script, I got this message. What does it
845mean?
846
87275199
GS
847A complete list of Perl's error messages and warnings with explanatory
848text can be found in L<perldiag>. You can also use the splain program
849(distributed with Perl) to explain the error messages:
68dc0745 850
851 perl program 2>diag.out
852 splain [-v] [-p] diag.out
853
854or change your program to explain the messages for you:
855
856 use diagnostics;
857
858or
859
860 use diagnostics -verbose;
861
862=head2 What's MakeMaker?
863
87275199 864This module (part of the standard Perl distribution) is designed to
68dc0745 865write a Makefile for an extension module from a Makefile.PL. For more
866information, see L<ExtUtils::MakeMaker>.
867
868=head1 AUTHOR AND COPYRIGHT
869
65acb1b1 870Copyright (c) 1997-1999 Tom Christiansen and Nathan Torkington.
5a964f20
TC
871All rights reserved.
872
5a7beb56
JH
873This documentation is free; you can redistribute it and/or modify it
874under the same terms as Perl itself.
c8db1d39 875
87275199 876Irrespective of its distribution, all code examples here are in the public
c8db1d39
TC
877domain. You are permitted and encouraged to use this code and any
878derivatives thereof in your own programs for fun or for profit as you
879see fit. A simple comment in the code giving credit to the FAQ would
880be courteous but is not required.