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