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.40 by root, Sun May 1 09:29:47 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
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
185 186
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.
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
190 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,
252 263
253 # first make sure we have perl and the required modules 264 # first make sure we have perl and the required modules
254 staticperl instcpan AnyEvent::HTTPD 265 staticperl instcpan AnyEvent::HTTPD
255 266
256 # now build the perl 267 # now build the perl
257 staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ 268 staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258 -MAnyEvent::HTTPD -MURI::http \ 269 -MAnyEvent::HTTPD -MURI::http \
259 --add 'eg/httpd httpd.pm' 270 --add 'eg/httpd httpd.pm'
260 271
261 # finally, invoke it 272 # finally, invoke it
262 ./perl -Mhttpd 273 ./perl -Mhttpd
278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http 289 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
279 290
280 # run it 291 # run it
281 ./app 292 ./app
282 293
294Here are the three phase 2 commands:
295
296=over 4
297
298=item F<staticperl mkbundle> args...
299
300The "default" bundle command - it interprets the given bundle options and
301writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
302files, useful for embedding.
303
304=item F<staticperl mkperl> args...
305
306Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
307as invoking F<staticperl mkbundle --perl> args...), but then compiles and
308links a new perl interpreter that embeds the created bundle, then deletes
309all intermediate files.
310
311=item F<staticperl mkapp> filename args...
312
313Does the same as F<staticperl mkbundle> (in fact, it's the same as
314invoking F<staticperl mkbundle --app> filename args...), but then compiles
315and links a new standalone application that simply initialises the perl
316interpreter.
317
318The difference to F<staticperl mkperl> is that the standalone application
319does not act like a perl interpreter would - in fact, by default it would
320just do nothing and exit immediately, so you should specify some code to
321be executed via the F<--boot> option.
322
323=back
324
283=head3 OPTION PROCESSING 325=head3 OPTION PROCESSING
284 326
285All options can be given as arguments on the command line (typically 327All 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 328using 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, 329specifying 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 330unwieldy, you can put all long options into a "bundle specification file"
289without C<--> prefix) and specify this bundle file instead. 331(one option per line, with or without C<--> prefix) and specify this
332bundle file instead.
290 333
291For example, the command given earlier could also look like this: 334For example, the command given earlier to link a new F<perl> could also
335look like this:
292 336
293 staticperl mkperl httpd.bundle 337 staticperl mkperl httpd.bundle
294 338
295And all options could be in F<httpd.bundle>: 339With all options stored in the F<httpd.bundle> file (one option per line,
296 340everything after the option is an argument):
341
297 use "Config_heavy.pl" 342 use "Config_heavy.pl"
298 use AnyEvent::Impl::Perl 343 use AnyEvent::Impl::Perl
299 use AnyEvent::HTTPD 344 use AnyEvent::HTTPD
300 use URI::http 345 use URI::http
301 add eg/httpd httpd.pm 346 add eg/httpd httpd.pm
302 347
303All options that specify modules or files to be added are processed in the 348All 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> 349order given on the command line.
305options at the moment).
306 350
307=head3 PACKAGE SELECTION WORKFLOW 351=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
308 352
309F<staticperl mkbundle> has a number of options to control package 353F<staticperl mkbundle> works by first assembling a list of candidate
310selection. This section describes how they interact with each other. Also, 354files 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 355patterns. The remaining modules (together with their direct dependencies,
312F<staticperl> will change this, so watch out :) 356such as link libraries and L<AutoLoader> files) are then converted into
357bundle files suitable for embedding. F<staticperl mkbundle> can then
358optionally build a new perl interpreter or a standalone application.
313 359
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 360=over 4
319 361
320=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and 362=item Step 0: Generic argument processing.
321C<--incglob> options, in order.
322 363
323In addition, C<--use> and C<--eval> dependencies will be added when the 364The following options influence F<staticperl mkbundle> itself.
324options are processed.
325 365
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 366=over 4
348 367
349=item --verbose | -v 368=item C<--verbose> | C<-v>
350 369
351Increases the verbosity level by one (the default is C<1>). 370Increases the verbosity level by one (the default is C<1>).
352 371
353=item --quiet | -q 372=item C<--quiet> | C<-q>
354 373
355Decreases the verbosity level by one. 374Decreases the verbosity level by one.
356 375
376=item any other argument
377
378Any other argument is interpreted as a bundle specification file, which
379supports all options (without extra quoting), one option per line, in the
380format C<option> or C<option argument>. They will effectively be expanded
381and processed as if they were directly written on the command line, in
382place of the file name.
383
384=back
385
386=item Step 1: gather candidate files and modules
387
388In this step, modules, perl libraries (F<.pl> files) and other files are
389selected for inclusion in the bundle. The relevant options are executed
390in order (this makes a difference mostly for C<--eval>, which can rely on
391earlier C<--use> options to have been executed).
392
393=over 4
394
395=item C<--use> F<module> | C<-M>F<module>
396
397Include the named module or perl library and trace direct
398dependencies. This is done by loading the module in a subprocess and
399tracing which other modules and files it actually loads.
400
401Example: include AnyEvent and AnyEvent::Impl::Perl.
402
403 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
404
405Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
406maybe other weirdly named files. To support this, the C<--use> option
407actually tries to do what you mean, depending on the string you specify:
408
409=over 4
410
411=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
412F<Coro::Mysql>.
413
414If the string contains no quotes, no F</> and no F<.>, then C<--use>
415assumes that it is a normal module name. It will create a new package and
416evaluate a C<use module> in it, i.e. it will load the package and do a
417default import.
418
419The import step is done because many modules trigger more dependencies
420when something is imported than without.
421
422=item anything that contains F</> or F<.> characters,
423e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
424
425The string will be quoted and passed to require, as if you used C<require
426$module>. Nothing will be imported.
427
428=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
429
430If you enclose the name into single or double quotes, then the quotes will
431be removed and the resulting string will be passed to require. This syntax
432is form compatibility with older versions of staticperl and should not be
433used anymore.
434
435=back
436
437Example: C<use> AnyEvent::Socket, once using C<use> (importing the
438symbols), and once via C<require>, not importing any symbols. The first
439form is preferred as many modules load some extra dependencies when asked
440to export symbols.
441
442 staticperl mkbundle -MAnyEvent::Socket # use + import
443 staticperl mkbundle -MAnyEvent/Socket.pm # require only
444
445Example: include the required files for F<perl -V> to work in all its
446glory (F<Config.pm> is included automatically by the dependency tracker).
447
448 # shell command
449 staticperl mkbundle -MConfig_heavy.pl
450
451 # bundle specification file
452 use Config_heavy.pl
453
454The C<-M>module syntax is included as a convenience that might be easier
455to remember than C<--use> - it's the same switch as perl itself uses
456to load modules. Or maybe it confuses people. Time will tell. Or maybe
457not. Sigh.
458
459=item C<--eval> "perl code" | C<-e> "perl code"
460
461Sometimes it is easier (or necessary) to specify dependencies using perl
462code, or maybe one of the modules you use need a special use statement. In
463that case, you can use C<--eval> to execute some perl snippet or set some
464variables or whatever you need. All files C<require>'d or C<use>'d while
465executing the snippet are included in the final bundle.
466
467Keep in mind that F<mkbundle> will not import any symbols from the modules
468named by the C<--use> option, so do not expect the symbols from modules
469you C<--use>'d earlier on the command line to be available.
470
471Example: force L<AnyEvent> to detect a backend and therefore include it
472in the final bundle.
473
474 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
475
476 # or like this
477 staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
478
479Example: use a separate "bootstrap" script that C<use>'s lots of modules
480and also include this in the final bundle, to be executed automatically
481when the interpreter is initialised.
482
483 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
484
485=item C<--boot> F<filename>
486
487Include the given file in the bundle and arrange for it to be
488executed (using C<require>) before the main program when the new perl
489is initialised. This can be used to modify C<@INC> or do similar
490modifications before the perl interpreter executes scripts given on the
491command line (or via C<-e>). This works even in an embedded interpreter -
492the file will be executed during interpreter initialisation in that case.
493
494=item C<--incglob> pattern
495
496This goes through all standard library directories and tries to match any
497F<.pm> and F<.pl> files against the extended glob pattern (see below). If
498a file matches, it is added. The pattern is matched against the full path
499of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
500
501This is very useful to include "everything":
502
503 --incglob '*'
504
505It is also useful for including perl libraries, or trees of those, such as
506the unicode database files needed by some perl built-ins, the regex engine
507and other modules.
508
509 --incglob '/unicore/**.pl'
510
511=item C<--add> F<file> | C<--add> "F<file> alias"
512
513Adds the given (perl) file into the bundle (and optionally call it
514"alias"). The F<file> is either an absolute path or a path relative to the
515current directory. If an alias is specified, then this is the name it will
516use for C<@INC> searches, otherwise the path F<file> will be used as the
517internal name.
518
519This switch is used to include extra files into the bundle.
520
521Example: embed the file F<httpd> in the current directory as F<httpd.pm>
522when creating the bundle.
523
524 staticperl mkperl --add "httpd httpd.pm"
525
526 # can be accessed via "use httpd"
527
528Example: add a file F<initcode> from the current directory.
529
530 staticperl mkperl --add 'initcode &initcode'
531
532 # can be accessed via "do '&initcode'"
533
534Example: add local files as extra modules in the bundle.
535
536 # specification file
537 add file1 myfiles/file1.pm
538 add file2 myfiles/file2.pm
539 add file3 myfiles/file3.pl
540
541 # then later, in perl, use
542 use myfiles::file1;
543 require myfiles::file2;
544 my $res = do "myfiles/file3.pl";
545
546=item C<--binadd> F<file> | C<--add> "F<file> alias"
547
548Just like C<--add>, except that it treats the file as binary and adds it
549without any postprocessing (perl files might get stripped to reduce their
550size).
551
552If you specify an alias you should probably add a C<&> prefix to avoid
553clashing with embedded perl files (whose paths never start with C<&>),
554and/or use a special directory prefix, such as C<&res/name>.
555
556You can later get a copy of these files by calling C<staticperl::find
557"alias">.
558
559An alternative way to embed binary files is to convert them to perl and
560use C<do> to get the contents - this method is a bit cumbersome, but works
561both inside and outside of a staticperl bundle:
562
563 # a "binary" file, call it "bindata.pl"
564 <<'SOME_MARKER'
565 binary data NOT containing SOME_MARKER
566 SOME_MARKER
567
568 # load the binary
569 chomp (my $data = do "bindata.pl");
570
571=back
572
573=item Step 2: filter all files using C<--include> and C<--exclude> options.
574
575After all candidate files and modules are added, they are I<filtered>
576by a combination of C<--include> and C<--exclude> patterns (there is an
577implicit C<--include *> at the end, so if no filters are specified, all
578files are included).
579
580All that this step does is potentially reduce the number of files that are
581to be included - no new files are added during this step.
582
583=over 4
584
585=item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern
586
587These specify an include or exclude pattern to be applied to the candidate
588file list. An include makes sure that the given files will be part of the
589resulting file set, an exclude will exclude remaining files. The patterns
590are "extended glob patterns" (see below).
591
592The patterns are applied "in order" - files included via earlier
593C<--include> specifications cannot be removed by any following
594C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
595cannot be added by any following C<--include>.
596
597For example, to include everything except C<Devel> modules, but still
598include F<Devel::PPPort>, you could use this:
599
600 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
601
602=back
603
604=item Step 3: add any extra or "hidden" dependencies.
605
606F<staticperl> currently knows about three extra types of depdendencies
607that are added automatically. Only one (F<.packlist> files) is currently
608optional and can be influenced, the others are always included:
609
610=over 4
611
612=item C<--usepacklists>
613
614Read F<.packlist> files for each distribution that happens to match a
615module name you specified. Sounds weird, and it is, so expect semantics to
616change somehow in the future.
617
618The idea is that most CPAN distributions have a F<.pm> file that matches
619the name of the distribution (which is rather reasonable after all).
620
621If this switch is enabled, then if any of the F<.pm> files that have been
622selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
623and F<.ix> files installed by this distribution are also included.
624
625For example, using this switch, when the L<URI> module is specified, then
626all L<URI> submodules that have been installed via the CPAN distribution
627are included as well, so you don't have to manually specify them.
628
629=item L<AutoLoader> splitfiles
630
631Some modules use L<AutoLoader> - less commonly (hopefully) used functions
632are split into separate F<.al> files, and an index (F<.ix>) file contains
633the prototypes.
634
635Both F<.ix> and F<.al> files will be detected automatically and added to
636the bundle.
637
638=item link libraries (F<.a> files)
639
640Modules using XS (or any other non-perl language extension compiled at
641installation time) will have a static archive (typically F<.a>). These
642will automatically be added to the linker options in F<bundle.ldopts>.
643
644Should F<staticperl> find a dynamic link library (typically F<.so>) it
645will warn about it - obviously this shouldn't happen unless you use
646F<staticperl> on the wrong perl, or one (probably wrongly) configured to
647use dynamic loading.
648
649=item extra libraries (F<extralibs.ld>)
650
651Some modules need linking against external libraries - these are found in
652F<extralibs.ld> and added to F<bundle.ldopts>.
653
654=back
655
656=item Step 4: write bundle files and optionally link a program
657
658At this point, the select files will be read, processed (stripped) and
659finally the bundle files get written to disk, and F<staticperl mkbundle>
660is normally finished. Optionally, it can go a step further and either link
661a new F<perl> binary with all selected modules and files inside, or build
662a standalone application.
663
664Both the contents of the bundle files and any extra linking is controlled
665by these options:
666
667=over 4
668
357=item --strip none|pod|ppi 669=item C<--strip> C<none>|C<pod>|C<ppi>
358 670
359Specify the stripping method applied to reduce the file of the perl 671Specify the stripping method applied to reduce the file of the perl
360sources included. 672sources included.
361 673
362The default is C<pod>, which uses the L<Pod::Strip> module to remove all 674The default is C<pod>, which uses the L<Pod::Strip> module to remove all
373Last not least, if you need accurate line numbers in error messages, 685Last not least, if you need accurate line numbers in error messages,
374or in the unlikely case where C<pod> is too slow, or some module gets 686or in the unlikely case where C<pod> is too slow, or some module gets
375mistreated, you can specify C<none> to not mangle included perl sources in 687mistreated, you can specify C<none> to not mangle included perl sources in
376any way. 688any way.
377 689
378=item --perl 690=item C<--perl>
379 691
380After writing out the bundle files, try to link a new perl interpreter. It 692After 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 693will be called F<perl> and will be left in the current working
382directory. The bundle files will be removed. 694directory. The bundle files will be removed.
383 695
384This switch is automatically used when F<staticperl> is invoked with the 696This switch is automatically used when F<staticperl> is invoked with the
385C<mkperl> command (instead of C<mkbundle>): 697C<mkperl> command instead of C<mkbundle>.
386 698
387 # build a new ./perl with only common::sense in it - very small :) 699Example: build a new F<./perl> binary with only L<common::sense> inside -
700it will be even smaller than the standard perl interpreter as none of the
701modules of the base distribution (such as L<Fcntl>) will be included.
702
388 staticperl mkperl -Mcommon::sense 703 staticperl mkperl -Mcommon::sense
389 704
390=item --app name 705=item C<--app> F<name>
391 706
392After writing out the bundle files, try to link a new standalone 707After 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 708program. It will be called C<name>, and the bundle files get removed after
394linking it. 709linking it.
710
711This switch is automatically used when F<staticperl> is invoked with the
712C<mkapp> command instead of C<mkbundle>.
395 713
396The difference to the (mutually exclusive) C<--perl> option is that the 714The 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 - 715binary 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 716instead it will simply initialise the perl interpreter, clean it up and
399exit. 717exit.
400 718
401This switch is automatically used when F<staticperl> is invoked with the 719This means that, by default, it will do nothing but burn a 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 720- for it to do something useful you I<must> add some boot code, e.g. with
405the C<--boot> option. 721the C<--boot> option.
406 722
407Example: create a standalone perl binary that will execute F<appfile> when 723Example: create a standalone perl binary called F<./myexe> that will
408it is started. 724execute F<appfile> when it is started.
409 725
410 staticperl mkbundle --app myexe --boot appfile 726 staticperl mkbundle --app myexe --boot appfile
411 727
412=item --use module | -Mmodule 728=item C<--ignore-env>
413 729
414Include the named module and all direct dependencies. This is done by 730Generates extra code to unset some environment variables before
415C<require>'ing the module in a subprocess and tracing which other modules 731initialising/running perl. Perl supports a lot of environment variables
416and files it actually loads. If the module uses L<AutoLoader>, then all 732that might alter execution in ways that might be undesirablre for
417splitfiles will be included as well. 733standalone applications, and this option removes those known to cause
734trouble.
418 735
419Example: include AnyEvent and AnyEvent::Impl::Perl. 736Specifically, these are removed:
420 737
421 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl 738C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
739output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
740C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
741C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
422 742
423Sometimes you want to load old-style "perl libraries" (F<.pl> files), or 743The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
424maybe other weirdly named files. To do that, you need to quote the name in 744startup code used by F<staticperl> overrides C<@INC> in all cases.
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 745
429Example: include the required files for F<perl -V> to work in all its 746This option will not make your program more secure (unless you are
430glory (F<Config.pm> is included automatically by this). 747running with elevated privileges), but it will reduce the surprise effect
748when a user has these environment variables set and doesn't expect your
749standalone program to act like a perl interpreter.
431 750
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 751=item C<--static>
551 752
552When C<--perl> is also given, link statically instead of dynamically. The 753Add C<-static> to F<bundle.ldopts>, which means a fully static (if
754supported by the OS) executable will be created. This is not immensely
755useful when just creating the bundle files, but is most useful when
756linking a binary with the C<--perl> or C<--app> options.
757
553default is to link the new perl interpreter fully dynamic (that means all 758The default is to link the new binary dynamically (that means all perl
554perl modules are linked statically, but all external libraries are still 759modules are linked statically, but all external libraries are still
555referenced dynamically). 760referenced dynamically).
556 761
557Keep in mind that Solaris doesn't support static linking at all, and 762Keep 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 763systems based on GNU libc don't really support it in a very usable
559either. Try uClibc if you want to create fully statically linked 764fashion either. Try uClibc if you want to create fully statically linked
560executables, or try the C<--staticlibs> option to link only some libraries 765executables, or try the C<--staticlib> option to link only some libraries
561statically. 766statically.
562 767
563=item --staticlib libname 768=item C<--staticlib> libname
564 769
565When not linking fully statically, this option allows you to link specific 770When not linking fully statically, this option allows you to link specific
566libraries statically. What it does is simply replace all occurances of 771libraries statically. What it does is simply replace all occurrences of
567C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> 772C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
568option. 773option.
569 774
570This will have no effect unless the library is actually linked against, 775This will have no effect unless the library is actually linked against,
571specifically, C<--staticlib> will not link against the named library 776specifically, C<--staticlib> will not link against the named library
572unless it would be linked against anyway. 777unless it would be linked against anyway.
573 778
574Example: link libcrypt statically into the binary. 779Example: link libcrypt statically into the final binary.
575 780
576 staticperl mkperl -MIO::AIO --staticlib crypt 781 staticperl mkperl -MIO::AIO --staticlib crypt
577 782
578 # ldopts might nwo contain: 783 # ldopts might now contain:
579 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread 784 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
580 785
581=item any other argument 786=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 787
586=back 788=back
587 789
588=head3 EXTENDED GLOB PATTERNS 790=head3 EXTENDED GLOB PATTERNS
589 791
603=item Patterns not starting with F</> will be anchored at the end of the path. 805=item Patterns not starting with F</> will be anchored at the end of the path.
604 806
605That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the 807That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
606hierarchy, but not any directories of the same name. 808hierarchy, but not any directories of the same name.
607 809
608=item A F<*> matches any single component. 810=item A F<*> matches anything within a single path component.
609 811
610That is, F</unicore/*.pl> would match all F<.pl> files directly inside 812That is, F</unicore/*.pl> would match all F<.pl> files directly inside
611C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> 813C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
612will not match slashes. 814will not match slashes.
613 815
688installation, you can set any environment variable you want - some modules 890installation, you can set any environment variable you want - some modules
689(such as L<Coro> or L<EV>) use environment variables for further tweaking. 891(such as L<Coro> or L<EV>) use environment variables for further tweaking.
690 892
691=item C<PERL_VERSION> 893=item C<PERL_VERSION>
692 894
693The perl version to install - default is currently C<5.12.2>, but C<5.8.9> 895The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
694is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is 896is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
695about as big as 5.12.2). 897about as big as 5.12.3).
696 898
697=item C<PERL_PREFIX> 899=item C<PERL_PREFIX>
698 900
699The prefix where perl gets installed (default: F<$STATICPERL/perl>), 901The prefix where perl gets installed (default: F<$STATICPERL/perl>),
700i.e. where the F<bin> and F<lib> subdirectories will end up. 902i.e. where the F<bin> and F<lib> subdirectories will end up.
721F<~/.staticperlrc> to override them. 923F<~/.staticperlrc> to override them.
722 924
723Most of the variables override (or modify) the corresponding F<Configure> 925Most of the variables override (or modify) the corresponding F<Configure>
724variable, except C<PERL_CCFLAGS>, which gets appended. 926variable, except C<PERL_CCFLAGS>, which gets appended.
725 927
928You should have a look near the beginning of the F<staticperl> script -
929staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
930suitable for newer gcc versions. For other compilers or older versions you
931need to adjust these, for example, in your F<~/.staticperlrc>.
932
726=back 933=back
727 934
728=head4 Variables you probably I<do not want> to override 935=head4 Variables you probably I<do not want> to override
729 936
730=over 4 937=over 4
748=head3 OVERRIDABLE HOOKS 955=head3 OVERRIDABLE HOOKS
749 956
750In addition to environment variables, it is possible to provide some 957In addition to environment variables, it is possible to provide some
751shell functions that are called at specific times. To provide your own 958shell functions that are called at specific times. To provide your own
752commands, just define the corresponding function. 959commands, just define the corresponding function.
960
961The actual order in which hooks are invoked during a full install
962from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
963C<postbuild>, C<postinstall>.
753 964
754Example: install extra modules from CPAN and from some directories 965Example: install extra modules from CPAN and from some directories
755at F<staticperl install> time. 966at F<staticperl install> time.
756 967
757 postinstall() { 968 postinstall() {
764 975
765=over 4 976=over 4
766 977
767=item preconfigure 978=item preconfigure
768 979
769Called just before running F<./Configur> in the perl source 980Called just before running F<./Configure> in the perl source
770directory. Current working directory is the perl source directory. 981directory. Current working directory is the perl source directory.
771 982
772This can be used to set any C<PERL_xxx> variables, which might be costly 983This can be used to set any C<PERL_xxx> variables, which might be costly
773to compute. 984to compute.
774 985
986=item patchconfig
987
988Called after running F<./Configure> in the perl source directory to create
989F<./config.sh>, but before running F<./Configure -S> to actually apply the
990config. Current working directory is the perl source directory.
991
992Can be used to tailor/patch F<config.sh> or do any other modifications.
993
775=item postconfigure 994=item postconfigure
776 995
777Called after configuring, but before building perl. Current working 996Called after configuring, but before building perl. Current working
778directory is the perl source directory. 997directory is the perl source directory.
779
780Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
781or do any other modifications.
782 998
783=item postbuild 999=item postbuild
784 1000
785Called after building, but before installing perl. Current working 1001Called after building, but before installing perl. Current working
786directory is the perl source directory. 1002directory is the perl source directory.
824A header file that contains the prototypes of the few symbols "exported" 1040A header file that contains the prototypes of the few symbols "exported"
825by bundle.c, and also exposes the perl headers to the application. 1041by bundle.c, and also exposes the perl headers to the application.
826 1042
827=over 4 1043=over 4
828 1044
829=item staticperl_init () 1045=item staticperl_init (xs_init = 0)
830 1046
831Initialises the perl interpreter. You can use the normal perl functions 1047Initialises the perl interpreter. You can use the normal perl functions
832after calling this function, for example, to define extra functions or 1048after calling this function, for example, to define extra functions or
833to load a .pm file that contains some initialisation code, or the main 1049to load a .pm file that contains some initialisation code, or the main
834program function: 1050program function:
841 } 1057 }
842 1058
843 static void 1059 static void
844 run_myapp(void) 1060 run_myapp(void)
845 { 1061 {
846 staticperl_init (); 1062 staticperl_init (0);
847 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); 1063 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
848 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" 1064 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
849 } 1065 }
850 1066
1067When your bootcode already wants to access some XS functions at
1068compiletime, then you need to supply an C<xs_init> function pointer that
1069is called as soon as perl is initialised enough to define XS functions,
1070but before the preamble code is executed:
1071
1072 static void
1073 xs_init (pTHX)
1074 {
1075 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
1076 }
1077
1078 static void
1079 run_myapp(void)
1080 {
1081 staticperl_init (xs_init);
1082 }
1083
1084=item staticperl_cleanup ()
1085
1086In the unlikely case that you want to destroy the perl interpreter, here
1087is the corresponding function.
1088
851=item staticperl_xs_init (pTHX) 1089=item staticperl_xs_init (pTHX)
852 1090
853Sometimes you need direct control over C<perl_parse> and C<perl_run>, in 1091Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
854which case you do not want to use C<staticperl_init> but call them on your 1092which case you do not want to use C<staticperl_init> but call them on your
855own. 1093own.
856 1094
857Then you need this function - either pass it directly as the C<xs_init> 1095Then you need this function - either pass it directly as the C<xs_init>
858function to C<perl_parse>, or call it from your own C<xs_init> function. 1096function to C<perl_parse>, or call it as one of the first things from your
859 1097own C<xs_init> function.
860=item staticperl_cleanup ()
861
862In the unlikely case that you want to destroy the perl interpreter, here
863is the corresponding function.
864 1098
865=item PerlInterpreter *staticperl 1099=item PerlInterpreter *staticperl
866 1100
867The perl interpreter pointer used by staticperl. Not normally so useful, 1101The perl interpreter pointer used by staticperl. Not normally so useful,
868but there it is. 1102but there it is.
904 1138
905Returns the list of all paths embedded in this binary. 1139Returns the list of all paths embedded in this binary.
906 1140
907=back 1141=back
908 1142
909=head1 FULLY STATIC BINARIES - BUILDROOT 1143=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
910 1144
911To make truly static (Linux-) libraries, you might want to have a look at 1145To make truly static (Linux-) libraries, you might want to have a look at
912buildroot (L<http://buildroot.uclibc.org/>). 1146buildroot (L<http://buildroot.uclibc.org/>).
913 1147
914Buildroot is primarily meant to set up a cross-compile environment (which 1148Buildroot is primarily meant to set up a cross-compile environment (which
975 1209
976Some functionality in the utf8 module, such as swash handling (used 1210Some functionality in the utf8 module, such as swash handling (used
977for unicode character ranges in regexes) is implemented in the 1211for unicode character ranges in regexes) is implemented in the
978C<"utf8_heavy.pl"> library: 1212C<"utf8_heavy.pl"> library:
979 1213
980 -M'"utf8_heavy.pl"' 1214 -Mutf8_heavy.pl
981 1215
982Many Unicode properties in turn are defined in separate modules, 1216Many Unicode properties in turn are defined in separate modules,
983such as C<"unicore/Heavy.pl"> and more specific data tables such as 1217such as C<"unicore/Heavy.pl"> and more specific data tables such as
984C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables 1218C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
985are big (7MB uncompressed, although F<staticperl> contains special 1219are big (7MB uncompressed, although F<staticperl> contains special
986handling for those files), so including them on demand by your application 1220handling for those files), so including them on demand by your application
987only might pay off. 1221only might pay off.
988 1222
989To simply include the whole unicode database, use: 1223To simply include the whole unicode database, use:
990 1224
991 --incglob '/unicore/*.pl' 1225 --incglob '/unicore/**.pl'
992 1226
993=item AnyEvent 1227=item AnyEvent
994 1228
995AnyEvent needs a backend implementation that it will load in a delayed 1229AnyEvent needs a backend implementation that it will load in a delayed
996fashion. The L<AnyEvent::Impl::Perl> backend is the default choice 1230fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
1001 1235
1002If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn 1236If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1003functions), you also need to include C<"AnyEvent/Util/idna.pl"> and 1237functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1004C<"AnyEvent/Util/uts46data.pl">. 1238C<"AnyEvent/Util/uts46data.pl">.
1005 1239
1006Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include 1240Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1007everything. 1241everything.
1242
1243=item Cairo
1244
1245See Glib, same problem, same solution.
1008 1246
1009=item Carp 1247=item Carp
1010 1248
1011Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of 1249Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1012perl 5.12.2 (maybe earlier), this dependency no longer exists. 1250perl 5.12.2 (maybe earlier), this dependency no longer exists.
1015 1253
1016The F<perl -V> switch (as well as many modules) needs L<Config>, which in 1254The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1017turn might need L<"Config_heavy.pl">. Including the latter gives you 1255turn might need L<"Config_heavy.pl">. Including the latter gives you
1018both. 1256both.
1019 1257
1258=item Glib
1259
1260Glib literally requires Glib to be installed already to build - it tries
1261to fake this by running Glib out of the build directory before being
1262built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
1263C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
1264
1265=item Gtk2
1266
1267See Pango, same problems, same solution.
1268
1269=item Pango
1270
1271In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
1272L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
1273tries to patch L<ExtUtils::MM_Unix> to route around Pango.
1274
1020=item Term::ReadLine::Perl 1275=item Term::ReadLine::Perl
1021 1276
1022Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. 1277Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1023 1278
1024=item URI 1279=item URI
1025 1280
1026URI implements schemes as separate modules - the generic URL scheme is 1281URI implements schemes as separate modules - the generic URL scheme is
1027implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If 1282implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1028you need to use any of these schemes, you should include these manually, 1283you need to use any of these schemes, you should include these manually,
1029or use C<--usepacklist>. 1284or use C<--usepacklists>.
1030 1285
1031=back 1286=back
1032 1287
1033=head2 RECIPES 1288=head2 RECIPES
1034 1289
1035=over 4 1290=over 4
1036 1291
1037=item Linking everything in 1292=item Just link everything in
1038 1293
1039To link just about everything installed in the perl library into a new 1294To link just about everything installed in the perl library into a new
1040perl, try this: 1295perl, try this (the first time this runs it will take a long time, as a
1296lot of files need to be parsed):
1041 1297
1042 staticperl mkperl --strip ppi --incglob '*' 1298 staticperl mkperl -v --strip ppi --incglob '*'
1043 1299
1300If you don't mind the extra megabytes, this can be a very effective way of
1301creating bundles without having to worry about forgetting any modules.
1302
1303You get even more useful variants of this method by first selecting
1304everything, and then excluding stuff you are reasonable sure not to need -
1305L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach.
1306
1044=item Getting rid of netdb function 1307=item Getting rid of netdb functions
1045 1308
1046The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> 1309The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1047and so on) that few applications use. You can avoid compiling them in by 1310and so on) that few applications use. You can avoid compiling them in by
1048putting the following fragment into a C<preconfigure> hook: 1311putting the following fragment into a C<preconfigure> hook:
1049 1312
1066 do 1329 do
1067 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" 1330 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1068 done 1331 done
1069 } 1332 }
1070 1333
1071This mostly gains space when linking staticaly, as the functions will 1334This mostly gains space when linking statically, as the functions will
1072likely not be linked in. The gain for dynamically-linked binaries is 1335likely not be linked in. The gain for dynamically-linked binaries is
1073smaller. 1336smaller.
1074 1337
1075Also, this leaves C<gethostbyname> in - not only is it actually used 1338Also, this leaves C<gethostbyname> in - not only is it actually used
1076often, the L<Socket> module also exposes it, so leaving it out usually 1339often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines