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.27 by root, Tue Dec 21 19:32:34 2010 UTC vs.
Revision 1.48 by root, Sun Jul 10 01:37:56 2011 UTC

9 staticperl configure # fetch and then configure perl 9 staticperl configure # fetch and then configure perl
10 staticperl build # configure and then build perl 10 staticperl build # configure and then build perl
11 staticperl install # build and then install perl 11 staticperl install # build and then install perl
12 staticperl clean # clean most intermediate files (restart at configure) 12 staticperl clean # clean most intermediate files (restart at configure)
13 staticperl distclean # delete everything installed by this script 13 staticperl distclean # delete everything installed by this script
14 staticperl perl ... # invoke the perlinterpreter
14 staticperl cpan # invoke CPAN shell 15 staticperl cpan # invoke CPAN shell
15 staticperl instmod path... # install unpacked modules 16 staticperl instmod path... # install unpacked modules
16 staticperl instcpan modulename... # install modules from CPAN 17 staticperl instcpan modulename... # install modules from CPAN
17 staticperl mkbundle <bundle-args...> # see documentation 18 staticperl mkbundle <bundle-args...> # see documentation
18 staticperl mkperl <bundle-args...> # see documentation 19 staticperl mkperl <bundle-args...> # see documentation
20 21
21Typical Examples: 22Typical Examples:
22 23
23 staticperl install # fetch, configure, build and install perl 24 staticperl install # fetch, configure, build and install perl
24 staticperl cpan # run interactive cpan shell 25 staticperl cpan # run interactive cpan shell
25 staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V 26 staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http 27 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27 # build a perl with the above modules linked in 28 # build a perl with the above modules linked in
28 staticperl mkapp myapp --boot mainprog mymodules 29 staticperl mkapp myapp --boot mainprog mymodules
29 # build a binary "myapp" from mainprog and mymodules 30 # build a binary "myapp" from mainprog and mymodules
30 31
38file that contains perl interpreter, libc, all the modules you need, all 39file that contains perl interpreter, libc, all the modules you need, all
39the libraries you need and of course your actual program. 40the libraries you need and of course your actual program.
40 41
41With F<uClibc> and F<upx> on x86, you can create a single 500kb binary 42With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
42that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, 43that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
43Coro and so on. Or any other choice of modules. 44Coro and so on. Or any other choice of modules (and some other size :).
44 45
45To see how this turns out, you can try out smallperl and bigperl, two 46To see how this turns out, you can try out smallperl and bigperl, two
46pre-built static and compressed perl binaries with many and even more 47pre-built static and compressed perl binaries with many and even more
47modules: just follow the links at L<http://staticperl.schmorp.de/>. 48modules: just follow the links at L<http://staticperl.schmorp.de/>.
48 49
83With F<staticperl>, the burden is mostly with the developer - only direct 84With F<staticperl>, the burden is mostly with the developer - only direct
84compile-time dependencies and L<AutoLoader> are handled automatically. 85compile-time dependencies and L<AutoLoader> are handled automatically.
85This means the modules to include often need to be tweaked manually. 86This means the modules to include often need to be tweaked manually.
86 87
87All this does not preclude more permissive modes to be implemented in 88All this does not preclude more permissive modes to be implemented in
88the future, but right now, you have to resolve state hidden dependencies 89the future, but right now, you have to resolve hidden dependencies
89manually. 90manually.
90 91
91=item * PAR works out of the box, F<staticperl> does not. 92=item * PAR works out of the box, F<staticperl> does not.
92 93
93Maintaining your own custom perl build can be a pain in the ass, and while 94Maintaining your own custom perl build can be a pain in the ass, and while
139with creating binaries and bundle files. 140with creating binaries and bundle files.
140 141
141=head2 PHASE 1 COMMANDS: INSTALLING PERL 142=head2 PHASE 1 COMMANDS: INSTALLING PERL
142 143
143The most important command is F<install>, which does basically 144The most important command is F<install>, which does basically
144everything. The default is to download and install perl 5.12.2 and a few 145everything. The default is to download and install perl 5.12.3 and a few
145modules required by F<staticperl> itself, but all this can (and should) be 146modules required by F<staticperl> itself, but all this can (and should) be
146changed - see L<CONFIGURATION>, below. 147changed - see L<CONFIGURATION>, below.
147 148
148The command 149The command
149 150
186=item F<staticperl install> 187=item F<staticperl install>
187 188
188Wipes the perl installation directory (usually F<~/.staticperl/perl>) and 189Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
189installs the perl distribution, potentially after building it first. 190installs the perl distribution, potentially after building it first.
190 191
192=item F<staticperl perl> [args...]
193
194Invokes the compiled perl interpreter with the given args. Basically the
195same as starting perl directly (usually via F<~/.staticperl/bin/perl>),
196but beats typing the path sometimes.
197
198Example: check that the Gtk2 module is installed and loadable.
199
200 staticperl perl -MGtk2 -e0
201
191=item F<staticperl cpan> [args...] 202=item F<staticperl cpan> [args...]
192 203
193Starts an interactive CPAN shell that you can use to install further 204Starts an interactive CPAN shell that you can use to install further
194modules. Installs the perl first if necessary, but apart from that, 205modules. Installs the perl first if necessary, but apart from that,
195no magic is involved: you could just as well run it manually via 206no magic is involved: you could just as well run it manually via
196F<~/.staticperl/perl/bin/cpan>. 207F<~/.staticperl/perl/bin/cpan>, except that F<staticperl> additionally
208sets the environment variable C<$PERL> to the path of the perl
209interpreter, which is handy in subshells.
197 210
198Any additional arguments are simply passed to the F<cpan> command. 211Any additional arguments are simply passed to the F<cpan> command.
199 212
200=item F<staticperl instcpan> module... 213=item F<staticperl instcpan> module...
201 214
252 265
253 # first make sure we have perl and the required modules 266 # first make sure we have perl and the required modules
254 staticperl instcpan AnyEvent::HTTPD 267 staticperl instcpan AnyEvent::HTTPD
255 268
256 # now build the perl 269 # now build the perl
257 staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ 270 staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258 -MAnyEvent::HTTPD -MURI::http \ 271 -MAnyEvent::HTTPD -MURI::http \
259 --add 'eg/httpd httpd.pm' 272 --add 'eg/httpd httpd.pm'
260 273
261 # finally, invoke it 274 # finally, invoke it
262 ./perl -Mhttpd 275 ./perl -Mhttpd
381 394
382=over 4 395=over 4
383 396
384=item C<--use> F<module> | C<-M>F<module> 397=item C<--use> F<module> | C<-M>F<module>
385 398
386Include the named module and trace direct dependencies. This is done by 399Include the named module or perl library and trace direct
387C<require>'ing the module in a subprocess and tracing which other modules 400dependencies. This is done by loading the module in a subprocess and
388and files it actually loads. 401tracing which other modules and files it actually loads.
389 402
390Example: include AnyEvent and AnyEvent::Impl::Perl. 403Example: include AnyEvent and AnyEvent::Impl::Perl.
391 404
392 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl 405 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
393 406
394Sometimes you want to load old-style "perl libraries" (F<.pl> files), or 407Sometimes 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 408maybe other weirdly named files. To support this, the C<--use> option
396single or double quotes. When given on the command line, you probably need 409actually tries to do what you mean, depending on the string you specify:
397to quote once more to avoid your shell interpreting it. Common cases that 410
398need this are F<Config_heavy.pl> and F<utf8_heavy.pl>. 411=over 4
412
413=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
414F<Coro::Mysql>.
415
416If the string contains no quotes, no F</> and no F<.>, then C<--use>
417assumes that it is a normal module name. It will create a new package and
418evaluate a C<use module> in it, i.e. it will load the package and do a
419default import.
420
421The import step is done because many modules trigger more dependencies
422when something is imported than without.
423
424=item anything that contains F</> or F<.> characters,
425e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
426
427The string will be quoted and passed to require, as if you used C<require
428$module>. Nothing will be imported.
429
430=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
431
432If you enclose the name into single or double quotes, then the quotes will
433be removed and the resulting string will be passed to require. This syntax
434is form compatibility with older versions of staticperl and should not be
435used anymore.
436
437=back
438
439Example: C<use> AnyEvent::Socket, once using C<use> (importing the
440symbols), and once via C<require>, not importing any symbols. The first
441form is preferred as many modules load some extra dependencies when asked
442to export symbols.
443
444 staticperl mkbundle -MAnyEvent::Socket # use + import
445 staticperl mkbundle -MAnyEvent/Socket.pm # require only
399 446
400Example: include the required files for F<perl -V> to work in all its 447Example: include the required files for F<perl -V> to work in all its
401glory (F<Config.pm> is included automatically by this). 448glory (F<Config.pm> is included automatically by the dependency tracker).
402 449
403 # bourne shell 450 # shell command
404 staticperl mkbundle --use '"Config_heavy.pl"' 451 staticperl mkbundle -MConfig_heavy.pl
405 452
406 # bundle specification file 453 # bundle specification file
407 use "Config_heavy.pl" 454 use Config_heavy.pl
408 455
409The C<-M>module syntax is included as an alias that might be easier to 456The C<-M>module syntax is included as a convenience that might be easier
410remember than C<--use>. Or maybe it confuses people. Time will tell. Or 457to remember than C<--use> - it's the same switch as perl itself uses
458to load modules. Or maybe it confuses people. Time will tell. Or maybe
411maybe not. Sigh. 459not. Sigh.
412 460
413=item C<--eval> "perl code" | C<-e> "perl code" 461=item C<--eval> "perl code" | C<-e> "perl code"
414 462
415Sometimes it is easier (or necessary) to specify dependencies using perl 463Sometimes 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 464code, 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 465that 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 466variables or whatever you need. All files C<require>'d or C<use>'d while
419executing the snippet are included in the final bundle. 467executing the snippet are included in the final bundle.
420 468
421Keep in mind that F<mkbundle> will only C<require> the modules named 469Keep in mind that F<mkbundle> will not import any symbols from the modules
422by the C<--use> option, so do not expect the symbols from modules you 470named by the C<--use> option, so do not expect the symbols from modules
423C<--use>'d earlier on the command line to be available. 471you C<--use>'d earlier on the command line to be available.
424 472
425Example: force L<AnyEvent> to detect a backend and therefore include it 473Example: force L<AnyEvent> to detect a backend and therefore include it
426in the final bundle. 474in the final bundle.
427 475
428 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' 476 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
455This is very useful to include "everything": 503This is very useful to include "everything":
456 504
457 --incglob '*' 505 --incglob '*'
458 506
459It is also useful for including perl libraries, or trees of those, such as 507It 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 508the unicode database files needed by some perl built-ins, the regex engine
461and other modules. 509and other modules.
462 510
463 --incglob '/unicore/**.pl' 511 --incglob '/unicore/**.pl'
464 512
465=item C<--add> F<file> | C<--add> "F<file> alias" 513=item C<--add> F<file> | C<--add> "F<file> alias"
466 514
467Adds the given (perl) file into the bundle (and optionally call it 515Adds 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 516"alias"). The F<file> is either an absolute path or a path relative to the
469the current directory. If an alias is specified, then this is the name it 517current directory. If an alias is specified, then this is the name it will
470will use for C<@INC> searches, otherfile the F<file> will be used as the 518use for C<@INC> searches, otherwise the path F<file> will be used as the
471internal name. 519internal name.
472 520
473This switch is used to include extra files into the bundle. 521This switch is used to include extra files into the bundle.
474 522
475Example: embed the file F<httpd> in the current directory as F<httpd.pm> 523Example: embed the file F<httpd> in the current directory as F<httpd.pm>
476when creating the bundle. 524when creating the bundle.
477 525
478 staticperl mkperl --add "httpd httpd.pm" 526 staticperl mkperl --add "httpd httpd.pm"
527
528 # can be accessed via "use httpd"
529
530Example: add a file F<initcode> from the current directory.
531
532 staticperl mkperl --add 'initcode &initcode'
533
534 # can be accessed via "do '&initcode'"
479 535
480Example: add local files as extra modules in the bundle. 536Example: add local files as extra modules in the bundle.
481 537
482 # specification file 538 # specification file
483 add file1 myfiles/file1.pm 539 add file1 myfiles/file1.pm
493 549
494Just like C<--add>, except that it treats the file as binary and adds it 550Just 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 551without any postprocessing (perl files might get stripped to reduce their
496size). 552size).
497 553
498You should probably add a C</> prefix to avoid clashing with embedded perl 554If you specify an alias you should probably add a C</> prefix to avoid
499files (whose paths do not start with C</>), and/or use a special directory 555clashing with embedded perl files (whose paths never start with C</>),
500prefix, such as C</res/name>. 556and/or use a special directory prefix, such as C</res/name>.
501 557
502You can later get a copy of these files by calling C<staticperl::find 558You can later get a copy of these files by calling C<staticperl::find
503"alias">. 559"alias">.
504 560
505An alternative way to embed binary files is to convert them to perl and 561An 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 562use C<do> to get the contents - this method is a bit cumbersome, but works
507both inside and outside of a staticperl bundle: 563both inside and outside of a staticperl bundle, without extra ado:
508 564
509 # a "binary" file, call it "bindata.pl" 565 # a "binary" file, call it "bindata.pl"
510 <<'SOME_MARKER' 566 <<'SOME_MARKER'
511 binary data NOT containing SOME_MARKER 567 binary data NOT containing SOME_MARKER
512 SOME_MARKER 568 SOME_MARKER
513 569
514 # load the binary 570 # load the binary
515 chomp (my $data = do "bindata.pl"); 571 chomp (my $data = do "bindata.pl");
516 572
573=item C<--allow-dynamic>
574
575By default, when F<mkbundle> hits a dynamic perl extension (e.g. a F<.so>
576or F<.dll> file), it will stop with a fatal error.
577
578When this option is enabled, F<mkbundle> packages the shared
579object into the bundle instead, with a prefix of F<!>
580(e.g. F<!auto/List/Util/Util.so>). What you do with that is currently up
581to you, F<staticperl> has no special support for this at the moment, apart
582from working around the lack of availability of F<PerlIO::scalar> while
583bootstrapping, at a speed cost.
584
585One way to deal with this is to write all files starting with F<!> into
586some directory and then C<unshift> that path onto C<@INC>.
587
588#TODO: example
589
517=back 590=back
518 591
519=item Step 2: filter all files using C<--include> and C<--exclude> options. 592=item Step 2: filter all files using C<--include> and C<--exclude> options.
520 593
521After all candidate files and modules are added, they are I<filtered> 594After all candidate files and modules are added, they are I<filtered>
522by a combination of C<--include> and C<--exclude> patterns (there is an 595by 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 596implicit C<--include *> at the end, so if no filters are specified, all
524files are included). 597files are included).
525 598
526All that this step does is potentially reduce the number of files that are 599All that this step does is potentially reduce the number of files that are
527to be included - no new files are added during this step. 600to be included - no new files are added during this step.
528 601
553that are added automatically. Only one (F<.packlist> files) is currently 626that are added automatically. Only one (F<.packlist> files) is currently
554optional and can be influenced, the others are always included: 627optional and can be influenced, the others are always included:
555 628
556=over 4 629=over 4
557 630
558=item C<--usepacklist> 631=item C<--usepacklists>
559 632
560Read F<.packlist> files for each distribution that happens to match a 633Read F<.packlist> files for each distribution that happens to match a
561module name you specified. Sounds weird, and it is, so expect semantics to 634module name you specified. Sounds weird, and it is, so expect semantics to
562change somehow in the future. 635change somehow in the future.
563 636
631Last not least, if you need accurate line numbers in error messages, 704Last not least, if you need accurate line numbers in error messages,
632or in the unlikely case where C<pod> is too slow, or some module gets 705or in the unlikely case where C<pod> is too slow, or some module gets
633mistreated, you can specify C<none> to not mangle included perl sources in 706mistreated, you can specify C<none> to not mangle included perl sources in
634any way. 707any way.
635 708
636=item --perl 709=item C<--perl>
637 710
638After writing out the bundle files, try to link a new perl interpreter. It 711After writing out the bundle files, try to link a new perl interpreter. It
639will be called F<perl> and will be left in the current working 712will be called F<perl> and will be left in the current working
640directory. The bundle files will be removed. 713directory. The bundle files will be removed.
641 714
646it will be even smaller than the standard perl interpreter as none of the 719it 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. 720modules of the base distribution (such as L<Fcntl>) will be included.
648 721
649 staticperl mkperl -Mcommon::sense 722 staticperl mkperl -Mcommon::sense
650 723
651=item --app name 724=item C<--app> F<name>
652 725
653After writing out the bundle files, try to link a new standalone 726After writing out the bundle files, try to link a new standalone
654program. It will be called C<name>, and the bundle files get removed after 727program. It will be called C<name>, and the bundle files get removed after
655linking it. 728linking it.
656 729
660The difference to the (mutually exclusive) C<--perl> option is that the 733The difference to the (mutually exclusive) C<--perl> option is that the
661binary created by this option will not try to act as a perl interpreter - 734binary created by this option will not try to act as a perl interpreter -
662instead it will simply initialise the perl interpreter, clean it up and 735instead it will simply initialise the perl interpreter, clean it up and
663exit. 736exit.
664 737
665This means that, by default, it will do nothing but burna few CPU cycles 738This means that, by default, it will do nothing but burn a few CPU cycles
666- for it to do something useful you I<must> add some boot code, e.g. with 739- for it to do something useful you I<must> add some boot code, e.g. with
667the C<--boot> option. 740the C<--boot> option.
668 741
669Example: create a standalone perl binary called F<./myexe> that will 742Example: create a standalone perl binary called F<./myexe> that will
670execute F<appfile> when it is started. 743execute F<appfile> when it is started.
671 744
672 staticperl mkbundle --app myexe --boot appfile 745 staticperl mkbundle --app myexe --boot appfile
673 746
747=item C<--ignore-env>
748
749Generates extra code to unset some environment variables before
750initialising/running perl. Perl supports a lot of environment variables
751that might alter execution in ways that might be undesirablre for
752standalone applications, and this option removes those known to cause
753trouble.
754
755Specifically, these are removed:
756
757C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
758output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
759C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
760C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
761
762The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
763startup code used by F<staticperl> overrides C<@INC> in all cases.
764
765This option will not make your program more secure (unless you are
766running with elevated privileges), but it will reduce the surprise effect
767when a user has these environment variables set and doesn't expect your
768standalone program to act like a perl interpreter.
769
674=item --static 770=item C<--static>
675 771
676Add C<-static> to F<bundle.ldopts>, which means a fully static (if 772Add C<-static> to F<bundle.ldopts>, which means a fully static (if
677supported by the OS) executable will be created. This is not immensely 773supported by the OS) executable will be created. This is not immensely
678useful when just creating the bundle files, but is most useful when 774useful when just creating the bundle files, but is most useful when
679linking a binary with the C<--perl> or C<--app> options. 775linking a binary with the C<--perl> or C<--app> options.
686systems based on GNU libc don't really support it in a very usable 782systems based on GNU libc don't really support it in a very usable
687fashion either. Try uClibc if you want to create fully statically linked 783fashion either. Try uClibc if you want to create fully statically linked
688executables, or try the C<--staticlib> option to link only some libraries 784executables, or try the C<--staticlib> option to link only some libraries
689statically. 785statically.
690 786
691=item --staticlib libname 787=item C<--staticlib> libname
692 788
693When not linking fully statically, this option allows you to link specific 789When not linking fully statically, this option allows you to link specific
694libraries statically. What it does is simply replace all occurances of 790libraries statically. What it does is simply replace all occurrences of
695C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> 791C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
696option. 792option.
697 793
698This will have no effect unless the library is actually linked against, 794This will have no effect unless the library is actually linked against,
699specifically, C<--staticlib> will not link against the named library 795specifically, C<--staticlib> will not link against the named library
700unless it would be linked against anyway. 796unless it would be linked against anyway.
701 797
702Example: link libcrypt statically into the binary. 798Example: link libcrypt statically into the final binary.
703 799
704 staticperl mkperl -MIO::AIO --staticlib crypt 800 staticperl mkperl -MIO::AIO --staticlib crypt
705 801
706 # ldopts might now contain: 802 # ldopts might now contain:
707 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread 803 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
728=item Patterns not starting with F</> will be anchored at the end of the path. 824=item Patterns not starting with F</> will be anchored at the end of the path.
729 825
730That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the 826That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
731hierarchy, but not any directories of the same name. 827hierarchy, but not any directories of the same name.
732 828
733=item A F<*> matches any single component. 829=item A F<*> matches anything within a single path component.
734 830
735That is, F</unicore/*.pl> would match all F<.pl> files directly inside 831That is, F</unicore/*.pl> would match all F<.pl> files directly inside
736C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> 832C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
737will not match slashes. 833will not match slashes.
738 834
805=item C<STATICPERL> 901=item C<STATICPERL>
806 902
807The directory where staticperl stores all its files 903The directory where staticperl stores all its files
808(default: F<~/.staticperl>). 904(default: F<~/.staticperl>).
809 905
906=item C<DLCACHE>
907
908The path to a directory (will be created if it doesn't exist) where
909downloaded perl sources are being cached, to avoid downloading them
910again. The default is empty, which means there is no cache.
911
912=item C<PERL_VERSION>
913
914The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
915is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
916about as big as 5.12.3).
917
810=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ... 918=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
811 919
812Usually set to C<1> to make modules "less inquisitive" during their 920Usually set to C<1> to make modules "less inquisitive" during their
813installation, you can set any environment variable you want - some modules 921installation. You can set (and export!) any environment variable you want
814(such as L<Coro> or L<EV>) use environment variables for further tweaking. 922- some modules (such as L<Coro> or L<EV>) use environment variables for
815 923further tweaking.
816=item C<PERL_VERSION>
817
818The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
819is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
820about as big as 5.12.2).
821 924
822=item C<PERL_PREFIX> 925=item C<PERL_PREFIX>
823 926
824The prefix where perl gets installed (default: F<$STATICPERL/perl>), 927The prefix where perl gets installed (default: F<$STATICPERL/perl>),
825i.e. where the F<bin> and F<lib> subdirectories will end up. 928i.e. where the F<bin> and F<lib> subdirectories will end up.
846F<~/.staticperlrc> to override them. 949F<~/.staticperlrc> to override them.
847 950
848Most of the variables override (or modify) the corresponding F<Configure> 951Most of the variables override (or modify) the corresponding F<Configure>
849variable, except C<PERL_CCFLAGS>, which gets appended. 952variable, except C<PERL_CCFLAGS>, which gets appended.
850 953
954You should have a look near the beginning of the F<staticperl> script -
955staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
956suitable for newer gcc versions. For other compilers or older versions you
957need to adjust these, for example, in your F<~/.staticperlrc>.
958
851=back 959=back
852 960
853=head4 Variables you probably I<do not want> to override 961=head4 Variables you probably I<do not want> to override
854 962
855=over 4 963=over 4
873=head3 OVERRIDABLE HOOKS 981=head3 OVERRIDABLE HOOKS
874 982
875In addition to environment variables, it is possible to provide some 983In addition to environment variables, it is possible to provide some
876shell functions that are called at specific times. To provide your own 984shell functions that are called at specific times. To provide your own
877commands, just define the corresponding function. 985commands, just define the corresponding function.
986
987The actual order in which hooks are invoked during a full install
988from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
989C<postbuild>, C<postinstall>.
878 990
879Example: install extra modules from CPAN and from some directories 991Example: install extra modules from CPAN and from some directories
880at F<staticperl install> time. 992at F<staticperl install> time.
881 993
882 postinstall() { 994 postinstall() {
889 1001
890=over 4 1002=over 4
891 1003
892=item preconfigure 1004=item preconfigure
893 1005
894Called just before running F<./Configur> in the perl source 1006Called just before running F<./Configure> in the perl source
895directory. Current working directory is the perl source directory. 1007directory. Current working directory is the perl source directory.
896 1008
897This can be used to set any C<PERL_xxx> variables, which might be costly 1009This can be used to set any C<PERL_xxx> variables, which might be costly
898to compute. 1010to compute.
899 1011
1012=item patchconfig
1013
1014Called after running F<./Configure> in the perl source directory to create
1015F<./config.sh>, but before running F<./Configure -S> to actually apply the
1016config. Current working directory is the perl source directory.
1017
1018Can be used to tailor/patch F<config.sh> or do any other modifications.
1019
900=item postconfigure 1020=item postconfigure
901 1021
902Called after configuring, but before building perl. Current working 1022Called after configuring, but before building perl. Current working
903directory is the perl source directory. 1023directory is the perl source directory.
904
905Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
906or do any other modifications.
907 1024
908=item postbuild 1025=item postbuild
909 1026
910Called after building, but before installing perl. Current working 1027Called after building, but before installing perl. Current working
911directory is the perl source directory. 1028directory is the perl source directory.
949A header file that contains the prototypes of the few symbols "exported" 1066A header file that contains the prototypes of the few symbols "exported"
950by bundle.c, and also exposes the perl headers to the application. 1067by bundle.c, and also exposes the perl headers to the application.
951 1068
952=over 4 1069=over 4
953 1070
954=item staticperl_init () 1071=item staticperl_init (xs_init = 0)
955 1072
956Initialises the perl interpreter. You can use the normal perl functions 1073Initialises the perl interpreter. You can use the normal perl functions
957after calling this function, for example, to define extra functions or 1074after calling this function, for example, to define extra functions or
958to load a .pm file that contains some initialisation code, or the main 1075to load a .pm file that contains some initialisation code, or the main
959program function: 1076program function:
966 } 1083 }
967 1084
968 static void 1085 static void
969 run_myapp(void) 1086 run_myapp(void)
970 { 1087 {
971 staticperl_init (); 1088 staticperl_init (0);
972 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); 1089 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
973 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" 1090 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
974 } 1091 }
975 1092
1093When your bootcode already wants to access some XS functions at
1094compiletime, then you need to supply an C<xs_init> function pointer that
1095is called as soon as perl is initialised enough to define XS functions,
1096but before the preamble code is executed:
1097
1098 static void
1099 xs_init (pTHX)
1100 {
1101 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
1102 }
1103
1104 static void
1105 run_myapp(void)
1106 {
1107 staticperl_init (xs_init);
1108 }
1109
1110=item staticperl_cleanup ()
1111
1112In the unlikely case that you want to destroy the perl interpreter, here
1113is the corresponding function.
1114
976=item staticperl_xs_init (pTHX) 1115=item staticperl_xs_init (pTHX)
977 1116
978Sometimes you need direct control over C<perl_parse> and C<perl_run>, in 1117Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
979which case you do not want to use C<staticperl_init> but call them on your 1118which case you do not want to use C<staticperl_init> but call them on your
980own. 1119own.
981 1120
982Then you need this function - either pass it directly as the C<xs_init> 1121Then you need this function - either pass it directly as the C<xs_init>
983function to C<perl_parse>, or call it from your own C<xs_init> function. 1122function to C<perl_parse>, or call it as one of the first things from your
984 1123own C<xs_init> function.
985=item staticperl_cleanup ()
986
987In the unlikely case that you want to destroy the perl interpreter, here
988is the corresponding function.
989 1124
990=item PerlInterpreter *staticperl 1125=item PerlInterpreter *staticperl
991 1126
992The perl interpreter pointer used by staticperl. Not normally so useful, 1127The perl interpreter pointer used by staticperl. Not normally so useful,
993but there it is. 1128but there it is.
1006 1141
1007=back 1142=back
1008 1143
1009=head1 RUNTIME FUNCTIONALITY 1144=head1 RUNTIME FUNCTIONALITY
1010 1145
1011Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which 1146Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
1012are required to access the bundled perl sources, but might be useful for 1147mostly related to the extra files bundled in the binary (the virtual
1013other purposes. 1148filesystem). All of this data is statically compiled into the binary, and
1149accessing means copying it from a read-only section of your binary. Data
1150pages in this way is usually freed by the operating system, as it isn't
1151use more the onace.
1152
1153=head2 VIRTUAL FILESYSTEM
1154
1155Every bundle has a virtual filesystem. The only information stored in it
1156is the path and contents of each file that was bundled.
1157
1158=head3 LAYOUT
1159
1160Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
1161reserved by F<staticperl>. They must only be used as described in this
1162section.
1163
1164=over 4
1165
1166=item !
1167
1168All files that typically cannot be loaded from memory (such as dynamic
1169objects or shared libraries), but have to reside in the filesystem, are
1170prefixed with F<!>. Typically these files get written out to some
1171(semi-)temporary directory shortly after program startup, or before being
1172used.
1173
1174=item !boot
1175
1176The bootstrap file, if specified during bundling.
1177
1178=item !auto/
1179
1180Shared objects or dlls corresponding to dynamically-linked perl extensions
1181are stored with an F<!auto/> prefix.
1182
1183=item !lib/
1184
1185External shared libraries are stored in this directory.
1186
1187=item any letter
1188
1189Any path starting with a letter is a perl library file. For example,
1190F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
1191F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
1192
1193Obviously, module names shouldn't start with any other characters than
1194letters :)
1195
1196=back
1197
1198=head3 FUNCTIONS
1199
1200=over 4
1201
1202=item $file = staticperl::find $path
1203
1204Returns the data associated with the given C<$path>
1205(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
1206
1207Returns C<undef> if the file isn't embedded.
1208
1209=item @paths = staticperl::list
1210
1211Returns the list of all paths embedded in this binary.
1212
1213=back
1214
1215=head2 EXTRA FEATURES
1014 1216
1015In addition, for the embedded loading of perl files to work, F<staticperl> 1217In addition, for the embedded loading of perl files to work, F<staticperl>
1016overrides the C<@INC> array. 1218overrides the C<@INC> array.
1017 1219
1018=over 4
1019
1020=item $file = staticperl::find $path
1021
1022Returns the data associated with the given C<$path>
1023(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
1024the UNIX path relative to the perl library directory.
1025
1026Returns C<undef> if the file isn't embedded.
1027
1028=item @paths = staticperl::list
1029
1030Returns the list of all paths embedded in this binary.
1031
1032=back
1033
1034=head1 FULLY STATIC BINARIES - BUILDROOT 1220=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1035 1221
1036To make truly static (Linux-) libraries, you might want to have a look at 1222To make truly static (Linux-) libraries, you might want to have a look at
1037buildroot (L<http://buildroot.uclibc.org/>). 1223buildroot (L<http://buildroot.uclibc.org/>).
1038 1224
1039Buildroot is primarily meant to set up a cross-compile environment (which 1225Buildroot is primarily meant to set up a cross-compile environment (which
1046good experiences with GCC 4.4.x but not GCC 4.5. 1232good experiences with GCC 4.4.x but not GCC 4.5.
1047 1233
1048To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections 1234To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
1049-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386> 1235-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
1050doesn't decrease codesize much, but it makes the file much more 1236doesn't decrease codesize much, but it makes the file much more
1051compressible. 1237compressible (and the execution a lot slower...).
1052 1238
1053If you don't need Coro or threads, you can go with "linuxthreads.old" (or 1239If you don't need Coro or threads, you can go with "linuxthreads.old" (or
1054no thread support). For Coro, it is highly recommended to switch to a 1240no thread support). For Coro, it is highly recommended to switch to a
1055uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201 1241uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
1056snapshot) and enable NPTL, otherwise Coro needs to be configured with the 1242snapshot) and enable NPTL, otherwise Coro needs to be configured with the
1058twice the address space needed for stacks). 1244twice the address space needed for stacks).
1059 1245
1060If you use C<linuxthreads.old>, then you should also be aware that 1246If you use C<linuxthreads.old>, then you should also be aware that
1061uClibc shares C<errno> between all threads when statically linking. See 1247uClibc shares C<errno> between all threads when statically linking. See
1062L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a 1248L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
1063workaround (And L<https://bugs.uclibc.org/2089> for discussion). 1249workaround (and L<https://bugs.uclibc.org/2089> for discussion).
1064 1250
1065C<ccache> support is also recommended, especially if you want 1251C<ccache> support is also recommended, especially if you want
1066to play around with buildroot options. Enabling the C<miniperl> 1252to play around with buildroot options. Enabling the C<miniperl>
1067package will probably enable all options required for a successful 1253package will probably enable all options required for a successful
1068perl build. F<staticperl> itself additionally needs either C<wget> 1254perl build. F<staticperl> itself additionally needs either C<wget>
1076it from working properly in a chroot - either use dash (and link it to 1262it from working properly in a chroot - either use dash (and link it to
1077F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's 1263F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
1078built-in ash shell. 1264built-in ash shell.
1079 1265
1080Finally, you need F</dev/null> inside the chroot for many scripts to work 1266Finally, you need F</dev/null> inside the chroot for many scripts to work
1081- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will 1267- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
1082both provide this. 1268will provide this.
1083 1269
1084After you have compiled and set up your buildroot target, you can copy 1270After you have compiled and set up your buildroot target, you can copy
1085F<staticperl> from the C<App::Staticperl> distribution or from your 1271F<staticperl> from the C<App::Staticperl> distribution or from your
1086perl f<bin> directory (if you installed it) into the F<output/target> 1272perl F<bin> directory (if you installed it) into the F<output/target>
1087filesystem, chroot inside and run it. 1273filesystem, chroot inside and run it.
1088 1274
1089=head1 RECIPES / SPECIFIC MODULES 1275=head1 RECIPES / SPECIFIC MODULES
1090 1276
1091This section contains some common(?) recipes and information about 1277This section contains some common(?) recipes and information about
1100 1286
1101Some functionality in the utf8 module, such as swash handling (used 1287Some functionality in the utf8 module, such as swash handling (used
1102for unicode character ranges in regexes) is implemented in the 1288for unicode character ranges in regexes) is implemented in the
1103C<"utf8_heavy.pl"> library: 1289C<"utf8_heavy.pl"> library:
1104 1290
1105 -M'"utf8_heavy.pl"' 1291 -Mutf8_heavy.pl
1106 1292
1107Many Unicode properties in turn are defined in separate modules, 1293Many Unicode properties in turn are defined in separate modules,
1108such as C<"unicore/Heavy.pl"> and more specific data tables such as 1294such as C<"unicore/Heavy.pl"> and more specific data tables such as
1109C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables 1295C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1110are big (7MB uncompressed, although F<staticperl> contains special 1296are big (7MB uncompressed, although F<staticperl> contains special
1111handling for those files), so including them on demand by your application 1297handling for those files), so including them on demand by your application
1112only might pay off. 1298only might pay off.
1113 1299
1114To simply include the whole unicode database, use: 1300To simply include the whole unicode database, use:
1115 1301
1116 --incglob '/unicore/*.pl' 1302 --incglob '/unicore/**.pl'
1117 1303
1118=item AnyEvent 1304=item AnyEvent
1119 1305
1120AnyEvent needs a backend implementation that it will load in a delayed 1306AnyEvent needs a backend implementation that it will load in a delayed
1121fashion. The L<AnyEvent::Impl::Perl> backend is the default choice 1307fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
1126 1312
1127If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn 1313If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1128functions), you also need to include C<"AnyEvent/Util/idna.pl"> and 1314functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1129C<"AnyEvent/Util/uts46data.pl">. 1315C<"AnyEvent/Util/uts46data.pl">.
1130 1316
1131Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include 1317Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1132everything. 1318everything.
1319
1320=item Cairo
1321
1322See Glib, same problem, same solution.
1133 1323
1134=item Carp 1324=item Carp
1135 1325
1136Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of 1326Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1137perl 5.12.2 (maybe earlier), this dependency no longer exists. 1327perl 5.12.2 (maybe earlier), this dependency no longer exists.
1140 1330
1141The F<perl -V> switch (as well as many modules) needs L<Config>, which in 1331The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1142turn might need L<"Config_heavy.pl">. Including the latter gives you 1332turn might need L<"Config_heavy.pl">. Including the latter gives you
1143both. 1333both.
1144 1334
1335=item Glib
1336
1337Glib literally requires Glib to be installed already to build - it tries
1338to fake this by running Glib out of the build directory before being
1339built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
1340C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
1341
1342=item Gtk2
1343
1344See Pango, same problems, same solution.
1345
1346=item Pango
1347
1348In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
1349L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
1350tries to patch L<ExtUtils::MM_Unix> to route around Pango.
1351
1145=item Term::ReadLine::Perl 1352=item Term::ReadLine::Perl
1146 1353
1147Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. 1354Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1148 1355
1149=item URI 1356=item URI
1150 1357
1151URI implements schemes as separate modules - the generic URL scheme is 1358URI implements schemes as separate modules - the generic URL scheme is
1152implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If 1359implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1153you need to use any of these schemes, you should include these manually, 1360you need to use any of these schemes, you should include these manually,
1154or use C<--usepacklist>. 1361or use C<--usepacklists>.
1155 1362
1156=back 1363=back
1157 1364
1158=head2 RECIPES 1365=head2 RECIPES
1159 1366
1160=over 4 1367=over 4
1161 1368
1162=item Linking everything in 1369=item Just link everything in
1163 1370
1164To link just about everything installed in the perl library into a new 1371To link just about everything installed in the perl library into a new
1165perl, try this: 1372perl, try this (the first time this runs it will take a long time, as a
1373lot of files need to be parsed):
1166 1374
1167 staticperl mkperl --strip ppi --incglob '*' 1375 staticperl mkperl -v --strip ppi --incglob '*'
1168 1376
1377If you don't mind the extra megabytes, this can be a very effective way of
1378creating bundles without having to worry about forgetting any modules.
1379
1380You get even more useful variants of this method by first selecting
1381everything, and then excluding stuff you are reasonable sure not to need -
1382L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach.
1383
1169=item Getting rid of netdb function 1384=item Getting rid of netdb functions
1170 1385
1171The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> 1386The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1172and so on) that few applications use. You can avoid compiling them in by 1387and so on) that few applications use. You can avoid compiling them in by
1173putting the following fragment into a C<preconfigure> hook: 1388putting the following fragment into a C<preconfigure> hook:
1174 1389
1191 do 1406 do
1192 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" 1407 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1193 done 1408 done
1194 } 1409 }
1195 1410
1196This mostly gains space when linking staticaly, as the functions will 1411This mostly gains space when linking statically, as the functions will
1197likely not be linked in. The gain for dynamically-linked binaries is 1412likely not be linked in. The gain for dynamically-linked binaries is
1198smaller. 1413smaller.
1199 1414
1200Also, this leaves C<gethostbyname> in - not only is it actually used 1415Also, this leaves C<gethostbyname> in - not only is it actually used
1201often, the L<Socket> module also exposes it, so leaving it out usually 1416often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines