… | |
… | |
278 | -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
278 | -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
279 | |
279 | |
280 | # run it |
280 | # run it |
281 | ./app |
281 | ./app |
282 | |
282 | |
|
|
283 | Here are the three phase 2 commands: |
|
|
284 | |
|
|
285 | =over 4 |
|
|
286 | |
|
|
287 | =item F<staticperl mkbundle> args... |
|
|
288 | |
|
|
289 | The "default" bundle command - it interprets the given bundle options and |
|
|
290 | writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts> |
|
|
291 | files, useful for embedding. |
|
|
292 | |
|
|
293 | =item F<staticperl mkperl> args... |
|
|
294 | |
|
|
295 | Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same |
|
|
296 | as invoking F<staticperl mkbundle --perl> args...), but then compiles and |
|
|
297 | links a new perl interpreter that embeds the created bundle, then deletes |
|
|
298 | all intermediate files. |
|
|
299 | |
|
|
300 | =item F<staticperl mkapp> filename args... |
|
|
301 | |
|
|
302 | Does the same as F<staticperl mkbundle> (in fact, it's the same as |
|
|
303 | invoking F<staticperl mkbundle --app> filename args...), but then compiles |
|
|
304 | and links a new standalone application that simply initialises the perl |
|
|
305 | interpreter. |
|
|
306 | |
|
|
307 | The difference to F<staticperl mkperl> is that the standalone application |
|
|
308 | does not act like a perl interpreter would - in fact, by default it would |
|
|
309 | just do nothing and exit immediately, so you should specify some code to |
|
|
310 | be executed via the F<--boot> option. |
|
|
311 | |
|
|
312 | =back |
|
|
313 | |
283 | =head3 OPTION PROCESSING |
314 | =head3 OPTION PROCESSING |
284 | |
315 | |
285 | All options can be given as arguments on the command line (typically |
316 | All options can be given as arguments on the command line (typically |
286 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
317 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
287 | specifying a lot of modules can make the command line very cumbersome, |
318 | specifying a lot of options can make the command line very long and |
288 | you can put all long options into a "bundle specification file" (with or |
319 | unwieldy, you can put all long options into a "bundle specification file" |
289 | without C<--> prefix) and specify this bundle file instead. |
320 | (one option per line, with or without C<--> prefix) and specify this |
|
|
321 | bundle file instead. |
290 | |
322 | |
291 | For example, the command given earlier could also look like this: |
323 | For example, the command given earlier to link a new F<perl> could also |
|
|
324 | look like this: |
292 | |
325 | |
293 | staticperl mkperl httpd.bundle |
326 | staticperl mkperl httpd.bundle |
294 | |
327 | |
295 | And all options could be in F<httpd.bundle>: |
328 | With all options stored in the F<httpd.bundle> file (one option per line, |
296 | |
329 | everything after the option is an argument): |
|
|
330 | |
297 | use "Config_heavy.pl" |
331 | use "Config_heavy.pl" |
298 | use AnyEvent::Impl::Perl |
332 | use AnyEvent::Impl::Perl |
299 | use AnyEvent::HTTPD |
333 | use AnyEvent::HTTPD |
300 | use URI::http |
334 | use URI::http |
301 | add eg/httpd httpd.pm |
335 | add eg/httpd httpd.pm |
302 | |
336 | |
303 | All options that specify modules or files to be added are processed in the |
337 | All options that specify modules or files to be added are processed in the |
304 | order given on the command line (that affects the C<--use> and C<--eval> |
338 | order given on the command line. |
305 | options at the moment). |
|
|
306 | |
339 | |
307 | =head3 PACKAGE SELECTION WORKFLOW |
340 | =head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS |
308 | |
341 | |
309 | F<staticperl mkbundle> has a number of options to control package |
342 | F<staticperl mkbundle> works by first assembling a list of candidate |
310 | selection. This section describes how they interact with each other. Also, |
343 | files and modules to include, then filtering them by include/exclude |
311 | since I am still a newbie w.r.t. these issues, maybe future versions of |
344 | patterns. The remaining modules (together with their direct dependencies, |
312 | F<staticperl> will change this, so watch out :) |
345 | such as link libraries and L<AutoLoader> files) are then converted into |
|
|
346 | bundle files suitable for embedding. F<staticperl mkbundle> can then |
|
|
347 | optionally build a new perl interpreter or a standalone application. |
313 | |
348 | |
314 | The idiom "in order" means "in order that they are specified on the |
|
|
315 | commandline". If you use a bundle specification file, then the options |
|
|
316 | will be processed as if they were given in place of the bundle file name. |
|
|
317 | |
|
|
318 | =over 4 |
349 | =over 4 |
319 | |
350 | |
320 | =item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and |
351 | =item Step 0: Generic argument processing. |
321 | C<--incglob> options, in order. |
|
|
322 | |
352 | |
323 | In addition, C<--use> and C<--eval> dependencies will be added when the |
353 | The following options influence F<staticperl mkbundle> itself. |
324 | options are processed. |
|
|
325 | |
354 | |
326 | =item 2. apply all C<--include> and C<--exclude> options, in order. |
|
|
327 | |
|
|
328 | All this step does is potentially reduce the number of files already |
|
|
329 | selected 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 |
|
|
333 | extra libraries they need for linking (F<extralibs.ld>) and optionally |
|
|
334 | evaluate any F<.packlist> files. |
|
|
335 | |
|
|
336 | This step is required to link against XS extensions and also adds files |
|
|
337 | required for L<AutoLoader> to do it's job. |
|
|
338 | |
|
|
339 | =back |
|
|
340 | |
|
|
341 | After 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> |
|
|
343 | or application binary will be linked. |
|
|
344 | |
|
|
345 | =head3 MKBUNDLE OPTIONS |
|
|
346 | |
|
|
347 | =over 4 |
355 | =over 4 |
348 | |
356 | |
349 | =item --verbose | -v |
357 | =item C<--verbose> | C<-v> |
350 | |
358 | |
351 | Increases the verbosity level by one (the default is C<1>). |
359 | Increases the verbosity level by one (the default is C<1>). |
352 | |
360 | |
353 | =item --quiet | -q |
361 | =item C<--quiet> | C<-q> |
354 | |
362 | |
355 | Decreases the verbosity level by one. |
363 | Decreases the verbosity level by one. |
356 | |
364 | |
|
|
365 | =item any other argument |
|
|
366 | |
|
|
367 | Any other argument is interpreted as a bundle specification file, which |
|
|
368 | supports all options (without extra quoting), one option per line, in the |
|
|
369 | format C<option> or C<option argument>. They will effectively be expanded |
|
|
370 | and processed as if they were directly written on the command line, in |
|
|
371 | place of the file name. |
|
|
372 | |
|
|
373 | =back |
|
|
374 | |
|
|
375 | =item Step 1: gather candidate files and modules |
|
|
376 | |
|
|
377 | In this step, modules, perl libraries (F<.pl> files) and other files are |
|
|
378 | selected for inclusion in the bundle. The relevant options are executed |
|
|
379 | in order (this makes a difference mostly for C<--eval>, which can rely on |
|
|
380 | earlier C<--use> options to have been executed). |
|
|
381 | |
|
|
382 | =over 4 |
|
|
383 | |
|
|
384 | =item C<--use> F<module> | C<-M>F<module> |
|
|
385 | |
|
|
386 | Include the named module and trace direct dependencies. This is done by |
|
|
387 | C<use>'ing the module from a fresh package in a subprocess and tracing |
|
|
388 | which other modules and files it actually loads. |
|
|
389 | |
|
|
390 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
|
|
391 | |
|
|
392 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
|
|
393 | |
|
|
394 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), |
|
|
395 | or maybe other weirdly named files. To do that, you need to quote |
|
|
396 | the name in single or double quotes (this is because F<staticperl> |
|
|
397 | I<literally> just adds the string after the C<require> - which acts |
|
|
398 | different when confronted with quoted vs. unquoted strings). When given on |
|
|
399 | the command line, you probably need to quote once more to avoid your shell |
|
|
400 | interpreting it. Common cases that need this are F<Config_heavy.pl> and |
|
|
401 | F<utf8_heavy.pl>. |
|
|
402 | |
|
|
403 | Example: include the required files for F<perl -V> to work in all its |
|
|
404 | glory (F<Config.pm> is included automatically by this). |
|
|
405 | |
|
|
406 | # bourne shell |
|
|
407 | staticperl mkbundle --use '"Config_heavy.pl"' |
|
|
408 | |
|
|
409 | # bundle specification file |
|
|
410 | use "Config_heavy.pl" |
|
|
411 | |
|
|
412 | The C<-M>module syntax is included as a convenience that might be easier |
|
|
413 | to remember than C<--use> - it's the same switch as perl itself uses |
|
|
414 | to load modules. Or maybe it confuses people. Time will tell. Or maybe |
|
|
415 | not. Sigh. |
|
|
416 | |
|
|
417 | =item C<--eval> "perl code" | C<-e> "perl code" |
|
|
418 | |
|
|
419 | Sometimes it is easier (or necessary) to specify dependencies using perl |
|
|
420 | code, or maybe one of the modules you use need a special use statement. In |
|
|
421 | that case, you can use C<--eval> to execute some perl snippet or set some |
|
|
422 | variables or whatever you need. All files C<require>'d or C<use>'d while |
|
|
423 | executing the snippet are included in the final bundle. |
|
|
424 | |
|
|
425 | Keep in mind that F<mkbundle> will not import any symbols from the modules |
|
|
426 | named by the C<--use> option, so do not expect the symbols from modules |
|
|
427 | you C<--use>'d earlier on the command line to be available. |
|
|
428 | |
|
|
429 | Example: force L<AnyEvent> to detect a backend and therefore include it |
|
|
430 | in the final bundle. |
|
|
431 | |
|
|
432 | staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
|
|
433 | |
|
|
434 | # or like this |
|
|
435 | staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect' |
|
|
436 | |
|
|
437 | Example: use a separate "bootstrap" script that C<use>'s lots of modules |
|
|
438 | and also include this in the final bundle, to be executed automatically |
|
|
439 | when the interpreter is initialised. |
|
|
440 | |
|
|
441 | staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap |
|
|
442 | |
|
|
443 | =item C<--boot> F<filename> |
|
|
444 | |
|
|
445 | Include the given file in the bundle and arrange for it to be |
|
|
446 | executed (using C<require>) before the main program when the new perl |
|
|
447 | is initialised. This can be used to modify C<@INC> or do similar |
|
|
448 | modifications before the perl interpreter executes scripts given on the |
|
|
449 | command line (or via C<-e>). This works even in an embedded interpreter - |
|
|
450 | the file will be executed during interpreter initialisation in that case. |
|
|
451 | |
|
|
452 | =item C<--incglob> pattern |
|
|
453 | |
|
|
454 | This goes through all standard library directories and tries to match any |
|
|
455 | F<.pm> and F<.pl> files against the extended glob pattern (see below). If |
|
|
456 | a file matches, it is added. The pattern is matched against the full path |
|
|
457 | of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>. |
|
|
458 | |
|
|
459 | This is very useful to include "everything": |
|
|
460 | |
|
|
461 | --incglob '*' |
|
|
462 | |
|
|
463 | It is also useful for including perl libraries, or trees of those, such as |
|
|
464 | the unicode database files needed by some perl built-ins, the regex engine |
|
|
465 | and other modules. |
|
|
466 | |
|
|
467 | --incglob '/unicore/**.pl' |
|
|
468 | |
|
|
469 | =item C<--add> F<file> | C<--add> "F<file> alias" |
|
|
470 | |
|
|
471 | Adds the given (perl) file into the bundle (and optionally call it |
|
|
472 | "alias"). The F<file> is either an absolute path or a path relative to the |
|
|
473 | current directory. If an alias is specified, then this is the name it will |
|
|
474 | use for C<@INC> searches, otherwise the path F<file> will be used as the |
|
|
475 | internal name. |
|
|
476 | |
|
|
477 | This switch is used to include extra files into the bundle. |
|
|
478 | |
|
|
479 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
|
|
480 | when creating the bundle. |
|
|
481 | |
|
|
482 | staticperl mkperl --add "httpd httpd.pm" |
|
|
483 | |
|
|
484 | # can be accessed via "use httpd" |
|
|
485 | |
|
|
486 | Example: add a file F<initcode> from the current directory. |
|
|
487 | |
|
|
488 | staticperl mkperl --add 'initcode &initcode' |
|
|
489 | |
|
|
490 | # can be accessed via "do '&initcode'" |
|
|
491 | |
|
|
492 | Example: add local files as extra modules in the bundle. |
|
|
493 | |
|
|
494 | # specification file |
|
|
495 | add file1 myfiles/file1.pm |
|
|
496 | add file2 myfiles/file2.pm |
|
|
497 | add file3 myfiles/file3.pl |
|
|
498 | |
|
|
499 | # then later, in perl, use |
|
|
500 | use myfiles::file1; |
|
|
501 | require myfiles::file2; |
|
|
502 | my $res = do "myfiles/file3.pl"; |
|
|
503 | |
|
|
504 | =item C<--binadd> F<file> | C<--add> "F<file> alias" |
|
|
505 | |
|
|
506 | Just like C<--add>, except that it treats the file as binary and adds it |
|
|
507 | without any postprocessing (perl files might get stripped to reduce their |
|
|
508 | size). |
|
|
509 | |
|
|
510 | If you specify an alias you should probably add a C<&> prefix to avoid |
|
|
511 | clashing with embedded perl files (whose paths never start with C<&>), |
|
|
512 | and/or use a special directory prefix, such as C<&res/name>. |
|
|
513 | |
|
|
514 | You can later get a copy of these files by calling C<staticperl::find |
|
|
515 | "alias">. |
|
|
516 | |
|
|
517 | An alternative way to embed binary files is to convert them to perl and |
|
|
518 | use C<do> to get the contents - this method is a bit cumbersome, but works |
|
|
519 | both inside and outside of a staticperl bundle: |
|
|
520 | |
|
|
521 | # a "binary" file, call it "bindata.pl" |
|
|
522 | <<'SOME_MARKER' |
|
|
523 | binary data NOT containing SOME_MARKER |
|
|
524 | SOME_MARKER |
|
|
525 | |
|
|
526 | # load the binary |
|
|
527 | chomp (my $data = do "bindata.pl"); |
|
|
528 | |
|
|
529 | =back |
|
|
530 | |
|
|
531 | =item Step 2: filter all files using C<--include> and C<--exclude> options. |
|
|
532 | |
|
|
533 | After all candidate files and modules are added, they are I<filtered> |
|
|
534 | by a combination of C<--include> and C<--exclude> patterns (there is an |
|
|
535 | implicit C<--include *> at the end, so if no filters are specified, all |
|
|
536 | files are included). |
|
|
537 | |
|
|
538 | All that this step does is potentially reduce the number of files that are |
|
|
539 | to be included - no new files are added during this step. |
|
|
540 | |
|
|
541 | =over 4 |
|
|
542 | |
|
|
543 | =item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern |
|
|
544 | |
|
|
545 | These specify an include or exclude pattern to be applied to the candidate |
|
|
546 | file list. An include makes sure that the given files will be part of the |
|
|
547 | resulting file set, an exclude will exclude remaining files. The patterns |
|
|
548 | are "extended glob patterns" (see below). |
|
|
549 | |
|
|
550 | The patterns are applied "in order" - files included via earlier |
|
|
551 | C<--include> specifications cannot be removed by any following |
|
|
552 | C<--exclude>, and likewise, and file excluded by an earlier C<--exclude> |
|
|
553 | cannot be added by any following C<--include>. |
|
|
554 | |
|
|
555 | For example, to include everything except C<Devel> modules, but still |
|
|
556 | include F<Devel::PPPort>, you could use this: |
|
|
557 | |
|
|
558 | --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
|
|
559 | |
|
|
560 | =back |
|
|
561 | |
|
|
562 | =item Step 3: add any extra or "hidden" dependencies. |
|
|
563 | |
|
|
564 | F<staticperl> currently knows about three extra types of depdendencies |
|
|
565 | that are added automatically. Only one (F<.packlist> files) is currently |
|
|
566 | optional and can be influenced, the others are always included: |
|
|
567 | |
|
|
568 | =over 4 |
|
|
569 | |
|
|
570 | =item C<--usepacklists> |
|
|
571 | |
|
|
572 | Read F<.packlist> files for each distribution that happens to match a |
|
|
573 | module name you specified. Sounds weird, and it is, so expect semantics to |
|
|
574 | change somehow in the future. |
|
|
575 | |
|
|
576 | The idea is that most CPAN distributions have a F<.pm> file that matches |
|
|
577 | the name of the distribution (which is rather reasonable after all). |
|
|
578 | |
|
|
579 | If this switch is enabled, then if any of the F<.pm> files that have been |
|
|
580 | selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
|
|
581 | and F<.ix> files installed by this distribution are also included. |
|
|
582 | |
|
|
583 | For example, using this switch, when the L<URI> module is specified, then |
|
|
584 | all L<URI> submodules that have been installed via the CPAN distribution |
|
|
585 | are included as well, so you don't have to manually specify them. |
|
|
586 | |
|
|
587 | =item L<AutoLoader> splitfiles |
|
|
588 | |
|
|
589 | Some modules use L<AutoLoader> - less commonly (hopefully) used functions |
|
|
590 | are split into separate F<.al> files, and an index (F<.ix>) file contains |
|
|
591 | the prototypes. |
|
|
592 | |
|
|
593 | Both F<.ix> and F<.al> files will be detected automatically and added to |
|
|
594 | the bundle. |
|
|
595 | |
|
|
596 | =item link libraries (F<.a> files) |
|
|
597 | |
|
|
598 | Modules using XS (or any other non-perl language extension compiled at |
|
|
599 | installation time) will have a static archive (typically F<.a>). These |
|
|
600 | will automatically be added to the linker options in F<bundle.ldopts>. |
|
|
601 | |
|
|
602 | Should F<staticperl> find a dynamic link library (typically F<.so>) it |
|
|
603 | will warn about it - obviously this shouldn't happen unless you use |
|
|
604 | F<staticperl> on the wrong perl, or one (probably wrongly) configured to |
|
|
605 | use dynamic loading. |
|
|
606 | |
|
|
607 | =item extra libraries (F<extralibs.ld>) |
|
|
608 | |
|
|
609 | Some modules need linking against external libraries - these are found in |
|
|
610 | F<extralibs.ld> and added to F<bundle.ldopts>. |
|
|
611 | |
|
|
612 | =back |
|
|
613 | |
|
|
614 | =item Step 4: write bundle files and optionally link a program |
|
|
615 | |
|
|
616 | At this point, the select files will be read, processed (stripped) and |
|
|
617 | finally the bundle files get written to disk, and F<staticperl mkbundle> |
|
|
618 | is normally finished. Optionally, it can go a step further and either link |
|
|
619 | a new F<perl> binary with all selected modules and files inside, or build |
|
|
620 | a standalone application. |
|
|
621 | |
|
|
622 | Both the contents of the bundle files and any extra linking is controlled |
|
|
623 | by these options: |
|
|
624 | |
|
|
625 | =over 4 |
|
|
626 | |
357 | =item --strip none|pod|ppi |
627 | =item C<--strip> C<none>|C<pod>|C<ppi> |
358 | |
628 | |
359 | Specify the stripping method applied to reduce the file of the perl |
629 | Specify the stripping method applied to reduce the file of the perl |
360 | sources included. |
630 | sources included. |
361 | |
631 | |
362 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
632 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
… | |
… | |
373 | Last not least, if you need accurate line numbers in error messages, |
643 | Last not least, if you need accurate line numbers in error messages, |
374 | or in the unlikely case where C<pod> is too slow, or some module gets |
644 | or in the unlikely case where C<pod> is too slow, or some module gets |
375 | mistreated, you can specify C<none> to not mangle included perl sources in |
645 | mistreated, you can specify C<none> to not mangle included perl sources in |
376 | any way. |
646 | any way. |
377 | |
647 | |
378 | =item --perl |
648 | =item C<--perl> |
379 | |
649 | |
380 | After writing out the bundle files, try to link a new perl interpreter. It |
650 | After writing out the bundle files, try to link a new perl interpreter. It |
381 | will be called F<perl> and will be left in the current working |
651 | will be called F<perl> and will be left in the current working |
382 | directory. The bundle files will be removed. |
652 | directory. The bundle files will be removed. |
383 | |
653 | |
384 | This switch is automatically used when F<staticperl> is invoked with the |
654 | This switch is automatically used when F<staticperl> is invoked with the |
385 | C<mkperl> command (instead of C<mkbundle>): |
655 | C<mkperl> command instead of C<mkbundle>. |
386 | |
656 | |
387 | # build a new ./perl with only common::sense in it - very small :) |
657 | Example: build a new F<./perl> binary with only L<common::sense> inside - |
|
|
658 | it will be even smaller than the standard perl interpreter as none of the |
|
|
659 | modules of the base distribution (such as L<Fcntl>) will be included. |
|
|
660 | |
388 | staticperl mkperl -Mcommon::sense |
661 | staticperl mkperl -Mcommon::sense |
389 | |
662 | |
390 | =item --app name |
663 | =item C<--app> F<name> |
391 | |
664 | |
392 | After writing out the bundle files, try to link a new standalone |
665 | After writing out the bundle files, try to link a new standalone |
393 | program. It will be called C<name>, and the bundle files get removed after |
666 | program. It will be called C<name>, and the bundle files get removed after |
394 | linking it. |
667 | linking it. |
|
|
668 | |
|
|
669 | This switch is automatically used when F<staticperl> is invoked with the |
|
|
670 | C<mkapp> command instead of C<mkbundle>. |
395 | |
671 | |
396 | The difference to the (mutually exclusive) C<--perl> option is that the |
672 | The difference to the (mutually exclusive) C<--perl> option is that the |
397 | binary created by this option will not try to act as a perl interpreter - |
673 | binary created by this option will not try to act as a perl interpreter - |
398 | instead it will simply initialise the perl interpreter, clean it up and |
674 | instead it will simply initialise the perl interpreter, clean it up and |
399 | exit. |
675 | exit. |
400 | |
676 | |
401 | This switch is automatically used when F<staticperl> is invoked with the |
677 | This means that, by default, it will do nothing but burn a few CPU cycles |
402 | C<mkapp> command (instead of C<mkbundle>): |
|
|
403 | |
|
|
404 | To let it do something useful you I<must> add some boot code, e.g. with |
678 | - for it to do something useful you I<must> add some boot code, e.g. with |
405 | the C<--boot> option. |
679 | the C<--boot> option. |
406 | |
680 | |
407 | Example: create a standalone perl binary that will execute F<appfile> when |
681 | Example: create a standalone perl binary called F<./myexe> that will |
408 | it is started. |
682 | execute F<appfile> when it is started. |
409 | |
683 | |
410 | staticperl mkbundle --app myexe --boot appfile |
684 | staticperl mkbundle --app myexe --boot appfile |
411 | |
685 | |
412 | =item --use module | -Mmodule |
|
|
413 | |
|
|
414 | Include the named module and all direct dependencies. This is done by |
|
|
415 | C<require>'ing the module in a subprocess and tracing which other modules |
|
|
416 | and files it actually loads. If the module uses L<AutoLoader>, then all |
|
|
417 | splitfiles will be included as well. |
|
|
418 | |
|
|
419 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
|
|
420 | |
|
|
421 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
|
|
422 | |
|
|
423 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
|
|
424 | maybe other weirdly named files. To do that, you need to quote the name in |
|
|
425 | single or double quotes. When given on the command line, you probably need |
|
|
426 | to quote once more to avoid your shell interpreting it. Common cases that |
|
|
427 | need this are F<Config_heavy.pl> and F<utf8_heavy.pl>. |
|
|
428 | |
|
|
429 | Example: include the required files for F<perl -V> to work in all its |
|
|
430 | glory (F<Config.pm> is included automatically by this). |
|
|
431 | |
|
|
432 | # bourne shell |
|
|
433 | staticperl mkbundle --use '"Config_heavy.pl"' |
|
|
434 | |
|
|
435 | # bundle specification file |
|
|
436 | use "Config_heavy.pl" |
|
|
437 | |
|
|
438 | The C<-Mmodule> syntax is included as an alias that might be easier to |
|
|
439 | remember than C<use>. Or maybe it confuses people. Time will tell. Or |
|
|
440 | maybe not. Argh. |
|
|
441 | |
|
|
442 | =item --eval "perl code" | -e "perl code" |
|
|
443 | |
|
|
444 | Sometimes it is easier (or necessary) to specify dependencies using perl |
|
|
445 | code, or maybe one of the modules you use need a special use statement. In |
|
|
446 | that case, you can use C<eval> to execute some perl snippet or set some |
|
|
447 | variables or whatever you need. All files C<require>'d or C<use>'d in the |
|
|
448 | script are included in the final bundle. |
|
|
449 | |
|
|
450 | Keep in mind that F<mkbundle> will only C<require> the modules named |
|
|
451 | by the C<--use> option, so do not expect the symbols from modules you |
|
|
452 | C<--use>'d earlier on the command line to be available. |
|
|
453 | |
|
|
454 | Example: force L<AnyEvent> to detect a backend and therefore include it |
|
|
455 | in 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 | |
|
|
462 | Example: use a separate "bootstrap" script that C<use>'s lots of modules |
|
|
463 | and 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 | |
|
|
469 | Include 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 |
|
|
471 | initialised. This can be used to modify C<@INC> or anything else before |
|
|
472 | the perl interpreter executes scripts given on the command line (or via |
|
|
473 | C<-e>). This works even in an embedded interpreter. |
|
|
474 | |
|
|
475 | =item --usepacklist |
|
|
476 | |
|
|
477 | Read F<.packlist> files for each distribution that happens to match a |
|
|
478 | module name you specified. Sounds weird, and it is, so expect semantics to |
|
|
479 | change somehow in the future. |
|
|
480 | |
|
|
481 | The idea is that most CPAN distributions have a F<.pm> file that matches |
|
|
482 | the name of the distribution (which is rather reasonable after all). |
|
|
483 | |
|
|
484 | If this switch is enabled, then if any of the F<.pm> files that have been |
|
|
485 | selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
|
|
486 | and F<.ix> files installed by this distribution are also included. |
|
|
487 | |
|
|
488 | For example, using this switch, when the L<URI> module is specified, then |
|
|
489 | all L<URI> submodules that have been installed via the CPAN distribution |
|
|
490 | are included as well, so you don't have to manually specify them. |
|
|
491 | |
|
|
492 | =item --incglob pattern |
|
|
493 | |
|
|
494 | This goes through all library directories and tries to match any F<.pm> |
|
|
495 | and F<.pl> files against the extended glob pattern (see below). If a file |
|
|
496 | matches, it is added. This switch will automatically detect L<AutoLoader> |
|
|
497 | files and the required link libraries for XS modules, but it will I<not> |
|
|
498 | scan the file for dependencies (at the moment). |
|
|
499 | |
|
|
500 | This is mainly useful to include "everything": |
|
|
501 | |
|
|
502 | --incglob '*' |
|
|
503 | |
|
|
504 | Or to include perl libraries, or trees of those, such as the unicode |
|
|
505 | database files needed by many other modules: |
|
|
506 | |
|
|
507 | --incglob '/unicore/**.pl' |
|
|
508 | |
|
|
509 | =item --add file | --add "file alias" |
|
|
510 | |
|
|
511 | Adds 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 | |
|
|
514 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
|
|
515 | |
|
|
516 | staticperl mkperl --add "httpd httpd.pm" |
|
|
517 | |
|
|
518 | It 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 | |
|
|
527 | Just like C<--add>, except that it treats the file as binary and adds it |
|
|
528 | without any processing. |
|
|
529 | |
|
|
530 | You should probably add a C</> prefix to avoid clashing with embedded |
|
|
531 | perl files (whose paths do not start with C</>), and/or use a special |
|
|
532 | directory, such as C</res/name>. |
|
|
533 | |
|
|
534 | You 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 | |
|
|
539 | These two options define an include/exclude filter that is used after all |
|
|
540 | files selected by the other options have been found. Each include/exclude |
|
|
541 | is applied to all files found so far - an include makes sure that the |
|
|
542 | given files will be part of the resulting file set, an exclude will |
|
|
543 | exclude files. The patterns are "extended glob patterns" (see below). |
|
|
544 | |
|
|
545 | For example, to include everything, except C<Devel> modules, but still |
|
|
546 | include F<Devel::PPPort>, you could use this: |
|
|
547 | |
|
|
548 | --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
|
|
549 | |
|
|
550 | =item --static |
686 | =item C<--static> |
551 | |
687 | |
552 | When C<--perl> is also given, link statically instead of dynamically. The |
688 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
|
|
689 | supported by the OS) executable will be created. This is not immensely |
|
|
690 | useful when just creating the bundle files, but is most useful when |
|
|
691 | linking a binary with the C<--perl> or C<--app> options. |
|
|
692 | |
553 | default is to link the new perl interpreter fully dynamic (that means all |
693 | The default is to link the new binary dynamically (that means all perl |
554 | perl modules are linked statically, but all external libraries are still |
694 | modules are linked statically, but all external libraries are still |
555 | referenced dynamically). |
695 | referenced dynamically). |
556 | |
696 | |
557 | Keep in mind that Solaris doesn't support static linking at all, and |
697 | Keep in mind that Solaris doesn't support static linking at all, and |
558 | systems based on GNU libc don't really support it in a usable fashion |
698 | systems based on GNU libc don't really support it in a very usable |
559 | either. Try uClibc if you want to create fully statically linked |
699 | fashion either. Try uClibc if you want to create fully statically linked |
560 | executables, or try the C<--staticlibs> option to link only some libraries |
700 | executables, or try the C<--staticlib> option to link only some libraries |
561 | statically. |
701 | statically. |
562 | |
702 | |
563 | =item --staticlib libname |
703 | =item C<--staticlib> libname |
564 | |
704 | |
565 | When not linking fully statically, this option allows you to link specific |
705 | When not linking fully statically, this option allows you to link specific |
566 | libraries statically. What it does is simply replace all occurances of |
706 | libraries statically. What it does is simply replace all occurrences of |
567 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
707 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
568 | option. |
708 | option. |
569 | |
709 | |
570 | This will have no effect unless the library is actually linked against, |
710 | This will have no effect unless the library is actually linked against, |
571 | specifically, C<--staticlib> will not link against the named library |
711 | specifically, C<--staticlib> will not link against the named library |
572 | unless it would be linked against anyway. |
712 | unless it would be linked against anyway. |
573 | |
713 | |
574 | Example: link libcrypt statically into the binary. |
714 | Example: link libcrypt statically into the final binary. |
575 | |
715 | |
576 | staticperl mkperl -MIO::AIO --staticlib crypt |
716 | staticperl mkperl -MIO::AIO --staticlib crypt |
577 | |
717 | |
578 | # ldopts might nwo contain: |
718 | # ldopts might now contain: |
579 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
719 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
580 | |
720 | |
581 | =item any other argument |
721 | =back |
582 | |
|
|
583 | Any other argument is interpreted as a bundle specification file, which |
|
|
584 | supports most long options (without extra quoting), one option per line. |
|
|
585 | |
722 | |
586 | =back |
723 | =back |
587 | |
724 | |
588 | =head3 EXTENDED GLOB PATTERNS |
725 | =head3 EXTENDED GLOB PATTERNS |
589 | |
726 | |
… | |
… | |
603 | =item Patterns not starting with F</> will be anchored at the end of the path. |
740 | =item Patterns not starting with F</> will be anchored at the end of the path. |
604 | |
741 | |
605 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
742 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
606 | hierarchy, but not any directories of the same name. |
743 | hierarchy, but not any directories of the same name. |
607 | |
744 | |
608 | =item A F<*> matches any single component. |
745 | =item A F<*> matches anything within a single path component. |
609 | |
746 | |
610 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
747 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
611 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
748 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
612 | will not match slashes. |
749 | will not match slashes. |
613 | |
750 | |
… | |
… | |
824 | A header file that contains the prototypes of the few symbols "exported" |
961 | A header file that contains the prototypes of the few symbols "exported" |
825 | by bundle.c, and also exposes the perl headers to the application. |
962 | by bundle.c, and also exposes the perl headers to the application. |
826 | |
963 | |
827 | =over 4 |
964 | =over 4 |
828 | |
965 | |
829 | =item staticperl_init () |
966 | =item staticperl_init (xs_init = 0) |
830 | |
967 | |
831 | Initialises the perl interpreter. You can use the normal perl functions |
968 | Initialises the perl interpreter. You can use the normal perl functions |
832 | after calling this function, for example, to define extra functions or |
969 | after calling this function, for example, to define extra functions or |
833 | to load a .pm file that contains some initialisation code, or the main |
970 | to load a .pm file that contains some initialisation code, or the main |
834 | program function: |
971 | program function: |
… | |
… | |
841 | } |
978 | } |
842 | |
979 | |
843 | static void |
980 | static void |
844 | run_myapp(void) |
981 | run_myapp(void) |
845 | { |
982 | { |
846 | staticperl_init (); |
983 | staticperl_init (0); |
847 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
984 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
848 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
985 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
849 | } |
986 | } |
850 | |
987 | |
|
|
988 | When your bootcode already wants to access some XS functions at |
|
|
989 | compiletime, then you need to supply an C<xs_init> function pointer that |
|
|
990 | is called as soon as perl is initialised enough to define XS functions, |
|
|
991 | but before the preamble code is executed: |
|
|
992 | |
|
|
993 | static void |
|
|
994 | xs_init (pTHX) |
|
|
995 | { |
|
|
996 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
|
|
997 | } |
|
|
998 | |
|
|
999 | static void |
|
|
1000 | run_myapp(void) |
|
|
1001 | { |
|
|
1002 | staticperl_init (xs_init); |
|
|
1003 | } |
|
|
1004 | |
|
|
1005 | =item staticperl_cleanup () |
|
|
1006 | |
|
|
1007 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
1008 | is the corresponding function. |
|
|
1009 | |
851 | =item staticperl_xs_init (pTHX) |
1010 | =item staticperl_xs_init (pTHX) |
852 | |
1011 | |
853 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
1012 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
854 | which case you do not want to use C<staticperl_init> but call them on your |
1013 | which case you do not want to use C<staticperl_init> but call them on your |
855 | own. |
1014 | own. |
856 | |
1015 | |
857 | Then you need this function - either pass it directly as the C<xs_init> |
1016 | Then you need this function - either pass it directly as the C<xs_init> |
858 | function to C<perl_parse>, or call it from your own C<xs_init> function. |
1017 | function to C<perl_parse>, or call it as one of the first things from your |
859 | |
1018 | own C<xs_init> function. |
860 | =item staticperl_cleanup () |
|
|
861 | |
|
|
862 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
863 | is the corresponding function. |
|
|
864 | |
1019 | |
865 | =item PerlInterpreter *staticperl |
1020 | =item PerlInterpreter *staticperl |
866 | |
1021 | |
867 | The perl interpreter pointer used by staticperl. Not normally so useful, |
1022 | The perl interpreter pointer used by staticperl. Not normally so useful, |
868 | but there it is. |
1023 | but there it is. |
… | |
… | |
904 | |
1059 | |
905 | Returns the list of all paths embedded in this binary. |
1060 | Returns the list of all paths embedded in this binary. |
906 | |
1061 | |
907 | =back |
1062 | =back |
908 | |
1063 | |
909 | =head1 FULLY STATIC BINARIES - BUILDROOT |
1064 | =head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT |
910 | |
1065 | |
911 | To make truly static (Linux-) libraries, you might want to have a look at |
1066 | To make truly static (Linux-) libraries, you might want to have a look at |
912 | buildroot (L<http://buildroot.uclibc.org/>). |
1067 | buildroot (L<http://buildroot.uclibc.org/>). |
913 | |
1068 | |
914 | Buildroot is primarily meant to set up a cross-compile environment (which |
1069 | Buildroot is primarily meant to set up a cross-compile environment (which |
… | |
… | |
986 | handling for those files), so including them on demand by your application |
1141 | handling for those files), so including them on demand by your application |
987 | only might pay off. |
1142 | only might pay off. |
988 | |
1143 | |
989 | To simply include the whole unicode database, use: |
1144 | To simply include the whole unicode database, use: |
990 | |
1145 | |
991 | --incglob '/unicore/*.pl' |
1146 | --incglob '/unicore/**.pl' |
992 | |
1147 | |
993 | =item AnyEvent |
1148 | =item AnyEvent |
994 | |
1149 | |
995 | AnyEvent needs a backend implementation that it will load in a delayed |
1150 | AnyEvent needs a backend implementation that it will load in a delayed |
996 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
1151 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
… | |
… | |
1001 | |
1156 | |
1002 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
1157 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
1003 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
1158 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
1004 | C<"AnyEvent/Util/uts46data.pl">. |
1159 | C<"AnyEvent/Util/uts46data.pl">. |
1005 | |
1160 | |
1006 | Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include |
1161 | Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
1007 | everything. |
1162 | everything. |
1008 | |
1163 | |
1009 | =item Carp |
1164 | =item Carp |
1010 | |
1165 | |
1011 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1166 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
… | |
… | |
1017 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1172 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1018 | both. |
1173 | both. |
1019 | |
1174 | |
1020 | =item Term::ReadLine::Perl |
1175 | =item Term::ReadLine::Perl |
1021 | |
1176 | |
1022 | Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. |
1177 | Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
1023 | |
1178 | |
1024 | =item URI |
1179 | =item URI |
1025 | |
1180 | |
1026 | URI implements schemes as separate modules - the generic URL scheme is |
1181 | URI implements schemes as separate modules - the generic URL scheme is |
1027 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
1182 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
1028 | you need to use any of these schemes, you should include these manually, |
1183 | you need to use any of these schemes, you should include these manually, |
1029 | or use C<--usepacklist>. |
1184 | or use C<--usepacklists>. |
1030 | |
1185 | |
1031 | =back |
1186 | =back |
1032 | |
1187 | |
1033 | =head2 RECIPES |
1188 | =head2 RECIPES |
1034 | |
1189 | |
1035 | =over 4 |
1190 | =over 4 |
1036 | |
1191 | |
1037 | =item Linking everything in |
1192 | =item Just link everything in |
1038 | |
1193 | |
1039 | To link just about everything installed in the perl library into a new |
1194 | To link just about everything installed in the perl library into a new |
1040 | perl, try this: |
1195 | perl, try this (the first time this runs it will take a long time, as a |
|
|
1196 | lot of files need to be parsed): |
1041 | |
1197 | |
1042 | staticperl mkperl --strip ppi --incglob '*' |
1198 | staticperl mkperl -v --strip ppi --incglob '*' |
1043 | |
1199 | |
|
|
1200 | If you don't mind the extra megabytes, this can be a very effective way of |
|
|
1201 | creating bundles without having to worry about forgetting any modules. |
|
|
1202 | |
|
|
1203 | You get even more useful variants of this method by first selecting |
|
|
1204 | everything, and then excluding stuff you are reasonable sure not to need - |
|
|
1205 | L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach. |
|
|
1206 | |
1044 | =item Getting rid of netdb function |
1207 | =item Getting rid of netdb functions |
1045 | |
1208 | |
1046 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
1209 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
1047 | and so on) that few applications use. You can avoid compiling them in by |
1210 | and so on) that few applications use. You can avoid compiling them in by |
1048 | putting the following fragment into a C<preconfigure> hook: |
1211 | putting the following fragment into a C<preconfigure> hook: |
1049 | |
1212 | |
… | |
… | |
1066 | do |
1229 | do |
1067 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
1230 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
1068 | done |
1231 | done |
1069 | } |
1232 | } |
1070 | |
1233 | |
1071 | This mostly gains space when linking staticaly, as the functions will |
1234 | This mostly gains space when linking statically, as the functions will |
1072 | likely not be linked in. The gain for dynamically-linked binaries is |
1235 | likely not be linked in. The gain for dynamically-linked binaries is |
1073 | smaller. |
1236 | smaller. |
1074 | |
1237 | |
1075 | Also, this leaves C<gethostbyname> in - not only is it actually used |
1238 | Also, this leaves C<gethostbyname> in - not only is it actually used |
1076 | often, the L<Socket> module also exposes it, so leaving it out usually |
1239 | often, the L<Socket> module also exposes it, so leaving it out usually |