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