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