[ViewVC] Diff of: cvs/App-Staticperl/staticperl.pod

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs.
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC

…		…
313		313
314	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
315		315
316	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
317	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
318	specifying a lot of modules can make the command line very cumbersome, you	318	specifying a lot of options can make the command line very long and
319	can put all long options into a "bundle specification file" (one option	319	unwieldy, you can put all long options into a "bundle specification file"
320	per line, with or without C<--> prefix) and specify this bundle file	320	(one option per line, with or without C<--> prefix) and specify this
321	instead.	321	bundle file instead.
322		322
323	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:
324		325
325	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
326		327
327	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
328		329	everything after the option is an argument):
		330
329	use "Config_heavy.pl"	331	use "Config_heavy.pl"
330	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
331	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
332	use URI::http	334	use URI::http
333	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
334		336
335	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
336	order given on the command line.	338	order given on the command line.
337		339
338	=head3 PACKAGE SELECTION WORKFLOW	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
339		341
340	F<staticperl mkbundle> has a number of options to control package	342	F<staticperl mkbundle> works by first assembling a list of candidate
341	selection. This section describes how they interact with each other. Also,	343	files and modules to include, then filtering them by include/exclude
342	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,
343	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.
344		348
345	The idiom "in order" means "in order that they are specified on the
346	commandline". If you use a bundle specification file, then the options
347	will be processed as if they were given in place of the bundle file name.
348
349	=over 4	349	=over 4
350		350
351	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	351	=item Step 0: Generic argument processing.
352	C<--incglob> options, in order.
353		352
354	In addition, C<--use> and C<--eval> dependencies will be added when the	353	The following options influence F<staticperl mkbundle> itself.
355	options are processed.
356		354
357	=item 2. apply all C<--include> and C<--exclude> options, in order.
358
359	All this step does is potentially reduce the number of files already
360	selected or found in phase 1.
361
362	=item 3. find all modules (== F<.pm> files), gather their static archives
363	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
364	extra libraries they need for linking (F<extralibs.ld>) and optionally
365	evaluate any F<.packlist> files.
366
367	This step is required to link against XS extensions and also adds files
368	required for L<AutoLoader> to do it's job.
369
370	=back
371
372	After this, all the files selected for bundling will be read and processed
373	(stripped), the bundle files will be written, and optionally a new F<perl>
374	or application binary will be linked.
375
376	=head3 MKBUNDLE OPTIONS
377
378	=over 4	355	=over 4
379		356
380	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
381		358
382	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
383		360
384	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
385		362
386	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
387		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
		473	the current directory. If an alias is specified, then this is the name it
		474	will use for C<@INC> searches, otherwise the 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	Example: add local files as extra modules in the bundle.
		485
		486	# specification file
		487	add file1 myfiles/file1.pm
		488	add file2 myfiles/file2.pm
		489	add file3 myfiles/file3.pl
		490
		491	# then later, in perl, use
		492	use myfiles::file1;
		493	require myfiles::file2;
		494	my $res = do "myfiles/file3.pl";
		495
		496	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		497
		498	Just like C<--add>, except that it treats the file as binary and adds it
		499	without any postprocessing (perl files might get stripped to reduce their
		500	size).
		501
		502	You should probably add a C</> prefix to avoid clashing with embedded perl
		503	files (whose paths do not start with C</>), and/or use a special directory
		504	prefix, such as C</res/name>.
		505
		506	You can later get a copy of these files by calling C<staticperl::find
		507	"alias">.
		508
		509	An alternative way to embed binary files is to convert them to perl and
		510	use C<do> to get the contents - this method is a bit cumbersome, but works
		511	both inside and outside of a staticperl bundle:
		512
		513	# a "binary" file, call it "bindata.pl"
		514	<<'SOME_MARKER'
		515	binary data NOT containing SOME_MARKER
		516	SOME_MARKER
		517
		518	# load the binary
		519	chomp (my $data = do "bindata.pl");
		520
		521	=back
		522
		523	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		524
		525	After all candidate files and modules are added, they are I<filtered>
		526	by a combination of C<--include> and C<--exclude> patterns (there is an
		527	implicit C<--include *> at the end, so if no filters are specified, all
		528	files are included).
		529
		530	All that this step does is potentially reduce the number of files that are
		531	to be included - no new files are added during this step.
		532
		533	=over 4
		534
		535	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		536
		537	These specify an include or exclude pattern to be applied to the candidate
		538	file list. An include makes sure that the given files will be part of the
		539	resulting file set, an exclude will exclude remaining files. The patterns
		540	are "extended glob patterns" (see below).
		541
		542	The patterns are applied "in order" - files included via earlier
		543	C<--include> specifications cannot be removed by any following
		544	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		545	cannot be added by any following C<--include>.
		546
		547	For example, to include everything except C<Devel> modules, but still
		548	include F<Devel::PPPort>, you could use this:
		549
		550	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		551
		552	=back
		553
		554	=item Step 3: add any extra or "hidden" dependencies.
		555
		556	F<staticperl> currently knows about three extra types of depdendencies
		557	that are added automatically. Only one (F<.packlist> files) is currently
		558	optional and can be influenced, the others are always included:
		559
		560	=over 4
		561
		562	=item C<--usepacklists>
		563
		564	Read F<.packlist> files for each distribution that happens to match a
		565	module name you specified. Sounds weird, and it is, so expect semantics to
		566	change somehow in the future.
		567
		568	The idea is that most CPAN distributions have a F<.pm> file that matches
		569	the name of the distribution (which is rather reasonable after all).
		570
		571	If this switch is enabled, then if any of the F<.pm> files that have been
		572	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		573	and F<.ix> files installed by this distribution are also included.
		574
		575	For example, using this switch, when the L<URI> module is specified, then
		576	all L<URI> submodules that have been installed via the CPAN distribution
		577	are included as well, so you don't have to manually specify them.
		578
		579	=item L<AutoLoader> splitfiles
		580
		581	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		582	are split into separate F<.al> files, and an index (F<.ix>) file contains
		583	the prototypes.
		584
		585	Both F<.ix> and F<.al> files will be detected automatically and added to
		586	the bundle.
		587
		588	=item link libraries (F<.a> files)
		589
		590	Modules using XS (or any other non-perl language extension compiled at
		591	installation time) will have a static archive (typically F<.a>). These
		592	will automatically be added to the linker options in F<bundle.ldopts>.
		593
		594	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		595	will warn about it - obviously this shouldn't happen unless you use
		596	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		597	use dynamic loading.
		598
		599	=item extra libraries (F<extralibs.ld>)
		600
		601	Some modules need linking against external libraries - these are found in
		602	F<extralibs.ld> and added to F<bundle.ldopts>.
		603
		604	=back
		605
		606	=item Step 4: write bundle files and optionally link a program
		607
		608	At this point, the select files will be read, processed (stripped) and
		609	finally the bundle files get written to disk, and F<staticperl mkbundle>
		610	is normally finished. Optionally, it can go a step further and either link
		611	a new F<perl> binary with all selected modules and files inside, or build
		612	a standalone application.
		613
		614	Both the contents of the bundle files and any extra linking is controlled
		615	by these options:
		616
		617	=over 4
		618
388	=item --strip none\|pod\|ppi	619	=item C<--strip> C<none>\|C<pod>\|C<ppi>
389		620
390	Specify the stripping method applied to reduce the file of the perl	621	Specify the stripping method applied to reduce the file of the perl
391	sources included.	622	sources included.
392		623
393	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	624	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
…		…
404	Last not least, if you need accurate line numbers in error messages,	635	Last not least, if you need accurate line numbers in error messages,
405	or in the unlikely case where C<pod> is too slow, or some module gets	636	or in the unlikely case where C<pod> is too slow, or some module gets
406	mistreated, you can specify C<none> to not mangle included perl sources in	637	mistreated, you can specify C<none> to not mangle included perl sources in
407	any way.	638	any way.
408		639
409	=item --perl	640	=item C<--perl>
410		641
411	After writing out the bundle files, try to link a new perl interpreter. It	642	After writing out the bundle files, try to link a new perl interpreter. It
412	will be called F<perl> and will be left in the current working	643	will be called F<perl> and will be left in the current working
413	directory. The bundle files will be removed.	644	directory. The bundle files will be removed.
414		645
415	This switch is automatically used when F<staticperl> is invoked with the	646	This switch is automatically used when F<staticperl> is invoked with the
416	C<mkperl> command (instead of C<mkbundle>):	647	C<mkperl> command instead of C<mkbundle>.
417		648
418	# build a new ./perl with only common::sense in it - very small :)	649	Example: build a new F<./perl> binary with only L<common::sense> inside -
		650	it will be even smaller than the standard perl interpreter as none of the
		651	modules of the base distribution (such as L<Fcntl>) will be included.
		652
419	staticperl mkperl -Mcommon::sense	653	staticperl mkperl -Mcommon::sense
420		654
421	=item --app name	655	=item C<--app> F<name>
422		656
423	After writing out the bundle files, try to link a new standalone	657	After writing out the bundle files, try to link a new standalone
424	program. It will be called C<name>, and the bundle files get removed after	658	program. It will be called C<name>, and the bundle files get removed after
425	linking it.	659	linking it.
		660
		661	This switch is automatically used when F<staticperl> is invoked with the
		662	C<mkapp> command instead of C<mkbundle>.
426		663
427	The difference to the (mutually exclusive) C<--perl> option is that the	664	The difference to the (mutually exclusive) C<--perl> option is that the
428	binary created by this option will not try to act as a perl interpreter -	665	binary created by this option will not try to act as a perl interpreter -
429	instead it will simply initialise the perl interpreter, clean it up and	666	instead it will simply initialise the perl interpreter, clean it up and
430	exit.	667	exit.
431		668
432	This switch is automatically used when F<staticperl> is invoked with the	669	This means that, by default, it will do nothing but burna few CPU cycles
433	C<mkapp> command (instead of C<mkbundle>):
434
435	To let it do something useful you I<must> add some boot code, e.g. with	670	- for it to do something useful you I<must> add some boot code, e.g. with
436	the C<--boot> option.	671	the C<--boot> option.
437		672
438	Example: create a standalone perl binary that will execute F<appfile> when	673	Example: create a standalone perl binary called F<./myexe> that will
439	it is started.	674	execute F<appfile> when it is started.
440		675
441	staticperl mkbundle --app myexe --boot appfile	676	staticperl mkbundle --app myexe --boot appfile
442		677
443	=item --use module \| -Mmodule
444
445	Include the named module and all direct dependencies. This is done by
446	C<require>'ing the module in a subprocess and tracing which other modules
447	and files it actually loads. If the module uses L<AutoLoader>, then all
448	splitfiles will be included as well.
449
450	Example: include AnyEvent and AnyEvent::Impl::Perl.
451
452	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
453
454	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
455	maybe other weirdly named files. To do that, you need to quote the name in
456	single or double quotes. When given on the command line, you probably need
457	to quote once more to avoid your shell interpreting it. Common cases that
458	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
459
460	Example: include the required files for F<perl -V> to work in all its
461	glory (F<Config.pm> is included automatically by this).
462
463	# bourne shell
464	staticperl mkbundle --use '"Config_heavy.pl"'
465
466	# bundle specification file
467	use "Config_heavy.pl"
468
469	The C<-Mmodule> syntax is included as an alias that might be easier to
470	remember than C<use>. Or maybe it confuses people. Time will tell. Or
471	maybe not. Argh.
472
473	=item --eval "perl code" \| -e "perl code"
474
475	Sometimes it is easier (or necessary) to specify dependencies using perl
476	code, or maybe one of the modules you use need a special use statement. In
477	that case, you can use C<eval> to execute some perl snippet or set some
478	variables or whatever you need. All files C<require>'d or C<use>'d in the
479	script are included in the final bundle.
480
481	Keep in mind that F<mkbundle> will only C<require> the modules named
482	by the C<--use> option, so do not expect the symbols from modules you
483	C<--use>'d earlier on the command line to be available.
484
485	Example: force L<AnyEvent> to detect a backend and therefore include it
486	in the final bundle.
487
488	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
489
490	# or like this
491	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
492
493	Example: use a separate "bootstrap" script that C<use>'s lots of modules
494	and include this in the final bundle, to be executed automatically.
495
496	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
497
498	=item --boot filename
499
500	Include the given file in the bundle and arrange for it to be executed
501	(using a C<require>) before anything else when the new perl is
502	initialised. This can be used to modify C<@INC> or anything else before
503	the perl interpreter executes scripts given on the command line (or via
504	C<-e>). This works even in an embedded interpreter.
505
506	=item --usepacklist
507
508	Read F<.packlist> files for each distribution that happens to match a
509	module name you specified. Sounds weird, and it is, so expect semantics to
510	change somehow in the future.
511
512	The idea is that most CPAN distributions have a F<.pm> file that matches
513	the name of the distribution (which is rather reasonable after all).
514
515	If this switch is enabled, then if any of the F<.pm> files that have been
516	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
517	and F<.ix> files installed by this distribution are also included.
518
519	For example, using this switch, when the L<URI> module is specified, then
520	all L<URI> submodules that have been installed via the CPAN distribution
521	are included as well, so you don't have to manually specify them.
522
523	=item --incglob pattern
524
525	This goes through all library directories and tries to match any F<.pm>
526	and F<.pl> files against the extended glob pattern (see below). If a file
527	matches, it is added. This switch will automatically detect L<AutoLoader>
528	files and the required link libraries for XS modules, but it will I<not>
529	scan the file for dependencies (at the moment).
530
531	This is mainly useful to include "everything":
532
533	--incglob '*'
534
535	Or to include perl libraries, or trees of those, such as the unicode
536	database files needed by many other modules:
537
538	--incglob '/unicore/**.pl'
539
540	=item --add file \| --add "file alias"
541
542	Adds the given (perl) file into the bundle (and optionally call it
543	"alias"). This is useful to include any custom files into the bundle.
544
545	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
546
547	staticperl mkperl --add "httpd httpd.pm"
548
549	It is also a great way to add any custom modules:
550
551	# specification file
552	add file1 myfiles/file1
553	add file2 myfiles/file2
554	add file3 myfiles/file3
555
556	=item --binadd file \| --add "file alias"
557
558	Just like C<--add>, except that it treats the file as binary and adds it
559	without any processing.
560
561	You should probably add a C</> prefix to avoid clashing with embedded
562	perl files (whose paths do not start with C</>), and/or use a special
563	directory, such as C</res/name>.
564
565	You can later get a copy of these files by calling C<staticperl::find
566	"alias">.
567
568	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
569
570	These two options define an include/exclude filter that is used after all
571	files selected by the other options have been found. Each include/exclude
572	is applied to all files found so far - an include makes sure that the
573	given files will be part of the resulting file set, an exclude will
574	exclude files. The patterns are "extended glob patterns" (see below).
575
576	For example, to include everything, except C<Devel> modules, but still
577	include F<Devel::PPPort>, you could use this:
578
579	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
580
581	=item --static	678	=item C<--static>
582		679
583	When C<--perl> is also given, link statically instead of dynamically. The	680	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		681	supported by the OS) executable will be created. This is not immensely
		682	useful when just creating the bundle files, but is most useful when
		683	linking a binary with the C<--perl> or C<--app> options.
		684
584	default is to link the new perl interpreter fully dynamic (that means all	685	The default is to link the new binary dynamically (that means all perl
585	perl modules are linked statically, but all external libraries are still	686	modules are linked statically, but all external libraries are still
586	referenced dynamically).	687	referenced dynamically).
587		688
588	Keep in mind that Solaris doesn't support static linking at all, and	689	Keep in mind that Solaris doesn't support static linking at all, and
589	systems based on GNU libc don't really support it in a usable fashion	690	systems based on GNU libc don't really support it in a very usable
590	either. Try uClibc if you want to create fully statically linked	691	fashion either. Try uClibc if you want to create fully statically linked
591	executables, or try the C<--staticlibs> option to link only some libraries	692	executables, or try the C<--staticlib> option to link only some libraries
592	statically.	693	statically.
593		694
594	=item --staticlib libname	695	=item C<--staticlib> libname
595		696
596	When not linking fully statically, this option allows you to link specific	697	When not linking fully statically, this option allows you to link specific
597	libraries statically. What it does is simply replace all occurances of	698	libraries statically. What it does is simply replace all occurrences of
598	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	699	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
599	option.	700	option.
600		701
601	This will have no effect unless the library is actually linked against,	702	This will have no effect unless the library is actually linked against,
602	specifically, C<--staticlib> will not link against the named library	703	specifically, C<--staticlib> will not link against the named library
603	unless it would be linked against anyway.	704	unless it would be linked against anyway.
604		705
605	Example: link libcrypt statically into the binary.	706	Example: link libcrypt statically into the final binary.
606		707
607	staticperl mkperl -MIO::AIO --staticlib crypt	708	staticperl mkperl -MIO::AIO --staticlib crypt
608		709
609	# ldopts might nwo contain:	710	# ldopts might now contain:
610	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	711	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
611		712
612	=item any other argument	713	=back
613
614	Any other argument is interpreted as a bundle specification file, which
615	supports most long options (without extra quoting), one option per line.
616		714
617	=back	715	=back
618		716
619	=head3 EXTENDED GLOB PATTERNS	717	=head3 EXTENDED GLOB PATTERNS
620		718
…		…
634	=item Patterns not starting with F</> will be anchored at the end of the path.	732	=item Patterns not starting with F</> will be anchored at the end of the path.
635		733
636	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	734	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
637	hierarchy, but not any directories of the same name.	735	hierarchy, but not any directories of the same name.
638		736
639	=item A F<*> matches any single component.	737	=item A F<*> matches anything within a single path component.
640		738
641	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	739	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
642	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	740	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
643	will not match slashes.	741	will not match slashes.
644		742
…		…
935		1033
936	Returns the list of all paths embedded in this binary.	1034	Returns the list of all paths embedded in this binary.
937		1035
938	=back	1036	=back
939		1037
940	=head1 FULLY STATIC BINARIES - BUILDROOT	1038	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
941		1039
942	To make truly static (Linux-) libraries, you might want to have a look at	1040	To make truly static (Linux-) libraries, you might want to have a look at
943	buildroot (L<http://buildroot.uclibc.org/>).	1041	buildroot (L<http://buildroot.uclibc.org/>).
944		1042
945	Buildroot is primarily meant to set up a cross-compile environment (which	1043	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
1017	handling for those files), so including them on demand by your application	1115	handling for those files), so including them on demand by your application
1018	only might pay off.	1116	only might pay off.
1019		1117
1020	To simply include the whole unicode database, use:	1118	To simply include the whole unicode database, use:
1021		1119
1022	--incglob '/unicore/*.pl'	1120	--incglob '/unicore/**.pl'
1023		1121
1024	=item AnyEvent	1122	=item AnyEvent
1025		1123
1026	AnyEvent needs a backend implementation that it will load in a delayed	1124	AnyEvent needs a backend implementation that it will load in a delayed
1027	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1125	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
1032		1130
1033	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1131	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1034	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1132	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1035	C<"AnyEvent/Util/uts46data.pl">.	1133	C<"AnyEvent/Util/uts46data.pl">.
1036		1134
1037	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1135	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1038	everything.	1136	everything.
1039		1137
1040	=item Carp	1138	=item Carp
1041		1139
1042	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1140	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
…		…
1048	turn might need L<"Config_heavy.pl">. Including the latter gives you	1146	turn might need L<"Config_heavy.pl">. Including the latter gives you
1049	both.	1147	both.
1050		1148
1051	=item Term::ReadLine::Perl	1149	=item Term::ReadLine::Perl
1052		1150
1053	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1151	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1054		1152
1055	=item URI	1153	=item URI
1056		1154
1057	URI implements schemes as separate modules - the generic URL scheme is	1155	URI implements schemes as separate modules - the generic URL scheme is
1058	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1156	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1059	you need to use any of these schemes, you should include these manually,	1157	you need to use any of these schemes, you should include these manually,
1060	or use C<--usepacklist>.	1158	or use C<--usepacklists>.
1061		1159
1062	=back	1160	=back
1063		1161
1064	=head2 RECIPES	1162	=head2 RECIPES
1065		1163
1066	=over 4	1164	=over 4
1067		1165
1068	=item Linking everything in	1166	=item Just link everything in
1069		1167
1070	To link just about everything installed in the perl library into a new	1168	To link just about everything installed in the perl library into a new
1071	perl, try this:	1169	perl, try this (the first time this runs it will take a long time, as a
		1170	lot of files need to be parsed):
1072		1171
1073	staticperl mkperl --strip ppi --incglob '*'	1172	staticperl mkperl -v --strip ppi --incglob '*'
1074		1173
		1174	If you don't mind the extra megabytes, this can be a very effective way of
		1175	creating bundles without having to worry about forgetting any modules.
		1176
		1177	You get even more useful variants of this method by first selecting
		1178	everything, and then excluding stuff you are reasonable sure not to need -
		1179	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1180
1075	=item Getting rid of netdb function	1181	=item Getting rid of netdb functions
1076		1182
1077	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1183	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1078	and so on) that few applications use. You can avoid compiling them in by	1184	and so on) that few applications use. You can avoid compiling them in by
1079	putting the following fragment into a C<preconfigure> hook:	1185	putting the following fragment into a C<preconfigure> hook:
1080		1186
…		…
1097	do	1203	do
1098	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1204	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1099	done	1205	done
1100	}	1206	}
1101		1207
1102	This mostly gains space when linking staticaly, as the functions will	1208	This mostly gains space when linking statically, as the functions will
1103	likely not be linked in. The gain for dynamically-linked binaries is	1209	likely not be linked in. The gain for dynamically-linked binaries is
1104	smaller.	1210	smaller.
1105		1211
1106	Also, this leaves C<gethostbyname> in - not only is it actually used	1212	Also, this leaves C<gethostbyname> in - not only is it actually used
1107	often, the L<Socket> module also exposes it, so leaving it out usually	1213	often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs. Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs.
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC