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.19 by root, Fri Dec 10 15:25:24 2010 UTC vs.
Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC

20 20
21Typical Examples: 21Typical Examples:
22 22
23 staticperl install # fetch, configure, build and install perl 23 staticperl install # fetch, configure, build and install perl
24 staticperl cpan # run interactive cpan shell 24 staticperl cpan # run interactive cpan shell
25 staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V 25 staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http 26 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27 # build a perl with the above modules linked in 27 # build a perl with the above modules linked in
28 staticperl mkapp myapp --boot mainprog mymodules 28 staticperl mkapp myapp --boot mainprog mymodules
29 # build a binary "myapp" from mainprog and mymodules 29 # build a binary "myapp" from mainprog and mymodules
30 30
40 40
41With F<uClibc> and F<upx> on x86, you can create a single 500kb binary 41With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
42that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, 42that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
43Coro and so on. Or any other choice of modules. 43Coro and so on. Or any other choice of modules.
44 44
45To see how this turns out, you can try out smallperl and bigperl, two
46pre-built static and compressed perl binaries with many and even more
47modules: just follow the links at L<http://staticperl.schmorp.de/>.
48
45The created files do not need write access to the file system (like PAR 49The created files do not need write access to the file system (like PAR
46does). In fact, since this script is in many ways similar to PAR::Packer, 50does). In fact, since this script is in many ways similar to PAR::Packer,
47here are the differences: 51here are the differences:
48 52
49=over 4 53=over 4
118often as necessary. 122often as necessary.
119 123
120=head1 THE F<STATICPERL> SCRIPT 124=head1 THE F<STATICPERL> SCRIPT
121 125
122This module installs a script called F<staticperl> into your perl 126This module installs a script called F<staticperl> into your perl
123binary directory. The script is fully self-contained, and can be used 127binary directory. The script is fully self-contained, and can be
124without perl (for example, in an uClibc chroot environment). In fact, 128used without perl (for example, in an uClibc chroot environment). In
125it can be extracted from the C<App::Staticperl> distribution tarball as 129fact, it can be extracted from the C<App::Staticperl> distribution
126F<bin/staticperl>, without any installation. 130tarball as F<bin/staticperl>, without any installation. The
131newest (possibly alpha) version can also be downloaded from
132L<http://staticperl.schmorp.de/staticperl>.
127 133
128F<staticperl> interprets the first argument as a command to execute, 134F<staticperl> interprets the first argument as a command to execute,
129optionally followed by any parameters. 135optionally followed by any parameters.
130 136
131There are two command categories: the "phase 1" commands which deal with 137There are two command categories: the "phase 1" commands which deal with
133with creating binaries and bundle files. 139with creating binaries and bundle files.
134 140
135=head2 PHASE 1 COMMANDS: INSTALLING PERL 141=head2 PHASE 1 COMMANDS: INSTALLING PERL
136 142
137The most important command is F<install>, which does basically 143The most important command is F<install>, which does basically
138everything. The default is to download and install perl 5.12.2 and a few 144everything. The default is to download and install perl 5.12.3 and a few
139modules required by F<staticperl> itself, but all this can (and should) be 145modules required by F<staticperl> itself, but all this can (and should) be
140changed - see L<CONFIGURATION>, below. 146changed - see L<CONFIGURATION>, below.
141 147
142The command 148The command
143 149
144 staticperl install 150 staticperl install
145 151
146Is normally all you need: It installs the perl interpreter in 152is normally all you need: It installs the perl interpreter in
147F<~/.staticperl/perl>. It downloads, configures, builds and installs the 153F<~/.staticperl/perl>. It downloads, configures, builds and installs the
148perl interpreter if required. 154perl interpreter if required.
149 155
150Most of the following commands simply run one or more steps of this 156Most of the following F<staticperl> subcommands simply run one or more
151sequence. 157steps of this sequence.
158
159If it fails, then most commonly because the compiler options I selected
160are not supported by your compiler - either edit the F<staticperl> script
161yourself or create F<~/.staticperl> shell script where your set working
162C<PERL_CCFLAGS> etc. variables.
152 163
153To force recompilation or reinstallation, you need to run F<staticperl 164To force recompilation or reinstallation, you need to run F<staticperl
154distclean> first. 165distclean> first.
155 166
156=over 4 167=over 4
168
169=item F<staticperl version>
170
171Prints some info about the version of the F<staticperl> script you are using.
157 172
158=item F<staticperl fetch> 173=item F<staticperl fetch>
159 174
160Runs only the download and unpack phase, unless this has already happened. 175Runs only the download and unpack phase, unless this has already happened.
161 176
199 214
200=item F<staticperl clean> 215=item F<staticperl clean>
201 216
202Deletes the perl source directory (and potentially cleans up other 217Deletes the perl source directory (and potentially cleans up other
203intermediate files). This can be used to clean up files only needed for 218intermediate files). This can be used to clean up files only needed for
204building perl, without removing the installed perl interpreter, or to 219building perl, without removing the installed perl interpreter.
205force a re-build from scratch.
206 220
207At the moment, it doesn't delete downloaded tarballs. 221At the moment, it doesn't delete downloaded tarballs.
222
223The exact semantics of this command will probably change.
208 224
209=item F<staticperl distclean> 225=item F<staticperl distclean>
210 226
211This wipes your complete F<~/.staticperl> directory. Be careful with this, 227This wipes your complete F<~/.staticperl> directory. Be careful with this,
212it nukes your perl download, perl sources, perl distribution and any 228it nukes your perl download, perl sources, perl distribution and any
236 252
237 # first make sure we have perl and the required modules 253 # first make sure we have perl and the required modules
238 staticperl instcpan AnyEvent::HTTPD 254 staticperl instcpan AnyEvent::HTTPD
239 255
240 # now build the perl 256 # now build the perl
241 staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ 257 staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
242 -MAnyEvent::HTTPD -MURI::http \ 258 -MAnyEvent::HTTPD -MURI::http \
243 --add 'eg/httpd httpd.pm' 259 --add 'eg/httpd httpd.pm'
244 260
245 # finally, invoke it 261 # finally, invoke it
246 ./perl -Mhttpd 262 ./perl -Mhttpd
262 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http 278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
263 279
264 # run it 280 # run it
265 ./app 281 ./app
266 282
283Here are the three phase 2 commands:
284
285=over 4
286
287=item F<staticperl mkbundle> args...
288
289The "default" bundle command - it interprets the given bundle options and
290writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
291files, useful for embedding.
292
293=item F<staticperl mkperl> args...
294
295Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
296as invoking F<staticperl mkbundle --perl> args...), but then compiles and
297links a new perl interpreter that embeds the created bundle, then deletes
298all intermediate files.
299
300=item F<staticperl mkapp> filename args...
301
302Does the same as F<staticperl mkbundle> (in fact, it's the same as
303invoking F<staticperl mkbundle --app> filename args...), but then compiles
304and links a new standalone application that simply initialises the perl
305interpreter.
306
307The difference to F<staticperl mkperl> is that the standalone application
308does not act like a perl interpreter would - in fact, by default it would
309just do nothing and exit immediately, so you should specify some code to
310be executed via the F<--boot> option.
311
312=back
313
267=head3 OPTION PROCESSING 314=head3 OPTION PROCESSING
268 315
269All options can be given as arguments on the command line (typically 316All options can be given as arguments on the command line (typically
270using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since 317using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
271specifying a lot of modules can make the command line very cumbersome, 318specifying a lot of options can make the command line very long and
272you can put all long options into a "bundle specification file" (with or 319unwieldy, you can put all long options into a "bundle specification file"
273without C<--> prefix) and specify this bundle file instead. 320(one option per line, with or without C<--> prefix) and specify this
321bundle file instead.
274 322
275For example, the command given earlier could also look like this: 323For example, the command given earlier to link a new F<perl> could also
324look like this:
276 325
277 staticperl mkperl httpd.bundle 326 staticperl mkperl httpd.bundle
278 327
279And all options could be in F<httpd.bundle>: 328With all options stored in the F<httpd.bundle> file (one option per line,
280 329everything after the option is an argument):
330
281 use "Config_heavy.pl" 331 use "Config_heavy.pl"
282 use AnyEvent::Impl::Perl 332 use AnyEvent::Impl::Perl
283 use AnyEvent::HTTPD 333 use AnyEvent::HTTPD
284 use URI::http 334 use URI::http
285 add eg/httpd httpd.pm 335 add eg/httpd httpd.pm
286 336
287All options that specify modules or files to be added are processed in the 337All options that specify modules or files to be added are processed in the
288order given on the command line (that affects the C<--use> and C<--eval> 338order given on the command line.
289options at the moment).
290 339
291=head3 PACKAGE SELECTION WORKFLOW 340=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
292 341
293F<staticperl mkbundle> has a number of options to control package 342F<staticperl mkbundle> works by first assembling a list of candidate
294selection. This section describes how they interact with each other. Also, 343files and modules to include, then filtering them by include/exclude
295since I am still a newbie w.r.t. these issues, maybe future versions of 344patterns. The remaining modules (together with their direct dependencies,
296F<staticperl> will change this, so watch out :) 345such as link libraries and L<AutoLoader> files) are then converted into
346bundle files suitable for embedding. F<staticperl mkbundle> can then
347optionally build a new perl interpreter or a standalone application.
297 348
298The idiom "in order" means "in order that they are specified on the
299commandline". If you use a bundle specification file, then the options
300will be processed as if they were given in place of the bundle file name.
301
302=over 4 349=over 4
303 350
304=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and 351=item Step 0: Generic argument processing.
305C<--incglob> options, in order.
306 352
307In addition, C<--use> and C<--eval> dependencies will be added when the 353The following options influence F<staticperl mkbundle> itself.
308options are processed.
309 354
310=item 2. apply all C<--include> and C<--exclude> options, in order.
311
312All this step does is potentially reduce the number of files already
313selected or found in phase 1.
314
315=item 3. find all modules (== F<.pm> files), gather their static archives
316(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files) and find any
317extra libraries they need for linking (F<extralibs.ld>).
318
319This step is required to link against XS extensions and also adds files
320required for L<AutoLoader> to do it's job.
321
322=back
323
324After this, all the files selected for bundling will be read and processed
325(stripped), the bundle files will be written, and optionally a new F<perl>
326or application binary will be linked.
327
328=head3 MKBUNDLE OPTIONS
329
330=over 4 355=over 4
331 356
332=item --verbose | -v 357=item C<--verbose> | C<-v>
333 358
334Increases the verbosity level by one (the default is C<1>). 359Increases the verbosity level by one (the default is C<1>).
335 360
336=item --quiet | -q 361=item C<--quiet> | C<-q>
337 362
338Decreases the verbosity level by one. 363Decreases the verbosity level by one.
339 364
365=item any other argument
366
367Any other argument is interpreted as a bundle specification file, which
368supports all options (without extra quoting), one option per line, in the
369format C<option> or C<option argument>. They will effectively be expanded
370and processed as if they were directly written on the command line, in
371place of the file name.
372
373=back
374
375=item Step 1: gather candidate files and modules
376
377In this step, modules, perl libraries (F<.pl> files) and other files are
378selected for inclusion in the bundle. The relevant options are executed
379in order (this makes a difference mostly for C<--eval>, which can rely on
380earlier C<--use> options to have been executed).
381
382=over 4
383
384=item C<--use> F<module> | C<-M>F<module>
385
386Include the named module or perl library and trace direct
387dependencies. This is done by loading the module in a subprocess and
388tracing which other modules and files it actually loads.
389
390Example: include AnyEvent and AnyEvent::Impl::Perl.
391
392 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
393
394Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
395maybe other weirdly named files. To support this, the C<--use> option
396actually tries to do what you mean, depending on the string you specify:
397
398=over 4
399
400=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
401F<Coro::Mysql>.
402
403If the string contains no quotes, no F</> and no F<.>, then C<--use>
404assumes that it is a normal module name. It will create a new package and
405evaluate a C<use module> in it, i.e. it will load the package and do a
406default import.
407
408The import step is done because many modules trigger more dependencies
409when something is imported than without.
410
411=item anything that contains F</> or F<.> characters,
412e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
413
414The string will be quoted and passed to require, as if you used C<require
415$module>. Nothing will be imported.
416
417=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
418
419If you enclose the name into single or double quotes, then the quotes will
420be removed and the resulting string will be passed to require. This syntax
421is form compatibility with older versions of staticperl and should not be
422used anymore.
423
424=back
425
426Example: C<use> AnyEvent::Socket, once using C<use> (importing the
427symbols), and once via C<require>, not importing any symbols. The first
428form is preferred as many modules load some extra dependencies when asked
429to export symbols.
430
431 staticperl mkbundle -MAnyEvent::Socket # use + import
432 staticperl mkbundle -MAnyEvent/Socket.pm # require only
433
434Example: include the required files for F<perl -V> to work in all its
435glory (F<Config.pm> is included automatically by the dependency tracker).
436
437 # shell command
438 staticperl mkbundle -MConfig_heavy.pl
439
440 # bundle specification file
441 use Config_heavy.pl
442
443The C<-M>module syntax is included as a convenience that might be easier
444to remember than C<--use> - it's the same switch as perl itself uses
445to load modules. Or maybe it confuses people. Time will tell. Or maybe
446not. Sigh.
447
448=item C<--eval> "perl code" | C<-e> "perl code"
449
450Sometimes it is easier (or necessary) to specify dependencies using perl
451code, or maybe one of the modules you use need a special use statement. In
452that case, you can use C<--eval> to execute some perl snippet or set some
453variables or whatever you need. All files C<require>'d or C<use>'d while
454executing the snippet are included in the final bundle.
455
456Keep in mind that F<mkbundle> will not import any symbols from the modules
457named by the C<--use> option, so do not expect the symbols from modules
458you C<--use>'d earlier on the command line to be available.
459
460Example: force L<AnyEvent> to detect a backend and therefore include it
461in the final bundle.
462
463 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
464
465 # or like this
466 staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
467
468Example: use a separate "bootstrap" script that C<use>'s lots of modules
469and also include this in the final bundle, to be executed automatically
470when the interpreter is initialised.
471
472 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
473
474=item C<--boot> F<filename>
475
476Include the given file in the bundle and arrange for it to be
477executed (using C<require>) before the main program when the new perl
478is initialised. This can be used to modify C<@INC> or do similar
479modifications before the perl interpreter executes scripts given on the
480command line (or via C<-e>). This works even in an embedded interpreter -
481the file will be executed during interpreter initialisation in that case.
482
483=item C<--incglob> pattern
484
485This goes through all standard library directories and tries to match any
486F<.pm> and F<.pl> files against the extended glob pattern (see below). If
487a file matches, it is added. The pattern is matched against the full path
488of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
489
490This is very useful to include "everything":
491
492 --incglob '*'
493
494It is also useful for including perl libraries, or trees of those, such as
495the unicode database files needed by some perl built-ins, the regex engine
496and other modules.
497
498 --incglob '/unicore/**.pl'
499
500=item C<--add> F<file> | C<--add> "F<file> alias"
501
502Adds the given (perl) file into the bundle (and optionally call it
503"alias"). The F<file> is either an absolute path or a path relative to the
504current directory. If an alias is specified, then this is the name it will
505use for C<@INC> searches, otherwise the path F<file> will be used as the
506internal name.
507
508This switch is used to include extra files into the bundle.
509
510Example: embed the file F<httpd> in the current directory as F<httpd.pm>
511when creating the bundle.
512
513 staticperl mkperl --add "httpd httpd.pm"
514
515 # can be accessed via "use httpd"
516
517Example: add a file F<initcode> from the current directory.
518
519 staticperl mkperl --add 'initcode &initcode'
520
521 # can be accessed via "do '&initcode'"
522
523Example: add local files as extra modules in the bundle.
524
525 # specification file
526 add file1 myfiles/file1.pm
527 add file2 myfiles/file2.pm
528 add file3 myfiles/file3.pl
529
530 # then later, in perl, use
531 use myfiles::file1;
532 require myfiles::file2;
533 my $res = do "myfiles/file3.pl";
534
535=item C<--binadd> F<file> | C<--add> "F<file> alias"
536
537Just like C<--add>, except that it treats the file as binary and adds it
538without any postprocessing (perl files might get stripped to reduce their
539size).
540
541If you specify an alias you should probably add a C<&> prefix to avoid
542clashing with embedded perl files (whose paths never start with C<&>),
543and/or use a special directory prefix, such as C<&res/name>.
544
545You can later get a copy of these files by calling C<staticperl::find
546"alias">.
547
548An alternative way to embed binary files is to convert them to perl and
549use C<do> to get the contents - this method is a bit cumbersome, but works
550both inside and outside of a staticperl bundle:
551
552 # a "binary" file, call it "bindata.pl"
553 <<'SOME_MARKER'
554 binary data NOT containing SOME_MARKER
555 SOME_MARKER
556
557 # load the binary
558 chomp (my $data = do "bindata.pl");
559
560=back
561
562=item Step 2: filter all files using C<--include> and C<--exclude> options.
563
564After all candidate files and modules are added, they are I<filtered>
565by a combination of C<--include> and C<--exclude> patterns (there is an
566implicit C<--include *> at the end, so if no filters are specified, all
567files are included).
568
569All that this step does is potentially reduce the number of files that are
570to be included - no new files are added during this step.
571
572=over 4
573
574=item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern
575
576These specify an include or exclude pattern to be applied to the candidate
577file list. An include makes sure that the given files will be part of the
578resulting file set, an exclude will exclude remaining files. The patterns
579are "extended glob patterns" (see below).
580
581The patterns are applied "in order" - files included via earlier
582C<--include> specifications cannot be removed by any following
583C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
584cannot be added by any following C<--include>.
585
586For example, to include everything except C<Devel> modules, but still
587include F<Devel::PPPort>, you could use this:
588
589 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
590
591=back
592
593=item Step 3: add any extra or "hidden" dependencies.
594
595F<staticperl> currently knows about three extra types of depdendencies
596that are added automatically. Only one (F<.packlist> files) is currently
597optional and can be influenced, the others are always included:
598
599=over 4
600
601=item C<--usepacklists>
602
603Read F<.packlist> files for each distribution that happens to match a
604module name you specified. Sounds weird, and it is, so expect semantics to
605change somehow in the future.
606
607The idea is that most CPAN distributions have a F<.pm> file that matches
608the name of the distribution (which is rather reasonable after all).
609
610If this switch is enabled, then if any of the F<.pm> files that have been
611selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
612and F<.ix> files installed by this distribution are also included.
613
614For example, using this switch, when the L<URI> module is specified, then
615all L<URI> submodules that have been installed via the CPAN distribution
616are included as well, so you don't have to manually specify them.
617
618=item L<AutoLoader> splitfiles
619
620Some modules use L<AutoLoader> - less commonly (hopefully) used functions
621are split into separate F<.al> files, and an index (F<.ix>) file contains
622the prototypes.
623
624Both F<.ix> and F<.al> files will be detected automatically and added to
625the bundle.
626
627=item link libraries (F<.a> files)
628
629Modules using XS (or any other non-perl language extension compiled at
630installation time) will have a static archive (typically F<.a>). These
631will automatically be added to the linker options in F<bundle.ldopts>.
632
633Should F<staticperl> find a dynamic link library (typically F<.so>) it
634will warn about it - obviously this shouldn't happen unless you use
635F<staticperl> on the wrong perl, or one (probably wrongly) configured to
636use dynamic loading.
637
638=item extra libraries (F<extralibs.ld>)
639
640Some modules need linking against external libraries - these are found in
641F<extralibs.ld> and added to F<bundle.ldopts>.
642
643=back
644
645=item Step 4: write bundle files and optionally link a program
646
647At this point, the select files will be read, processed (stripped) and
648finally the bundle files get written to disk, and F<staticperl mkbundle>
649is normally finished. Optionally, it can go a step further and either link
650a new F<perl> binary with all selected modules and files inside, or build
651a standalone application.
652
653Both the contents of the bundle files and any extra linking is controlled
654by these options:
655
656=over 4
657
340=item --strip none|pod|ppi 658=item C<--strip> C<none>|C<pod>|C<ppi>
341 659
342Specify the stripping method applied to reduce the file of the perl 660Specify the stripping method applied to reduce the file of the perl
343sources included. 661sources included.
344 662
345The default is C<pod>, which uses the L<Pod::Strip> module to remove all 663The default is C<pod>, which uses the L<Pod::Strip> module to remove all
356Last not least, if you need accurate line numbers in error messages, 674Last not least, if you need accurate line numbers in error messages,
357or in the unlikely case where C<pod> is too slow, or some module gets 675or in the unlikely case where C<pod> is too slow, or some module gets
358mistreated, you can specify C<none> to not mangle included perl sources in 676mistreated, you can specify C<none> to not mangle included perl sources in
359any way. 677any way.
360 678
361=item --perl 679=item C<--perl>
362 680
363After writing out the bundle files, try to link a new perl interpreter. It 681After writing out the bundle files, try to link a new perl interpreter. It
364will be called F<perl> and will be left in the current working 682will be called F<perl> and will be left in the current working
365directory. The bundle files will be removed. 683directory. The bundle files will be removed.
366 684
367This switch is automatically used when F<staticperl> is invoked with the 685This switch is automatically used when F<staticperl> is invoked with the
368C<mkperl> command (instead of C<mkbundle>): 686C<mkperl> command instead of C<mkbundle>.
369 687
370 # build a new ./perl with only common::sense in it - very small :) 688Example: build a new F<./perl> binary with only L<common::sense> inside -
689it will be even smaller than the standard perl interpreter as none of the
690modules of the base distribution (such as L<Fcntl>) will be included.
691
371 staticperl mkperl -Mcommon::sense 692 staticperl mkperl -Mcommon::sense
372 693
373=item --app name 694=item C<--app> F<name>
374 695
375After writing out the bundle files, try to link a new standalone 696After writing out the bundle files, try to link a new standalone
376program. It will be called C<name>, and the bundle files get removed after 697program. It will be called C<name>, and the bundle files get removed after
377linking it. 698linking it.
699
700This switch is automatically used when F<staticperl> is invoked with the
701C<mkapp> command instead of C<mkbundle>.
378 702
379The difference to the (mutually exclusive) C<--perl> option is that the 703The difference to the (mutually exclusive) C<--perl> option is that the
380binary created by this option will not try to act as a perl interpreter - 704binary created by this option will not try to act as a perl interpreter -
381instead it will simply initialise the perl interpreter, clean it up and 705instead it will simply initialise the perl interpreter, clean it up and
382exit. 706exit.
383 707
384This switch is automatically used when F<staticperl> is invoked with the 708This means that, by default, it will do nothing but burn a few CPU cycles
385C<mkapp> command (instead of C<mkbundle>):
386
387To let it do something useful you I<must> add some boot code, e.g. with 709- for it to do something useful you I<must> add some boot code, e.g. with
388the C<--boot> option. 710the C<--boot> option.
389 711
390Example: create a standalone perl binary that will execute F<appfile> when 712Example: create a standalone perl binary called F<./myexe> that will
391it is started. 713execute F<appfile> when it is started.
392 714
393 staticperl mkbundle --app myexe --boot appfile 715 staticperl mkbundle --app myexe --boot appfile
394 716
395=item --use module | -Mmodule 717=item C<--ignore-env>
396 718
397Include the named module and all direct dependencies. This is done by 719Generates extra code to unset some environment variables before
398C<require>'ing the module in a subprocess and tracing which other modules 720initialising/running perl. Perl supports a lot of environment variables
399and files it actually loads. If the module uses L<AutoLoader>, then all 721that might alter execution in ways that might be undesirablre for
400splitfiles will be included as well. 722standalone applications, and this option removes those known to cause
723trouble.
401 724
402Example: include AnyEvent and AnyEvent::Impl::Perl. 725Specifically, these are removed:
403 726
404 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl 727C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
728output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
729C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
730C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
405 731
406Sometimes you want to load old-style "perl libraries" (F<.pl> files), or 732The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
407maybe other weirdly named files. To do that, you need to quote the name in 733startup code used by F<staticperl> overrides C<@INC> in all cases.
408single or double quotes. When given on the command line, you probably need
409to quote once more to avoid your shell interpreting it. Common cases that
410need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
411 734
412Example: include the required files for F<perl -V> to work in all its 735This option will not make your program more secure (unless you are
413glory (F<Config.pm> is included automatically by this). 736running with elevated privileges), but it will reduce the surprise effect
737when a user has these environment variables set and doesn't expect your
738standalone program to act like a perl interpreter.
414 739
415 # bourne shell
416 staticperl mkbundle --use '"Config_heavy.pl"'
417
418 # bundle specification file
419 use "Config_heavy.pl"
420
421The C<-Mmodule> syntax is included as an alias that might be easier to
422remember than C<use>. Or maybe it confuses people. Time will tell. Or
423maybe not. Argh.
424
425=item --eval "perl code" | -e "perl code"
426
427Sometimes it is easier (or necessary) to specify dependencies using perl
428code, or maybe one of the modules you use need a special use statement. In
429that case, you can use C<eval> to execute some perl snippet or set some
430variables or whatever you need. All files C<require>'d or C<use>'d in the
431script are included in the final bundle.
432
433Keep in mind that F<mkbundle> will only C<require> the modules named
434by the C<--use> option, so do not expect the symbols from modules you
435C<--use>'d earlier on the command line to be available.
436
437Example: force L<AnyEvent> to detect a backend and therefore include it
438in the final bundle.
439
440 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
441
442 # or like this
443 staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
444
445Example: use a separate "bootstrap" script that C<use>'s lots of modules
446and include this in the final bundle, to be executed automatically.
447
448 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
449
450=item --boot filename
451
452Include the given file in the bundle and arrange for it to be executed
453(using a C<require>) before anything else when the new perl is
454initialised. This can be used to modify C<@INC> or anything else before
455the perl interpreter executes scripts given on the command line (or via
456C<-e>). This works even in an embedded interpreter.
457
458=item --incglob pattern
459
460This goes through all library directories and tries to match any F<.pm>
461and F<.pl> files against the extended glob pattern (see below). If a file
462matches, it is added. This switch will automatically detect L<AutoLoader>
463files and the required link libraries for XS modules, but it will I<not>
464scan the file for dependencies (at the moment).
465
466This is mainly useful to include "everything":
467
468 --incglob '*'
469
470Or to include perl libraries, or trees of those, such as the unicode
471database files needed by many other modules:
472
473 --incglob '/unicore/**.pl'
474
475=item --add file | --add "file alias"
476
477Adds the given (perl) file into the bundle (and optionally call it
478"alias"). This is useful to include any custom files into the bundle.
479
480Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
481
482 staticperl mkperl --add "httpd httpd.pm"
483
484It is also a great way to add any custom modules:
485
486 # specification file
487 add file1 myfiles/file1
488 add file2 myfiles/file2
489 add file3 myfiles/file3
490
491=item --binadd file | --add "file alias"
492
493Just like C<--add>, except that it treats the file as binary and adds it
494without any processing.
495
496You should probably add a C</> prefix to avoid clashing with embedded
497perl files (whose paths do not start with C</>), and/or use a special
498directory, such as C</res/name>.
499
500You can later get a copy of these files by calling C<staticperl::find
501"alias">.
502
503=item --include pattern | -i pattern | --exclude pattern | -x pattern
504
505These two options define an include/exclude filter that is used after all
506files selected by the other options have been found. Each include/exclude
507is applied to all files found so far - an include makes sure that the
508given files will be part of the resulting file set, an exclude will
509exclude files. The patterns are "extended glob patterns" (see below).
510
511For example, to include everything, except C<Devel> modules, but still
512include F<Devel::PPPort>, you could use this:
513
514 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
515
516=item --static 740=item C<--static>
517 741
518When C<--perl> is also given, link statically instead of dynamically. The 742Add C<-static> to F<bundle.ldopts>, which means a fully static (if
743supported by the OS) executable will be created. This is not immensely
744useful when just creating the bundle files, but is most useful when
745linking a binary with the C<--perl> or C<--app> options.
746
519default is to link the new perl interpreter fully dynamic (that means all 747The default is to link the new binary dynamically (that means all perl
520perl modules are linked statically, but all external libraries are still 748modules are linked statically, but all external libraries are still
521referenced dynamically). 749referenced dynamically).
522 750
523Keep in mind that Solaris doesn't support static linking at all, and 751Keep in mind that Solaris doesn't support static linking at all, and
524systems based on GNU libc don't really support it in a usable fashion 752systems based on GNU libc don't really support it in a very usable
525either. Try uClibc if you want to create fully statically linked 753fashion either. Try uClibc if you want to create fully statically linked
526executables, or try the C<--staticlibs> option to link only some libraries 754executables, or try the C<--staticlib> option to link only some libraries
527statically. 755statically.
528 756
529=item --staticlib libname 757=item C<--staticlib> libname
530 758
531When not linking fully statically, this option allows you to link specific 759When not linking fully statically, this option allows you to link specific
532libraries statically. What it does is simply replace all occurances of 760libraries statically. What it does is simply replace all occurrences of
533C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> 761C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
534option. 762option.
535 763
536This will have no effect unless the library is actually linked against, 764This will have no effect unless the library is actually linked against,
537specifically, C<--staticlib> will not link against the named library 765specifically, C<--staticlib> will not link against the named library
538unless it would be linked against anyway. 766unless it would be linked against anyway.
539 767
540Example: link libcrypt statically into the binary. 768Example: link libcrypt statically into the final binary.
541 769
542 staticperl mkperl -MIO::AIO --staticlib crypt 770 staticperl mkperl -MIO::AIO --staticlib crypt
543 771
544 # ldopts might nwo contain: 772 # ldopts might now contain:
545 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread 773 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
546 774
547=item any other argument 775=back
548
549Any other argument is interpreted as a bundle specification file, which
550supports most long options (without extra quoting), one option per line.
551 776
552=back 777=back
553 778
554=head3 EXTENDED GLOB PATTERNS 779=head3 EXTENDED GLOB PATTERNS
555 780
569=item Patterns not starting with F</> will be anchored at the end of the path. 794=item Patterns not starting with F</> will be anchored at the end of the path.
570 795
571That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the 796That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
572hierarchy, but not any directories of the same name. 797hierarchy, but not any directories of the same name.
573 798
574=item A F<*> matches any single component. 799=item A F<*> matches anything within a single path component.
575 800
576That is, F</unicore/*.pl> would match all F<.pl> files directly inside 801That is, F</unicore/*.pl> would match all F<.pl> files directly inside
577C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> 802C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
578will not match slashes. 803will not match slashes.
579 804
589 814
590=back 815=back
591 816
592=head2 F<STATICPERL> CONFIGURATION AND HOOKS 817=head2 F<STATICPERL> CONFIGURATION AND HOOKS
593 818
594During (each) startup, F<staticperl> tries to source the following shell 819During (each) startup, F<staticperl> tries to source some shell files to
820allow you to fine-tune/override configuration settings.
821
822In them you can override shell variables, or define shell functions
823("hooks") to be called at specific phases during installation. For
824example, you could define a C<postinstall> hook to install additional
825modules from CPAN each time you start from scratch.
826
827If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
828to source the file named with it only. Otherwise, it tries the following
595files in order: 829shell files in order:
596 830
597 /etc/staticperlrc 831 /etc/staticperlrc
598 ~/.staticperlrc 832 ~/.staticperlrc
599 $STATICPERL/rc 833 $STATICPERL/rc
600 834
601They can be used to override shell variables, or define functions to be
602called at specific phases.
603
604Note that the last file is erased during F<staticperl distclean>, so 835Note that the last file is erased during F<staticperl distclean>, so
605generally should not be used. 836generally should not be used.
606 837
607=head3 CONFIGURATION VARIABLES 838=head3 CONFIGURATION VARIABLES
608 839
648installation, you can set any environment variable you want - some modules 879installation, you can set any environment variable you want - some modules
649(such as L<Coro> or L<EV>) use environment variables for further tweaking. 880(such as L<Coro> or L<EV>) use environment variables for further tweaking.
650 881
651=item C<PERL_VERSION> 882=item C<PERL_VERSION>
652 883
653The perl version to install - default is currently C<5.12.2>, but C<5.8.9> 884The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
654is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is 885is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
655about as big as 5.12.2). 886about as big as 5.12.3).
656 887
657=item C<PERL_PREFIX> 888=item C<PERL_PREFIX>
658 889
659The prefix where perl gets installed (default: F<$STATICPERL/perl>), 890The prefix where perl gets installed (default: F<$STATICPERL/perl>),
660i.e. where the F<bin> and F<lib> subdirectories will end up. 891i.e. where the F<bin> and F<lib> subdirectories will end up.
669 900
670More commonly, you would either activate 64 bit integer support 901More commonly, you would either activate 64 bit integer support
671(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to 902(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
672reduce filesize further. 903reduce filesize further.
673 904
674=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> 905=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
675 906
676These flags are passed to perl's F<Configure> script, and are generally 907These flags are passed to perl's F<Configure> script, and are generally
677optimised for small size (at the cost of performance). Since they also 908optimised for small size (at the cost of performance). Since they also
678contain subtle workarounds around various build issues, changing these 909contain subtle workarounds around various build issues, changing these
679usually requires understanding their default values - best look at the top 910usually requires understanding their default values - best look at
680of the F<staticperl> script for more info on these. 911the top of the F<staticperl> script for more info on these, and use a
912F<~/.staticperlrc> to override them.
913
914Most of the variables override (or modify) the corresponding F<Configure>
915variable, except C<PERL_CCFLAGS>, which gets appended.
681 916
682=back 917=back
683 918
684=head4 Variables you probably I<do not want> to override 919=head4 Variables you probably I<do not want> to override
685 920
686=over 4 921=over 4
922
923=item C<MAKE>
924
925The make command to use - default is C<make>.
687 926
688=item C<MKBUNDLE> 927=item C<MKBUNDLE>
689 928
690Where F<staticperl> writes the C<mkbundle> command to 929Where F<staticperl> writes the C<mkbundle> command to
691(default: F<$STATICPERL/mkbundle>). 930(default: F<$STATICPERL/mkbundle>).
776A header file that contains the prototypes of the few symbols "exported" 1015A header file that contains the prototypes of the few symbols "exported"
777by bundle.c, and also exposes the perl headers to the application. 1016by bundle.c, and also exposes the perl headers to the application.
778 1017
779=over 4 1018=over 4
780 1019
781=item staticperl_init () 1020=item staticperl_init (xs_init = 0)
782 1021
783Initialises the perl interpreter. You can use the normal perl functions 1022Initialises the perl interpreter. You can use the normal perl functions
784after calling this function, for example, to define extra functions or 1023after calling this function, for example, to define extra functions or
785to load a .pm file that contains some initialisation code, or the main 1024to load a .pm file that contains some initialisation code, or the main
786program function: 1025program function:
793 } 1032 }
794 1033
795 static void 1034 static void
796 run_myapp(void) 1035 run_myapp(void)
797 { 1036 {
798 staticperl_init (); 1037 staticperl_init (0);
799 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); 1038 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
800 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" 1039 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
801 } 1040 }
802 1041
1042When your bootcode already wants to access some XS functions at
1043compiletime, then you need to supply an C<xs_init> function pointer that
1044is called as soon as perl is initialised enough to define XS functions,
1045but before the preamble code is executed:
1046
1047 static void
1048 xs_init (pTHX)
1049 {
1050 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
1051 }
1052
1053 static void
1054 run_myapp(void)
1055 {
1056 staticperl_init (xs_init);
1057 }
1058
1059=item staticperl_cleanup ()
1060
1061In the unlikely case that you want to destroy the perl interpreter, here
1062is the corresponding function.
1063
803=item staticperl_xs_init (pTHX) 1064=item staticperl_xs_init (pTHX)
804 1065
805Sometimes you need direct control over C<perl_parse> and C<perl_run>, in 1066Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
806which case you do not want to use C<staticperl_init> but call them on your 1067which case you do not want to use C<staticperl_init> but call them on your
807own. 1068own.
808 1069
809Then you need this function - either pass it directly as the C<xs_init> 1070Then you need this function - either pass it directly as the C<xs_init>
810function to C<perl_parse>, or call it from your own C<xs_init> function. 1071function to C<perl_parse>, or call it as one of the first things from your
811 1072own C<xs_init> function.
812=item staticperl_cleanup ()
813
814In the unlikely case that you want to destroy the perl interpreter, here
815is the corresponding function.
816 1073
817=item PerlInterpreter *staticperl 1074=item PerlInterpreter *staticperl
818 1075
819The perl interpreter pointer used by staticperl. Not normally so useful, 1076The perl interpreter pointer used by staticperl. Not normally so useful,
820but there it is. 1077but there it is.
856 1113
857Returns the list of all paths embedded in this binary. 1114Returns the list of all paths embedded in this binary.
858 1115
859=back 1116=back
860 1117
861=head1 FULLY STATIC BINARIES - BUILDROOT 1118=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
862 1119
863To make truly static (Linux-) libraries, you might want to have a look at 1120To make truly static (Linux-) libraries, you might want to have a look at
864buildroot (L<http://buildroot.uclibc.org/>). 1121buildroot (L<http://buildroot.uclibc.org/>).
865 1122
866Buildroot is primarily meant to set up a cross-compile environment (which 1123Buildroot is primarily meant to set up a cross-compile environment (which
927 1184
928Some functionality in the utf8 module, such as swash handling (used 1185Some functionality in the utf8 module, such as swash handling (used
929for unicode character ranges in regexes) is implemented in the 1186for unicode character ranges in regexes) is implemented in the
930C<"utf8_heavy.pl"> library: 1187C<"utf8_heavy.pl"> library:
931 1188
932 -M'"utf8_heavy.pl"' 1189 -Mutf8_heavy.pl
933 1190
934Many Unicode properties in turn are defined in separate modules, 1191Many Unicode properties in turn are defined in separate modules,
935such as C<"unicore/Heavy.pl"> and more specific data tables such as 1192such as C<"unicore/Heavy.pl"> and more specific data tables such as
936C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables 1193C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
937are big (7MB uncompressed, although F<staticperl> contains special 1194are big (7MB uncompressed, although F<staticperl> contains special
938handling for those files), so including them on demand by your application 1195handling for those files), so including them on demand by your application
939only might pay off. 1196only might pay off.
940 1197
941To simply include the whole unicode database, use: 1198To simply include the whole unicode database, use:
942 1199
943 --incglob '/unicore/*.pl' 1200 --incglob '/unicore/**.pl'
944 1201
945=item AnyEvent 1202=item AnyEvent
946 1203
947AnyEvent needs a backend implementation that it will load in a delayed 1204AnyEvent needs a backend implementation that it will load in a delayed
948fashion. The L<AnyEvent::Impl::Perl> backend is the default choice 1205fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
953 1210
954If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn 1211If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
955functions), you also need to include C<"AnyEvent/Util/idna.pl"> and 1212functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
956C<"AnyEvent/Util/uts46data.pl">. 1213C<"AnyEvent/Util/uts46data.pl">.
957 1214
1215Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1216everything.
1217
958=item Carp 1218=item Carp
959 1219
960Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of 1220Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
961perl 5.12.2 (maybe earlier), this dependency no longer exists. 1221perl 5.12.2 (maybe earlier), this dependency no longer exists.
962 1222
966turn might need L<"Config_heavy.pl">. Including the latter gives you 1226turn might need L<"Config_heavy.pl">. Including the latter gives you
967both. 1227both.
968 1228
969=item Term::ReadLine::Perl 1229=item Term::ReadLine::Perl
970 1230
971Also needs L<Term::ReadLine::readline>. 1231Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
972 1232
973=item URI 1233=item URI
974 1234
975URI implements schemes as separate modules - the generic URL scheme is 1235URI implements schemes as separate modules - the generic URL scheme is
976implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If 1236implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
977you need to use any of these schemes, you should include these manually. 1237you need to use any of these schemes, you should include these manually,
1238or use C<--usepacklists>.
978 1239
979=back 1240=back
980 1241
981=head2 RECIPES 1242=head2 RECIPES
982 1243
983=over 4 1244=over 4
984 1245
985=item Linking everything in 1246=item Just link everything in
986 1247
987To link just about everything installed in the perl library into a new 1248To link just about everything installed in the perl library into a new
988perl, try this: 1249perl, try this (the first time this runs it will take a long time, as a
1250lot of files need to be parsed):
989 1251
990 staticperl mkperl --strip ppi --incglob '*' 1252 staticperl mkperl -v --strip ppi --incglob '*'
991 1253
1254If you don't mind the extra megabytes, this can be a very effective way of
1255creating bundles without having to worry about forgetting any modules.
1256
1257You get even more useful variants of this method by first selecting
1258everything, and then excluding stuff you are reasonable sure not to need -
1259L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach.
1260
992=item Getting rid of netdb function 1261=item Getting rid of netdb functions
993 1262
994The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> 1263The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
995and so on) that few applications use. You can avoid compiling them in by 1264and so on) that few applications use. You can avoid compiling them in by
996putting the following fragment into a C<preconfigure> hook: 1265putting the following fragment into a C<preconfigure> hook:
997 1266
1014 do 1283 do
1015 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" 1284 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1016 done 1285 done
1017 } 1286 }
1018 1287
1019This mostly gains space when linking staticaly, as the functions will 1288This mostly gains space when linking statically, as the functions will
1020liekly not be linked in. The gain for dynamically-linked binaries is 1289likely not be linked in. The gain for dynamically-linked binaries is
1021smaller. 1290smaller.
1022 1291
1023Also, this leaves C<gethostbyname> in - not only is it actually used 1292Also, this leaves C<gethostbyname> in - not only is it actually used
1024often, the L<Socket> module also exposes it, so leaving it out usually 1293often, the L<Socket> module also exposes it, so leaving it out usually
1025gains little. Why Socket exposes a C function that is in the core already 1294gains little. Why Socket exposes a C function that is in the core already

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines