ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/App-Staticperl/staticperl.pod
(Generate patch)

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC vs.
Revision 1.27 by root, Tue Dec 21 19:32:34 2010 UTC

278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http 278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
279 279
280 # run it 280 # run it
281 ./app 281 ./app
282 282
283Here are the three phase 2 commands:
284
285=over 4
286
287=item F<staticperl mkbundle> args...
288
289The "default" bundle command - it interprets the given bundle options and
290writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
291files, useful for embedding.
292
293=item F<staticperl mkperl> args...
294
295Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
296as invoking F<staticperl mkbundle --perl> args...), but then compiles and
297links a new perl interpreter that embeds the created bundle, then deletes
298all intermediate files.
299
300=item F<staticperl mkapp> filename args...
301
302Does the same as F<staticperl mkbundle> (in fact, it's the same as
303invoking F<staticperl mkbundle --app> filename args...), but then compiles
304and links a new standalone application that simply initialises the perl
305interpreter.
306
307The difference to F<staticperl mkperl> is that the standalone application
308does not act like a perl interpreter would - in fact, by default it would
309just do nothing and exit immediately, so you should specify some code to
310be executed via the F<--boot> option.
311
312=back
313
283=head3 OPTION PROCESSING 314=head3 OPTION PROCESSING
284 315
285All options can be given as arguments on the command line (typically 316All options can be given as arguments on the command line (typically
286using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since 317using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
287specifying a lot of modules can make the command line very cumbersome, 318specifying a lot of options can make the command line very long and
288you can put all long options into a "bundle specification file" (with or 319unwieldy, you can put all long options into a "bundle specification file"
289without C<--> prefix) and specify this bundle file instead. 320(one option per line, with or without C<--> prefix) and specify this
321bundle file instead.
290 322
291For example, the command given earlier could also look like this: 323For example, the command given earlier to link a new F<perl> could also
324look like this:
292 325
293 staticperl mkperl httpd.bundle 326 staticperl mkperl httpd.bundle
294 327
295And all options could be in F<httpd.bundle>: 328With all options stored in the F<httpd.bundle> file (one option per line,
296 329everything after the option is an argument):
330
297 use "Config_heavy.pl" 331 use "Config_heavy.pl"
298 use AnyEvent::Impl::Perl 332 use AnyEvent::Impl::Perl
299 use AnyEvent::HTTPD 333 use AnyEvent::HTTPD
300 use URI::http 334 use URI::http
301 add eg/httpd httpd.pm 335 add eg/httpd httpd.pm
302 336
303All options that specify modules or files to be added are processed in the 337All options that specify modules or files to be added are processed in the
304order given on the command line (that affects the C<--use> and C<--eval> 338order given on the command line.
305options at the moment).
306 339
307=head3 PACKAGE SELECTION WORKFLOW 340=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
308 341
309F<staticperl mkbundle> has a number of options to control package 342F<staticperl mkbundle> works by first assembling a list of candidate
310selection. This section describes how they interact with each other. Also, 343files and modules to include, then filtering them by include/exclude
311since I am still a newbie w.r.t. these issues, maybe future versions of 344patterns. The remaining modules (together with their direct dependencies,
312F<staticperl> will change this, so watch out :) 345such as link libraries and L<AutoLoader> files) are then converted into
346bundle files suitable for embedding. F<staticperl mkbundle> can then
347optionally build a new perl interpreter or a standalone application.
313 348
314The idiom "in order" means "in order that they are specified on the
315commandline". If you use a bundle specification file, then the options
316will be processed as if they were given in place of the bundle file name.
317
318=over 4 349=over 4
319 350
320=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and 351=item Step 0: Generic argument processing.
321C<--incglob> options, in order.
322 352
323In addition, C<--use> and C<--eval> dependencies will be added when the 353The following options influence F<staticperl mkbundle> itself.
324options are processed.
325 354
326=item 2. apply all C<--include> and C<--exclude> options, in order.
327
328All this step does is potentially reduce the number of files already
329selected or found in phase 1.
330
331=item 3. find all modules (== F<.pm> files), gather their static archives
332(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
333extra libraries they need for linking (F<extralibs.ld>) and optionally
334evaluate any F<.packlist> files.
335
336This step is required to link against XS extensions and also adds files
337required for L<AutoLoader> to do it's job.
338
339=back
340
341After this, all the files selected for bundling will be read and processed
342(stripped), the bundle files will be written, and optionally a new F<perl>
343or application binary will be linked.
344
345=head3 MKBUNDLE OPTIONS
346
347=over 4 355=over 4
348 356
349=item --verbose | -v 357=item C<--verbose> | C<-v>
350 358
351Increases the verbosity level by one (the default is C<1>). 359Increases the verbosity level by one (the default is C<1>).
352 360
353=item --quiet | -q 361=item C<--quiet> | C<-q>
354 362
355Decreases the verbosity level by one. 363Decreases the verbosity level by one.
356 364
365=item any other argument
366
367Any other argument is interpreted as a bundle specification file, which
368supports all options (without extra quoting), one option per line, in the
369format C<option> or C<option argument>. They will effectively be expanded
370and processed as if they were directly written on the command line, in
371place of the file name.
372
373=back
374
375=item Step 1: gather candidate files and modules
376
377In this step, modules, perl libraries (F<.pl> files) and other files are
378selected for inclusion in the bundle. The relevant options are executed
379in order (this makes a difference mostly for C<--eval>, which can rely on
380earlier C<--use> options to have been executed).
381
382=over 4
383
384=item C<--use> F<module> | C<-M>F<module>
385
386Include the named module and trace direct dependencies. This is done by
387C<require>'ing the module in a subprocess and tracing which other modules
388and files it actually loads.
389
390Example: include AnyEvent and AnyEvent::Impl::Perl.
391
392 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
393
394Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
395maybe other weirdly named files. To do that, you need to quote the name in
396single or double quotes. When given on the command line, you probably need
397to quote once more to avoid your shell interpreting it. Common cases that
398need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
399
400Example: include the required files for F<perl -V> to work in all its
401glory (F<Config.pm> is included automatically by this).
402
403 # bourne shell
404 staticperl mkbundle --use '"Config_heavy.pl"'
405
406 # bundle specification file
407 use "Config_heavy.pl"
408
409The C<-M>module syntax is included as an alias that might be easier to
410remember than C<--use>. Or maybe it confuses people. Time will tell. Or
411maybe not. Sigh.
412
413=item C<--eval> "perl code" | C<-e> "perl code"
414
415Sometimes it is easier (or necessary) to specify dependencies using perl
416code, or maybe one of the modules you use need a special use statement. In
417that case, you can use C<--eval> to execute some perl snippet or set some
418variables or whatever you need. All files C<require>'d or C<use>'d while
419executing the snippet are included in the final bundle.
420
421Keep in mind that F<mkbundle> will only C<require> the modules named
422by the C<--use> option, so do not expect the symbols from modules you
423C<--use>'d earlier on the command line to be available.
424
425Example: force L<AnyEvent> to detect a backend and therefore include it
426in the final bundle.
427
428 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
429
430 # or like this
431 staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
432
433Example: use a separate "bootstrap" script that C<use>'s lots of modules
434and also include this in the final bundle, to be executed automatically
435when the interpreter is initialised.
436
437 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
438
439=item C<--boot> F<filename>
440
441Include the given file in the bundle and arrange for it to be
442executed (using C<require>) before the main program when the new perl
443is initialised. This can be used to modify C<@INC> or do similar
444modifications before the perl interpreter executes scripts given on the
445command line (or via C<-e>). This works even in an embedded interpreter -
446the file will be executed during interpreter initialisation in that case.
447
448=item C<--incglob> pattern
449
450This goes through all standard library directories and tries to match any
451F<.pm> and F<.pl> files against the extended glob pattern (see below). If
452a file matches, it is added. The pattern is matched against the full path
453of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
454
455This is very useful to include "everything":
456
457 --incglob '*'
458
459It is also useful for including perl libraries, or trees of those, such as
460the unicode database files needed by some perl builtins, the regex engine
461and other modules.
462
463 --incglob '/unicore/**.pl'
464
465=item C<--add> F<file> | C<--add> "F<file> alias"
466
467Adds the given (perl) file into the bundle (and optionally call it
468"alias"). The F<file> is either an absolute path or a path relative to
469the current directory. If an alias is specified, then this is the name it
470will use for C<@INC> searches, otherfile the F<file> will be used as the
471internal name.
472
473This switch is used to include extra files into the bundle.
474
475Example: embed the file F<httpd> in the current directory as F<httpd.pm>
476when creating the bundle.
477
478 staticperl mkperl --add "httpd httpd.pm"
479
480Example: add local files as extra modules in the bundle.
481
482 # specification file
483 add file1 myfiles/file1.pm
484 add file2 myfiles/file2.pm
485 add file3 myfiles/file3.pl
486
487 # then later, in perl, use
488 use myfiles::file1;
489 require myfiles::file2;
490 my $res = do "myfiles/file3.pl";
491
492=item C<--binadd> F<file> | C<--add> "F<file> alias"
493
494Just like C<--add>, except that it treats the file as binary and adds it
495without any postprocessing (perl files might get stripped to reduce their
496size).
497
498You should probably add a C</> prefix to avoid clashing with embedded perl
499files (whose paths do not start with C</>), and/or use a special directory
500prefix, such as C</res/name>.
501
502You can later get a copy of these files by calling C<staticperl::find
503"alias">.
504
505An alternative way to embed binary files is to convert them to perl and
506use C<do> to get the contents - this method is a bit cumbersome, but works
507both inside and outside of a staticperl bundle:
508
509 # a "binary" file, call it "bindata.pl"
510 <<'SOME_MARKER'
511 binary data NOT containing SOME_MARKER
512 SOME_MARKER
513
514 # load the binary
515 chomp (my $data = do "bindata.pl");
516
517=back
518
519=item Step 2: filter all files using C<--include> and C<--exclude> options.
520
521After all candidate files and modules are added, they are I<filtered>
522by a combination of C<--include> and C<--exclude> patterns (there is an
523implicit C<--include **> at the end, so if no filters are specified, all
524files are included).
525
526All that this step does is potentially reduce the number of files that are
527to be included - no new files are added during this step.
528
529=over 4
530
531=item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern
532
533These specify an include or exclude pattern to be applied to the candidate
534file list. An include makes sure that the given files will be part of the
535resulting file set, an exclude will exclude remaining files. The patterns
536are "extended glob patterns" (see below).
537
538The patterns are applied "in order" - files included via earlier
539C<--include> specifications cannot be removed by any following
540C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
541cannot be added by any following C<--include>.
542
543For example, to include everything except C<Devel> modules, but still
544include F<Devel::PPPort>, you could use this:
545
546 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
547
548=back
549
550=item Step 3: add any extra or "hidden" dependencies.
551
552F<staticperl> currently knows about three extra types of depdendencies
553that are added automatically. Only one (F<.packlist> files) is currently
554optional and can be influenced, the others are always included:
555
556=over 4
557
558=item C<--usepacklist>
559
560Read F<.packlist> files for each distribution that happens to match a
561module name you specified. Sounds weird, and it is, so expect semantics to
562change somehow in the future.
563
564The idea is that most CPAN distributions have a F<.pm> file that matches
565the name of the distribution (which is rather reasonable after all).
566
567If this switch is enabled, then if any of the F<.pm> files that have been
568selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
569and F<.ix> files installed by this distribution are also included.
570
571For example, using this switch, when the L<URI> module is specified, then
572all L<URI> submodules that have been installed via the CPAN distribution
573are included as well, so you don't have to manually specify them.
574
575=item L<AutoLoader> splitfiles
576
577Some modules use L<AutoLoader> - less commonly (hopefully) used functions
578are split into separate F<.al> files, and an index (F<.ix>) file contains
579the prototypes.
580
581Both F<.ix> and F<.al> files will be detected automatically and added to
582the bundle.
583
584=item link libraries (F<.a> files)
585
586Modules using XS (or any other non-perl language extension compiled at
587installation time) will have a static archive (typically F<.a>). These
588will automatically be added to the linker options in F<bundle.ldopts>.
589
590Should F<staticperl> find a dynamic link library (typically F<.so>) it
591will warn about it - obviously this shouldn't happen unless you use
592F<staticperl> on the wrong perl, or one (probably wrongly) configured to
593use dynamic loading.
594
595=item extra libraries (F<extralibs.ld>)
596
597Some modules need linking against external libraries - these are found in
598F<extralibs.ld> and added to F<bundle.ldopts>.
599
600=back
601
602=item Step 4: write bundle files and optionally link a program
603
604At this point, the select files will be read, processed (stripped) and
605finally the bundle files get written to disk, and F<staticperl mkbundle>
606is normally finished. Optionally, it can go a step further and either link
607a new F<perl> binary with all selected modules and files inside, or build
608a standalone application.
609
610Both the contents of the bundle files and any extra linking is controlled
611by these options:
612
613=over 4
614
357=item --strip none|pod|ppi 615=item C<--strip> C<none>|C<pod>|C<ppi>
358 616
359Specify the stripping method applied to reduce the file of the perl 617Specify the stripping method applied to reduce the file of the perl
360sources included. 618sources included.
361 619
362The default is C<pod>, which uses the L<Pod::Strip> module to remove all 620The default is C<pod>, which uses the L<Pod::Strip> module to remove all
380After writing out the bundle files, try to link a new perl interpreter. It 638After writing out the bundle files, try to link a new perl interpreter. It
381will be called F<perl> and will be left in the current working 639will be called F<perl> and will be left in the current working
382directory. The bundle files will be removed. 640directory. The bundle files will be removed.
383 641
384This switch is automatically used when F<staticperl> is invoked with the 642This switch is automatically used when F<staticperl> is invoked with the
385C<mkperl> command (instead of C<mkbundle>): 643C<mkperl> command instead of C<mkbundle>.
386 644
387 # build a new ./perl with only common::sense in it - very small :) 645Example: build a new F<./perl> binary with only L<common::sense> inside -
646it will be even smaller than the standard perl interpreter as none of the
647modules of the base distribution (such as L<Fcntl>) will be included.
648
388 staticperl mkperl -Mcommon::sense 649 staticperl mkperl -Mcommon::sense
389 650
390=item --app name 651=item --app name
391 652
392After writing out the bundle files, try to link a new standalone 653After writing out the bundle files, try to link a new standalone
393program. It will be called C<name>, and the bundle files get removed after 654program. It will be called C<name>, and the bundle files get removed after
394linking it. 655linking it.
656
657This switch is automatically used when F<staticperl> is invoked with the
658C<mkapp> command instead of C<mkbundle>.
395 659
396The difference to the (mutually exclusive) C<--perl> option is that the 660The difference to the (mutually exclusive) C<--perl> option is that the
397binary created by this option will not try to act as a perl interpreter - 661binary created by this option will not try to act as a perl interpreter -
398instead it will simply initialise the perl interpreter, clean it up and 662instead it will simply initialise the perl interpreter, clean it up and
399exit. 663exit.
400 664
401This switch is automatically used when F<staticperl> is invoked with the 665This means that, by default, it will do nothing but burna few CPU cycles
402C<mkapp> command (instead of C<mkbundle>):
403
404To let it do something useful you I<must> add some boot code, e.g. with 666- for it to do something useful you I<must> add some boot code, e.g. with
405the C<--boot> option. 667the C<--boot> option.
406 668
407Example: create a standalone perl binary that will execute F<appfile> when 669Example: create a standalone perl binary called F<./myexe> that will
408it is started. 670execute F<appfile> when it is started.
409 671
410 staticperl mkbundle --app myexe --boot appfile 672 staticperl mkbundle --app myexe --boot appfile
411 673
412=item --use module | -Mmodule
413
414Include the named module and all direct dependencies. This is done by
415C<require>'ing the module in a subprocess and tracing which other modules
416and files it actually loads. If the module uses L<AutoLoader>, then all
417splitfiles will be included as well.
418
419Example: include AnyEvent and AnyEvent::Impl::Perl.
420
421 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
422
423Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
424maybe other weirdly named files. To do that, you need to quote the name in
425single or double quotes. When given on the command line, you probably need
426to quote once more to avoid your shell interpreting it. Common cases that
427need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
428
429Example: include the required files for F<perl -V> to work in all its
430glory (F<Config.pm> is included automatically by this).
431
432 # bourne shell
433 staticperl mkbundle --use '"Config_heavy.pl"'
434
435 # bundle specification file
436 use "Config_heavy.pl"
437
438The C<-Mmodule> syntax is included as an alias that might be easier to
439remember than C<use>. Or maybe it confuses people. Time will tell. Or
440maybe not. Argh.
441
442=item --eval "perl code" | -e "perl code"
443
444Sometimes it is easier (or necessary) to specify dependencies using perl
445code, or maybe one of the modules you use need a special use statement. In
446that case, you can use C<eval> to execute some perl snippet or set some
447variables or whatever you need. All files C<require>'d or C<use>'d in the
448script are included in the final bundle.
449
450Keep in mind that F<mkbundle> will only C<require> the modules named
451by the C<--use> option, so do not expect the symbols from modules you
452C<--use>'d earlier on the command line to be available.
453
454Example: force L<AnyEvent> to detect a backend and therefore include it
455in the final bundle.
456
457 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
458
459 # or like this
460 staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
461
462Example: use a separate "bootstrap" script that C<use>'s lots of modules
463and include this in the final bundle, to be executed automatically.
464
465 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
466
467=item --boot filename
468
469Include the given file in the bundle and arrange for it to be executed
470(using a C<require>) before anything else when the new perl is
471initialised. This can be used to modify C<@INC> or anything else before
472the perl interpreter executes scripts given on the command line (or via
473C<-e>). This works even in an embedded interpreter.
474
475=item --usepacklist
476
477Read F<.packlist> files for each distribution that happens to match a
478module name you specified. Sounds weird, and it is, so expect semantics to
479change somehow in the future.
480
481The idea is that most CPAN distributions have a F<.pm> file that matches
482the name of the distribution (which is rather reasonable after all).
483
484If this switch is enabled, then if any of the F<.pm> files that have been
485selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
486and F<.ix> files installed by this distribution are also included.
487
488For example, using this switch, when the L<URI> module is specified, then
489all L<URI> submodules that have been installed via the CPAN distribution
490are included as well, so you don't have to manually specify them.
491
492=item --incglob pattern
493
494This goes through all library directories and tries to match any F<.pm>
495and F<.pl> files against the extended glob pattern (see below). If a file
496matches, it is added. This switch will automatically detect L<AutoLoader>
497files and the required link libraries for XS modules, but it will I<not>
498scan the file for dependencies (at the moment).
499
500This is mainly useful to include "everything":
501
502 --incglob '*'
503
504Or to include perl libraries, or trees of those, such as the unicode
505database files needed by many other modules:
506
507 --incglob '/unicore/**.pl'
508
509=item --add file | --add "file alias"
510
511Adds the given (perl) file into the bundle (and optionally call it
512"alias"). This is useful to include any custom files into the bundle.
513
514Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
515
516 staticperl mkperl --add "httpd httpd.pm"
517
518It is also a great way to add any custom modules:
519
520 # specification file
521 add file1 myfiles/file1
522 add file2 myfiles/file2
523 add file3 myfiles/file3
524
525=item --binadd file | --add "file alias"
526
527Just like C<--add>, except that it treats the file as binary and adds it
528without any processing.
529
530You should probably add a C</> prefix to avoid clashing with embedded
531perl files (whose paths do not start with C</>), and/or use a special
532directory, such as C</res/name>.
533
534You can later get a copy of these files by calling C<staticperl::find
535"alias">.
536
537=item --include pattern | -i pattern | --exclude pattern | -x pattern
538
539These two options define an include/exclude filter that is used after all
540files selected by the other options have been found. Each include/exclude
541is applied to all files found so far - an include makes sure that the
542given files will be part of the resulting file set, an exclude will
543exclude files. The patterns are "extended glob patterns" (see below).
544
545For example, to include everything, except C<Devel> modules, but still
546include F<Devel::PPPort>, you could use this:
547
548 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
549
550=item --static 674=item --static
551 675
552When C<--perl> is also given, link statically instead of dynamically. The 676Add C<-static> to F<bundle.ldopts>, which means a fully static (if
677supported by the OS) executable will be created. This is not immensely
678useful when just creating the bundle files, but is most useful when
679linking a binary with the C<--perl> or C<--app> options.
680
553default is to link the new perl interpreter fully dynamic (that means all 681The default is to link the new binary dynamically (that means all perl
554perl modules are linked statically, but all external libraries are still 682modules are linked statically, but all external libraries are still
555referenced dynamically). 683referenced dynamically).
556 684
557Keep in mind that Solaris doesn't support static linking at all, and 685Keep in mind that Solaris doesn't support static linking at all, and
558systems based on GNU libc don't really support it in a usable fashion 686systems based on GNU libc don't really support it in a very usable
559either. Try uClibc if you want to create fully statically linked 687fashion either. Try uClibc if you want to create fully statically linked
560executables, or try the C<--staticlibs> option to link only some libraries 688executables, or try the C<--staticlib> option to link only some libraries
561statically. 689statically.
562 690
563=item --staticlib libname 691=item --staticlib libname
564 692
565When not linking fully statically, this option allows you to link specific 693When not linking fully statically, this option allows you to link specific
573 701
574Example: link libcrypt statically into the binary. 702Example: link libcrypt statically into the binary.
575 703
576 staticperl mkperl -MIO::AIO --staticlib crypt 704 staticperl mkperl -MIO::AIO --staticlib crypt
577 705
578 # ldopts might nwo contain: 706 # ldopts might now contain:
579 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread 707 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
580 708
581=item any other argument 709=back
582
583Any other argument is interpreted as a bundle specification file, which
584supports most long options (without extra quoting), one option per line.
585 710
586=back 711=back
587 712
588=head3 EXTENDED GLOB PATTERNS 713=head3 EXTENDED GLOB PATTERNS
589 714

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines