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.20 by root, Fri Dec 10 20:29:17 2010 UTC vs.
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC

122often as necessary. 122often as necessary.
123 123
124=head1 THE F<STATICPERL> SCRIPT 124=head1 THE F<STATICPERL> SCRIPT
125 125
126This module installs a script called F<staticperl> into your perl 126This module installs a script called F<staticperl> into your perl
127binary directory. The script is fully self-contained, and can be used 127binary directory. The script is fully self-contained, and can be
128without perl (for example, in an uClibc chroot environment). In fact, 128used without perl (for example, in an uClibc chroot environment). In
129it can be extracted from the C<App::Staticperl> distribution tarball as 129fact, it can be extracted from the C<App::Staticperl> distribution
130F<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>.
131 133
132F<staticperl> interprets the first argument as a command to execute, 134F<staticperl> interprets the first argument as a command to execute,
133optionally followed by any parameters. 135optionally followed by any parameters.
134 136
135There are two command categories: the "phase 1" commands which deal with 137There are two command categories: the "phase 1" commands which deal with
145 147
146The command 148The command
147 149
148 staticperl install 150 staticperl install
149 151
150Is normally all you need: It installs the perl interpreter in 152is normally all you need: It installs the perl interpreter in
151F<~/.staticperl/perl>. It downloads, configures, builds and installs the 153F<~/.staticperl/perl>. It downloads, configures, builds and installs the
152perl interpreter if required. 154perl interpreter if required.
153 155
154Most of the following commands simply run one or more steps of this 156Most of the following F<staticperl> subcommands simply run one or more
155sequence. 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.
156 163
157To force recompilation or reinstallation, you need to run F<staticperl 164To force recompilation or reinstallation, you need to run F<staticperl
158distclean> first. 165distclean> first.
159 166
160=over 4 167=over 4
207 214
208=item F<staticperl clean> 215=item F<staticperl clean>
209 216
210Deletes the perl source directory (and potentially cleans up other 217Deletes the perl source directory (and potentially cleans up other
211intermediate 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
212building perl, without removing the installed perl interpreter, or to 219building perl, without removing the installed perl interpreter.
213force a re-build from scratch.
214 220
215At 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.
216 224
217=item F<staticperl distclean> 225=item F<staticperl distclean>
218 226
219This wipes your complete F<~/.staticperl> directory. Be careful with this, 227This wipes your complete F<~/.staticperl> directory. Be careful with this,
220it nukes your perl download, perl sources, perl distribution and any 228it nukes your perl download, perl sources, perl distribution and any
270 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http 278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
271 279
272 # run it 280 # run it
273 ./app 281 ./app
274 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
275=head3 OPTION PROCESSING 314=head3 OPTION PROCESSING
276 315
277All options can be given as arguments on the command line (typically 316All options can be given as arguments on the command line (typically
278using 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
279specifying a lot of modules can make the command line very cumbersome, 318specifying a lot of modules can make the command line very cumbersome, you
280you can put all long options into a "bundle specification file" (with or 319can put all long options into a "bundle specification file" (one option
281without C<--> prefix) and specify this bundle file instead. 320per line, with or without C<--> prefix) and specify this bundle file
321instead.
282 322
283For example, the command given earlier could also look like this: 323For example, the command given earlier could also look like this:
284 324
285 staticperl mkperl httpd.bundle 325 staticperl mkperl httpd.bundle
286 326
291 use AnyEvent::HTTPD 331 use AnyEvent::HTTPD
292 use URI::http 332 use URI::http
293 add eg/httpd httpd.pm 333 add eg/httpd httpd.pm
294 334
295All options that specify modules or files to be added are processed in the 335All options that specify modules or files to be added are processed in the
296order given on the command line (that affects the C<--use> and C<--eval> 336order given on the command line.
297options at the moment).
298 337
299=head3 PACKAGE SELECTION WORKFLOW 338=head3 BUNDLE CREATION WORKFLOW
300 339
301F<staticperl mkbundle> has a number of options to control package 340F<staticperl mkbundle> works by first assembling a list of candidate
302selection. This section describes how they interact with each other. Also, 341files and modules to include, then filtering them by include/exclude
303since I am still a newbie w.r.t. these issues, maybe future versions of 342patterns. The remaining modules (together with their direct depdendencies,
304F<staticperl> will change this, so watch out :) 343such as link libraries and AutoLoader files) are then converted into
344bundle files suitable for embedding. Afterwards, F<staticperl mkbundle>
345can optionally build a new perl interpreter or a standalone application.
305 346
306The idiom "in order" means "in order that they are specified on the
307commandline". If you use a bundle specification file, then the options
308will be processed as if they were given in place of the bundle file name.
309
310=over 4 347=over 4
311 348
312=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and 349=item Step 0: Generic argument processing.
313C<--incglob> options, in order.
314 350
315In addition, C<--use> and C<--eval> dependencies will be added when the 351The following options influence F<staticperl mkbundle> itself.
316options are processed.
317
318=item 2. apply all C<--include> and C<--exclude> options, in order.
319
320All this step does is potentially reduce the number of files already
321selected or found in phase 1.
322
323=item 3. find all modules (== F<.pm> files), gather their static archives
324(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
325extra libraries they need for linking (F<extralibs.ld>) and optionally
326evaluate any F<.packlist> files.
327
328This step is required to link against XS extensions and also adds files
329required for L<AutoLoader> to do it's job.
330
331=back
332
333After this, all the files selected for bundling will be read and processed
334(stripped), the bundle files will be written, and optionally a new F<perl>
335or application binary will be linked.
336
337=head3 MKBUNDLE OPTIONS
338 352
339=over 4 353=over 4
340 354
341=item --verbose | -v 355=item --verbose | -v
342 356
344 358
345=item --quiet | -q 359=item --quiet | -q
346 360
347Decreases the verbosity level by one. 361Decreases the verbosity level by one.
348 362
363=item any other argument
364
365Any other argument is interpreted as a bundle specification file, which
366supports most long options (without extra quoting), one option per line.
367
368=back
369
370=item Step 1: gather candidate files and modules
371
372In this step, modules, perl libraries (F<.pl> files) and other files are
373selected for inclusion in the bundle. The relevant options are executed
374in order (this makes a difference mostly for C<--eval>, which can rely on
375earlier C<--use> options to have been executed).
376
377=over 4
378
379=item C<--use> F<module> | C<-M>F<module>
380
381Include the named module and trace direct dependencies. This is done by
382C<require>'ing the module in a subprocess and tracing which other modules
383and files it actually loads.
384
385Example: include AnyEvent and AnyEvent::Impl::Perl.
386
387 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
388
389Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
390maybe other weirdly named files. To do that, you need to quote the name in
391single or double quotes. When given on the command line, you probably need
392to quote once more to avoid your shell interpreting it. Common cases that
393need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
394
395Example: include the required files for F<perl -V> to work in all its
396glory (F<Config.pm> is included automatically by this).
397
398 # bourne shell
399 staticperl mkbundle --use '"Config_heavy.pl"'
400
401 # bundle specification file
402 use "Config_heavy.pl"
403
404The C<-M>module syntax is included as an alias that might be easier to
405remember than C<--use>. Or maybe it confuses people. Time will tell. Or
406maybe not. Sigh.
407
408=item C<--eval> "perl code" | C<-e> "perl code"
409
410Sometimes it is easier (or necessary) to specify dependencies using perl
411code, or maybe one of the modules you use need a special use statement. In
412that case, you can use C<--eval> to execute some perl snippet or set some
413variables or whatever you need. All files C<require>'d or C<use>'d while
414executing the snippet are included in the final bundle.
415
416Keep in mind that F<mkbundle> will only C<require> the modules named
417by the C<--use> option, so do not expect the symbols from modules you
418C<--use>'d earlier on the command line to be available.
419
420Example: force L<AnyEvent> to detect a backend and therefore include it
421in the final bundle.
422
423 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
424
425 # or like this
426 staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
427
428Example: use a separate "bootstrap" script that C<use>'s lots of modules
429and also include this in the final bundle, to be executed automatically
430when the interpreter is initialised.
431
432 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
433
434=item C<--boot> F<filename>
435
436Include the given file in the bundle and arrange for it to be
437executed (using C<require>) before the main program when the new perl
438is initialised. This can be used to modify C<@INC> or do similar
439modifications before the perl interpreter executes scripts given on the
440command line (or via C<-e>). This works even in an embedded interpreter -
441the file will be executed during interpreter initialisation in that case.
442
443=item C<--incglob> pattern
444
445This goes through all standard library directories and tries to match any
446F<.pm> and F<.pl> files against the extended glob pattern (see below). If
447a file matches, it is added. The pattern is matched against the full path
448of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
449
450This is very useful to include "everything":
451
452 --incglob '*'
453
454It is also useful for including perl libraries, or trees of those, such as
455the unicode database files needed by some perl builtins, the regex engine
456and other modules.
457
458 --incglob '/unicore/**.pl'
459
460=item C<--add> F<file> | C<--add> "F<file> alias"
461
462Adds the given (perl) file into the bundle (and optionally call it
463"alias"). The F<file> is either an absolute path or a path relative to
464the current directory. If an alias is specified, then this is the name it
465will use for C<@INC> searches, otherfile the F<file> will be used as the
466internal name.
467
468This switch is used to include extra files into the bundle.
469
470Example: embed the file F<httpd> in the current directory as F<httpd.pm>
471when creating the bundle.
472
473 staticperl mkperl --add "httpd httpd.pm"
474
475Example: add local files as extra modules in the bundle.
476
477 # specification file
478 add file1 myfiles/file1.pm
479 add file2 myfiles/file2.pm
480 add file3 myfiles/file3.pl
481
482 # then later, in perl, use
483 use myfiles::file1;
484 require myfiles::file2;
485 my $res = do "myfiles/file3.pl";
486
487=item C<--binadd> F<file> | C<--add> "F<file> alias"
488
489Just like C<--add>, except that it treats the file as binary and adds it
490without any postprocessing (perl files might get stripped to reduce their
491size).
492
493You should probably add a C</> prefix to avoid clashing with embedded perl
494files (whose paths do not start with C</>), and/or use a special directory
495prefix, such as C</res/name>.
496
497You can later get a copy of these files by calling C<staticperl::find
498"alias">.
499
500An alternative way to embed binary files is to convert them to perl and
501use C<do> to get the contents - this method is a bit cumbersome, but works
502both inside and outside of a staticperl bundle:
503
504 # a "binary" file, call it "bindata.pl"
505 <<'SOME_MARKER'
506 binary data NOT containing SOME_MARKER
507 SOME_MARKER
508
509 # load the binary
510 chomp (my $data = do "bindata.pl");
511
512=back
513
514=item Step 2: filter all files using C<--include> and C<--exclude> options.
515
516After all candidate files and modules are added, they are I<filtered>
517by a combination of C<--include> and C<--exclude> patterns (there is an
518implicit C<--include **> at the end, so if no filters are specified, all
519files are included).
520
521All that this step does is potentially reduce the number of files that are
522to be included - no new files are added during this step.
523
524=over 4
525
526=item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern
527
528These specify an include or exclude pattern to be applied to the candidate
529file list. An include makes sure that the given files will be part of the
530resulting file set, an exclude will exclude remaining files. The patterns
531are "extended glob patterns" (see below).
532
533The patterns are applied "in order" - files included via earlier
534C<--include> specifications cannot be removed by any following
535C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
536cannot be added by any following C<--include>.
537
538For example, to include everything except C<Devel> modules, but still
539include F<Devel::PPPort>, you could use this:
540
541 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
542
543=back
544
545=item Step 3: add any extra or "hidden" dependencies.
546
547F<staticperl> currently knows about three extra types of depdendencies
548that are added automatically. Only one (F<.packlist> files) is currently
549optional and can be influenced, the others are always included:
550
551=over 4
552
553=item C<--usepacklist>
554
555Read F<.packlist> files for each distribution that happens to match a
556module name you specified. Sounds weird, and it is, so expect semantics to
557change somehow in the future.
558
559The idea is that most CPAN distributions have a F<.pm> file that matches
560the name of the distribution (which is rather reasonable after all).
561
562If this switch is enabled, then if any of the F<.pm> files that have been
563selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
564and F<.ix> files installed by this distribution are also included.
565
566For example, using this switch, when the L<URI> module is specified, then
567all L<URI> submodules that have been installed via the CPAN distribution
568are included as well, so you don't have to manually specify them.
569
570=item L<AutoLoader> splitfiles
571
572Some modules use L<AutoLoader> - less commonly (hopefully) used functions
573are split into separate F<.al> files, and an index (F<.ix>) file contains
574the prototypes.
575
576Both F<.ix> and F<.al> files will be detected automatically and added to
577the bundle.
578
579=item link libraries (F<.a> files)
580
581Modules using XS (or any other non-perl language extension compiled at
582installation time) will have a static archive (typically F<.a>). These
583will automatically be added to the linker options in F<bundle.ldopts>.
584
585Should F<staticperl> find a dynamic link library (typically F<.so>) it
586will warn about it - obviously this shouldn't happen unless you use
587F<staticperl> on the wrong perl, or one (probably wrongly) configured to
588use dynamic loading.
589
590=item extra libraries (F<extralibs.ld>)
591
592Some modules need linking against external libraries - these are found in
593F<extralibs.ld> and added to F<bundle.ldopts>.
594
595=back
596
597=item Step 4: write bundle files and optionally link a program
598
599At this point, the select files will be read, processed (stripped) and
600finally the bundle files get written to disk, and F<staticperl mkbundle>
601is normally finished. Optionally, it can go a step further and either link
602a new F<perl> binary with all selected modules and files inside, or build
603a standalone application.
604
605Both the contents of the bundle files and any extra linking is controlled
606by these options:
607
608=over 4
609
349=item --strip none|pod|ppi 610=item C<--strip> C<none>|C<pod>|C<ppi>
350 611
351Specify the stripping method applied to reduce the file of the perl 612Specify the stripping method applied to reduce the file of the perl
352sources included. 613sources included.
353 614
354The default is C<pod>, which uses the L<Pod::Strip> module to remove all 615The default is C<pod>, which uses the L<Pod::Strip> module to remove all
372After writing out the bundle files, try to link a new perl interpreter. It 633After writing out the bundle files, try to link a new perl interpreter. It
373will be called F<perl> and will be left in the current working 634will be called F<perl> and will be left in the current working
374directory. The bundle files will be removed. 635directory. The bundle files will be removed.
375 636
376This switch is automatically used when F<staticperl> is invoked with the 637This switch is automatically used when F<staticperl> is invoked with the
377C<mkperl> command (instead of C<mkbundle>): 638C<mkperl> command instead of C<mkbundle>.
378 639
379 # build a new ./perl with only common::sense in it - very small :) 640Example: build a new F<./perl> binary with only L<common::sense> inside -
641it will be even smaller than the standard perl interpreter as none of the
642modules of the base distribution (such as L<Fcntl>) will be included.
643
380 staticperl mkperl -Mcommon::sense 644 staticperl mkperl -Mcommon::sense
381 645
382=item --app name 646=item --app name
383 647
384After writing out the bundle files, try to link a new standalone 648After writing out the bundle files, try to link a new standalone
385program. It will be called C<name>, and the bundle files get removed after 649program. It will be called C<name>, and the bundle files get removed after
386linking it. 650linking it.
651
652This switch is automatically used when F<staticperl> is invoked with the
653C<mkapp> command instead of C<mkbundle>.
387 654
388The difference to the (mutually exclusive) C<--perl> option is that the 655The difference to the (mutually exclusive) C<--perl> option is that the
389binary created by this option will not try to act as a perl interpreter - 656binary created by this option will not try to act as a perl interpreter -
390instead it will simply initialise the perl interpreter, clean it up and 657instead it will simply initialise the perl interpreter, clean it up and
391exit. 658exit.
392 659
393This switch is automatically used when F<staticperl> is invoked with the 660This means that, by default, it will do nothing but burna few CPU cycles
394C<mkapp> command (instead of C<mkbundle>):
395
396To let it do something useful you I<must> add some boot code, e.g. with 661- for it to do something useful you I<must> add some boot code, e.g. with
397the C<--boot> option. 662the C<--boot> option.
398 663
399Example: create a standalone perl binary that will execute F<appfile> when 664Example: create a standalone perl binary called F<./myexe> that will
400it is started. 665execute F<appfile> when it is started.
401 666
402 staticperl mkbundle --app myexe --boot appfile 667 staticperl mkbundle --app myexe --boot appfile
403 668
404=item --use module | -Mmodule
405
406Include the named module and all direct dependencies. This is done by
407C<require>'ing the module in a subprocess and tracing which other modules
408and files it actually loads. If the module uses L<AutoLoader>, then all
409splitfiles will be included as well.
410
411Example: include AnyEvent and AnyEvent::Impl::Perl.
412
413 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
414
415Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
416maybe other weirdly named files. To do that, you need to quote the name in
417single or double quotes. When given on the command line, you probably need
418to quote once more to avoid your shell interpreting it. Common cases that
419need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
420
421Example: include the required files for F<perl -V> to work in all its
422glory (F<Config.pm> is included automatically by this).
423
424 # bourne shell
425 staticperl mkbundle --use '"Config_heavy.pl"'
426
427 # bundle specification file
428 use "Config_heavy.pl"
429
430The C<-Mmodule> syntax is included as an alias that might be easier to
431remember than C<use>. Or maybe it confuses people. Time will tell. Or
432maybe not. Argh.
433
434=item --eval "perl code" | -e "perl code"
435
436Sometimes it is easier (or necessary) to specify dependencies using perl
437code, or maybe one of the modules you use need a special use statement. In
438that case, you can use C<eval> to execute some perl snippet or set some
439variables or whatever you need. All files C<require>'d or C<use>'d in the
440script are included in the final bundle.
441
442Keep in mind that F<mkbundle> will only C<require> the modules named
443by the C<--use> option, so do not expect the symbols from modules you
444C<--use>'d earlier on the command line to be available.
445
446Example: force L<AnyEvent> to detect a backend and therefore include it
447in the final bundle.
448
449 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
450
451 # or like this
452 staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
453
454Example: use a separate "bootstrap" script that C<use>'s lots of modules
455and include this in the final bundle, to be executed automatically.
456
457 staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
458
459=item --boot filename
460
461Include the given file in the bundle and arrange for it to be executed
462(using a C<require>) before anything else when the new perl is
463initialised. This can be used to modify C<@INC> or anything else before
464the perl interpreter executes scripts given on the command line (or via
465C<-e>). This works even in an embedded interpreter.
466
467=item --usepacklist
468
469Read F<.packlist> files for each distribution that happens to match a
470module name you specified. Sounds weird, and it is, so expect semantics to
471change somehow in the future.
472
473The idea is that most CPAN distributions have a F<.pm> file that matches
474the name of the distribution (which is rather reasonable after all).
475
476If this switch is enabled, then if any of the F<.pm> files that have been
477selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
478and F<.ix> files installed by this distribution are also included.
479
480For example, using this switch, when the L<URI> module is specified, then
481all L<URI> submodules that have been installed via the CPAN distribution
482are included as well, so you don't have to manually specify them.
483
484=item --incglob pattern
485
486This goes through all library directories and tries to match any F<.pm>
487and F<.pl> files against the extended glob pattern (see below). If a file
488matches, it is added. This switch will automatically detect L<AutoLoader>
489files and the required link libraries for XS modules, but it will I<not>
490scan the file for dependencies (at the moment).
491
492This is mainly useful to include "everything":
493
494 --incglob '*'
495
496Or to include perl libraries, or trees of those, such as the unicode
497database files needed by many other modules:
498
499 --incglob '/unicore/**.pl'
500
501=item --add file | --add "file alias"
502
503Adds the given (perl) file into the bundle (and optionally call it
504"alias"). This is useful to include any custom files into the bundle.
505
506Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
507
508 staticperl mkperl --add "httpd httpd.pm"
509
510It is also a great way to add any custom modules:
511
512 # specification file
513 add file1 myfiles/file1
514 add file2 myfiles/file2
515 add file3 myfiles/file3
516
517=item --binadd file | --add "file alias"
518
519Just like C<--add>, except that it treats the file as binary and adds it
520without any processing.
521
522You should probably add a C</> prefix to avoid clashing with embedded
523perl files (whose paths do not start with C</>), and/or use a special
524directory, such as C</res/name>.
525
526You can later get a copy of these files by calling C<staticperl::find
527"alias">.
528
529=item --include pattern | -i pattern | --exclude pattern | -x pattern
530
531These two options define an include/exclude filter that is used after all
532files selected by the other options have been found. Each include/exclude
533is applied to all files found so far - an include makes sure that the
534given files will be part of the resulting file set, an exclude will
535exclude files. The patterns are "extended glob patterns" (see below).
536
537For example, to include everything, except C<Devel> modules, but still
538include F<Devel::PPPort>, you could use this:
539
540 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
541
542=item --static 669=item --static
543 670
544When C<--perl> is also given, link statically instead of dynamically. The 671Add C<-static> to F<bundle.ldopts>, which means a fully static (if
672supported by the OS) executable will be created. This is not immensely
673useful when just creating the bundle files, but is most useful when
674linking a binary with the C<--perl> or C<--app> options.
675
545default is to link the new perl interpreter fully dynamic (that means all 676The default is to link the new binary dynamically (that means all perl
546perl modules are linked statically, but all external libraries are still 677modules are linked statically, but all external libraries are still
547referenced dynamically). 678referenced dynamically).
548 679
549Keep in mind that Solaris doesn't support static linking at all, and 680Keep in mind that Solaris doesn't support static linking at all, and
550systems based on GNU libc don't really support it in a usable fashion 681systems based on GNU libc don't really support it in a very usable
551either. Try uClibc if you want to create fully statically linked 682fashion either. Try uClibc if you want to create fully statically linked
552executables, or try the C<--staticlibs> option to link only some libraries 683executables, or try the C<--staticlib> option to link only some libraries
553statically. 684statically.
554 685
555=item --staticlib libname 686=item --staticlib libname
556 687
557When not linking fully statically, this option allows you to link specific 688When not linking fully statically, this option allows you to link specific
565 696
566Example: link libcrypt statically into the binary. 697Example: link libcrypt statically into the binary.
567 698
568 staticperl mkperl -MIO::AIO --staticlib crypt 699 staticperl mkperl -MIO::AIO --staticlib crypt
569 700
570 # ldopts might nwo contain: 701 # ldopts might now contain:
571 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread 702 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
572 703
573=item any other argument 704=back
574
575Any other argument is interpreted as a bundle specification file, which
576supports most long options (without extra quoting), one option per line.
577 705
578=back 706=back
579 707
580=head3 EXTENDED GLOB PATTERNS 708=head3 EXTENDED GLOB PATTERNS
581 709
701 829
702More commonly, you would either activate 64 bit integer support 830More commonly, you would either activate 64 bit integer support
703(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to 831(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
704reduce filesize further. 832reduce filesize further.
705 833
706=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> 834=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
707 835
708These flags are passed to perl's F<Configure> script, and are generally 836These flags are passed to perl's F<Configure> script, and are generally
709optimised for small size (at the cost of performance). Since they also 837optimised for small size (at the cost of performance). Since they also
710contain subtle workarounds around various build issues, changing these 838contain subtle workarounds around various build issues, changing these
711usually requires understanding their default values - best look at the top 839usually requires understanding their default values - best look at
712of the F<staticperl> script for more info on these. 840the top of the F<staticperl> script for more info on these, and use a
841F<~/.staticperlrc> to override them.
842
843Most of the variables override (or modify) the corresponding F<Configure>
844variable, except C<PERL_CCFLAGS>, which gets appended.
713 845
714=back 846=back
715 847
716=head4 Variables you probably I<do not want> to override 848=head4 Variables you probably I<do not want> to override
717 849
718=over 4 850=over 4
851
852=item C<MAKE>
853
854The make command to use - default is C<make>.
719 855
720=item C<MKBUNDLE> 856=item C<MKBUNDLE>
721 857
722Where F<staticperl> writes the C<mkbundle> command to 858Where F<staticperl> writes the C<mkbundle> command to
723(default: F<$STATICPERL/mkbundle>). 859(default: F<$STATICPERL/mkbundle>).
1051 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" 1187 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1052 done 1188 done
1053 } 1189 }
1054 1190
1055This mostly gains space when linking staticaly, as the functions will 1191This mostly gains space when linking staticaly, as the functions will
1056liekly not be linked in. The gain for dynamically-linked binaries is 1192likely not be linked in. The gain for dynamically-linked binaries is
1057smaller. 1193smaller.
1058 1194
1059Also, this leaves C<gethostbyname> in - not only is it actually used 1195Also, this leaves C<gethostbyname> in - not only is it actually used
1060often, the L<Socket> module also exposes it, so leaving it out usually 1196often, the L<Socket> module also exposes it, so leaving it out usually
1061gains little. Why Socket exposes a C function that is in the core already 1197gains little. Why Socket exposes a C function that is in the core already

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines