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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC vs.
Revision 1.60 by root, Fri Oct 16 01:52:08 2015 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 100 modules, all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one standalone 500kb file
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	staticperl help # print the embedded documentation	7	staticperl help # print the embedded documentation
8	staticperl fetch # fetch and unpack perl sources	8	staticperl fetch # fetch and unpack perl sources
9	staticperl configure # fetch and then configure perl	9	staticperl configure # fetch and then configure perl
10	staticperl build # configure and then build perl	10	staticperl build # configure and then build perl
11	staticperl install # build and then install perl	11	staticperl install # build and then install perl
12	staticperl clean # clean most intermediate files (restart at configure)	12	staticperl clean # clean most intermediate files (restart at configure)
13	staticperl distclean # delete everything installed by this script	13	staticperl distclean # delete everything installed by this script
		14	staticperl perl ... # invoke the perlinterpreter
14	staticperl cpan # invoke CPAN shell	15	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	16	staticperl instsrc path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	17	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	18	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	19	staticperl mkperl <bundle-args...> # see documentation
19	staticperl mkapp appname <bundle-args...> # see documentation	20	staticperl mkapp appname <bundle-args...> # see documentation
20		21
21	Typical Examples:	22	Typical Examples:
22		23
23	staticperl install # fetch, configure, build and install perl	24	staticperl install # fetch, configure, build and install perl
24	staticperl cpan # run interactive cpan shell	25	staticperl cpan # run interactive cpan shell
25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	26	staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	27	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27	# build a perl with the above modules linked in	28	# build a perl with the above modules linked in
28	staticperl mkapp myapp --boot mainprog mymodules	29	staticperl mkapp myapp --boot mainprog mymodules
29	# build a binary "myapp" from mainprog and mymodules	30	# build a binary "myapp" from mainprog and mymodules
30		31
38	file that contains perl interpreter, libc, all the modules you need, all	39	file that contains perl interpreter, libc, all the modules you need, all
39	the libraries you need and of course your actual program.	40	the libraries you need and of course your actual program.
40		41
41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary	42	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,	43	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
43	Coro and so on. Or any other choice of modules.	44	Coro and so on. Or any other choice of modules (and some other size :).
44		45
45	To see how this turns out, you can try out smallperl and bigperl, two	46	To see how this turns out, you can try out smallperl and bigperl, two
46	pre-built static and compressed perl binaries with many and even more	47	pre-built static and compressed perl binaries with many and even more
47	modules: just follow the links at L<http://staticperl.schmorp.de/>.	48	modules: just follow the links at L<http://staticperl.schmorp.de/>.
48		49
…		…
83	With F<staticperl>, the burden is mostly with the developer - only direct	84	With F<staticperl>, the burden is mostly with the developer - only direct
84	compile-time dependencies and L<AutoLoader> are handled automatically.	85	compile-time dependencies and L<AutoLoader> are handled automatically.
85	This means the modules to include often need to be tweaked manually.	86	This means the modules to include often need to be tweaked manually.
86		87
87	All this does not preclude more permissive modes to be implemented in	88	All this does not preclude more permissive modes to be implemented in
88	the future, but right now, you have to resolve state hidden dependencies	89	the future, but right now, you have to resolve hidden dependencies
89	manually.	90	manually.
90		91
91	=item * PAR works out of the box, F<staticperl> does not.	92	=item * PAR works out of the box, F<staticperl> does not.
92		93
93	Maintaining your own custom perl build can be a pain in the ass, and while	94	Maintaining your own custom perl build can be a pain in the ass, and while
…		…
139	with creating binaries and bundle files.	140	with creating binaries and bundle files.
140		141
141	=head2 PHASE 1 COMMANDS: INSTALLING PERL	142	=head2 PHASE 1 COMMANDS: INSTALLING PERL
142		143
143	The most important command is F<install>, which does basically	144	The most important command is F<install>, which does basically
144	everything. The default is to download and install perl 5.12.2 and a few	145	everything. The default is to download and install perl 5.12.3 and a few
145	modules required by F<staticperl> itself, but all this can (and should) be	146	modules required by F<staticperl> itself, but all this can (and should) be
146	changed - see L<CONFIGURATION>, below.	147	changed - see L<CONFIGURATION>, below.
147		148
148	The command	149	The command
149		150
…		…
186	=item F<staticperl install>	187	=item F<staticperl install>
187		188
188	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
189	installs the perl distribution, potentially after building it first.	190	installs the perl distribution, potentially after building it first.
190		191
		192	=item F<staticperl perl> [args...]
		193
		194	Invokes the compiled perl interpreter with the given args. Basically the
		195	same as starting perl directly (usually via F<~/.staticperl/bin/perl>),
		196	but beats typing the path sometimes.
		197
		198	Example: check that the Gtk2 module is installed and loadable.
		199
		200	staticperl perl -MGtk2 -e0
		201
191	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
192		203
193	Starts an interactive CPAN shell that you can use to install further	204	Starts an interactive CPAN shell that you can use to install further
194	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
195	no magic is involved: you could just as well run it manually via	206	no magic is involved: you could just as well run it manually via
196	F<~/.staticperl/perl/bin/cpan>.	207	F<~/.staticperl/perl/bin/cpan>, except that F<staticperl> additionally
		208	sets the environment variable C<$PERL> to the path of the perl
		209	interpreter, which is handy in subshells.
197		210
198	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
199		212
200	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
201		214
…		…
252		265
253	# first make sure we have perl and the required modules	266	# first make sure we have perl and the required modules
254	staticperl instcpan AnyEvent::HTTPD	267	staticperl instcpan AnyEvent::HTTPD
255		268
256	# now build the perl	269	# now build the perl
257	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	270	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258	-MAnyEvent::HTTPD -MURI::http \	271	-MAnyEvent::HTTPD -MURI::http \
259	--add 'eg/httpd httpd.pm'	272	--add 'eg/httpd httpd.pm'
260		273
261	# finally, invoke it	274	# finally, invoke it
262	./perl -Mhttpd	275	./perl -Mhttpd
…		…
278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	291	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
279		292
280	# run it	293	# run it
281	./app	294	./app
282		295
		296	Here are the three phase 2 commands:
		297
		298	=over 4
		299
		300	=item F<staticperl mkbundle> args...
		301
		302	The "default" bundle command - it interprets the given bundle options and
		303	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		304	files, useful for embedding.
		305
		306	=item F<staticperl mkperl> args...
		307
		308	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		309	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		310	links a new perl interpreter that embeds the created bundle, then deletes
		311	all intermediate files.
		312
		313	=item F<staticperl mkapp> filename args...
		314
		315	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		316	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		317	and links a new standalone application that simply initialises the perl
		318	interpreter.
		319
		320	The difference to F<staticperl mkperl> is that the standalone application
		321	does not act like a perl interpreter would - in fact, by default it would
		322	just do nothing and exit immediately, so you should specify some code to
		323	be executed via the F<--boot> option.
		324
		325	=back
		326
283	=head3 OPTION PROCESSING	327	=head3 OPTION PROCESSING
284		328
285	All options can be given as arguments on the command line (typically	329	All options can be given as arguments on the command line (typically
286	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	330	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
287	specifying a lot of modules can make the command line very cumbersome,	331	specifying a lot of options can make the command line very long and
288	you can put all long options into a "bundle specification file" (with or	332	unwieldy, you can put all long options into a "bundle specification file"
289	without C<--> prefix) and specify this bundle file instead.	333	(one option per line, with or without C<--> prefix) and specify this
		334	bundle file instead.
290		335
291	For example, the command given earlier could also look like this:	336	For example, the command given earlier to link a new F<perl> could also
		337	look like this:
292		338
293	staticperl mkperl httpd.bundle	339	staticperl mkperl httpd.bundle
294		340
295	And all options could be in F<httpd.bundle>:	341	With all options stored in the F<httpd.bundle> file (one option per line,
296		342	everything after the option is an argument):
		343
297	use "Config_heavy.pl"	344	use "Config_heavy.pl"
298	use AnyEvent::Impl::Perl	345	use AnyEvent::Impl::Perl
299	use AnyEvent::HTTPD	346	use AnyEvent::HTTPD
300	use URI::http	347	use URI::http
301	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
302		349
303	All options that specify modules or files to be added are processed in the	350	All options that specify modules or files to be added are processed in the
304	order given on the command line (that affects the C<--use> and C<--eval>	351	order given on the command line.
305	options at the moment).
306		352
307	=head3 PACKAGE SELECTION WORKFLOW	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
308		354
309	F<staticperl mkbundle> has a number of options to control package	355	F<staticperl mkbundle> works by first assembling a list of candidate
310	selection. This section describes how they interact with each other. Also,	356	files and modules to include, then filtering them by include/exclude
311	since I am still a newbie w.r.t. these issues, maybe future versions of	357	patterns. The remaining modules (together with their direct dependencies,
312	F<staticperl> will change this, so watch out :)	358	such as link libraries and L<AutoLoader> files) are then converted into
		359	bundle files suitable for embedding. F<staticperl mkbundle> can then
		360	optionally build a new perl interpreter or a standalone application.
313		361
314	The idiom "in order" means "in order that they are specified on the
315	commandline". If you use a bundle specification file, then the options
316	will be processed as if they were given in place of the bundle file name.
317
318	=over 4	362	=over 4
319		363
320	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	364	=item Step 0: Generic argument processing.
321	C<--incglob> options, in order.
322		365
323	In addition, C<--use> and C<--eval> dependencies will be added when the	366	The following options influence F<staticperl mkbundle> itself.
324	options are processed.
325		367
326	=item 2. apply all C<--include> and C<--exclude> options, in order.
327
328	All this step does is potentially reduce the number of files already
329	selected or found in phase 1.
330
331	=item 3. find all modules (== F<.pm> files), gather their static archives
332	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
333	extra libraries they need for linking (F<extralibs.ld>) and optionally
334	evaluate any F<.packlist> files.
335
336	This step is required to link against XS extensions and also adds files
337	required for L<AutoLoader> to do it's job.
338
339	=back
340
341	After this, all the files selected for bundling will be read and processed
342	(stripped), the bundle files will be written, and optionally a new F<perl>
343	or application binary will be linked.
344
345	=head3 MKBUNDLE OPTIONS
346
347	=over 4	368	=over 4
348		369
349	=item --verbose \| -v	370	=item C<--verbose> \| C<-v>
350		371
351	Increases the verbosity level by one (the default is C<1>).	372	Increases the verbosity level by one (the default is C<1>).
352		373
353	=item --quiet \| -q	374	=item C<--quiet> \| C<-q>
354		375
355	Decreases the verbosity level by one.	376	Decreases the verbosity level by one.
356		377
		378	=item any other argument
		379
		380	Any other argument is interpreted as a bundle specification file, which
		381	supports all options (without extra quoting), one option per line, in the
		382	format C<option> or C<option argument>. They will effectively be expanded
		383	and processed as if they were directly written on the command line, in
		384	place of the file name.
		385
		386	=back
		387
		388	=item Step 1: gather candidate files and modules
		389
		390	In this step, modules, perl libraries (F<.pl> files) and other files are
		391	selected for inclusion in the bundle. The relevant options are executed
		392	in order (this makes a difference mostly for C<--eval>, which can rely on
		393	earlier C<--use> options to have been executed).
		394
		395	=over 4
		396
		397	=item C<--use> F<module> \| C<-M>F<module>
		398
		399	Include the named module or perl library and trace direct
		400	dependencies. This is done by loading the module in a subprocess and
		401	tracing which other modules and files it actually loads.
		402
		403	Example: include AnyEvent and AnyEvent::Impl::Perl.
		404
		405	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		406
		407	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
		408	maybe other weirdly named files. To support this, the C<--use> option
		409	actually tries to do what you mean, depending on the string you specify:
		410
		411	=over 4
		412
		413	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		414	F<Coro::Mysql>.
		415
		416	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		417	assumes that it is a normal module name. It will create a new package and
		418	evaluate a C<use module> in it, i.e. it will load the package and do a
		419	default import.
		420
		421	The import step is done because many modules trigger more dependencies
		422	when something is imported than without.
		423
		424	=item anything that contains F</> or F<.> characters,
		425	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		426
		427	The string will be quoted and passed to require, as if you used C<require
		428	$module>. Nothing will be imported.
		429
		430	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		431
		432	If you enclose the name into single or double quotes, then the quotes will
		433	be removed and the resulting string will be passed to require. This syntax
		434	is form compatibility with older versions of staticperl and should not be
		435	used anymore.
		436
		437	=back
		438
		439	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		440	symbols), and once via C<require>, not importing any symbols. The first
		441	form is preferred as many modules load some extra dependencies when asked
		442	to export symbols.
		443
		444	staticperl mkbundle -MAnyEvent::Socket # use + import
		445	staticperl mkbundle -MAnyEvent/Socket.pm # require only
		446
		447	Example: include the required files for F<perl -V> to work in all its
		448	glory (F<Config.pm> is included automatically by the dependency tracker).
		449
		450	# shell command
		451	staticperl mkbundle -MConfig_heavy.pl
		452
		453	# bundle specification file
		454	use Config_heavy.pl
		455
		456	The C<-M>module syntax is included as a convenience that might be easier
		457	to remember than C<--use> - it's the same switch as perl itself uses
		458	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		459	not. Sigh.
		460
		461	=item C<--eval> "perl code" \| C<-e> "perl code"
		462
		463	Sometimes it is easier (or necessary) to specify dependencies using perl
		464	code, or maybe one of the modules you use need a special use statement. In
		465	that case, you can use C<--eval> to execute some perl snippet or set some
		466	variables or whatever you need. All files C<require>'d or C<use>'d while
		467	executing the snippet are included in the final bundle.
		468
		469	Keep in mind that F<mkbundle> will not import any symbols from the modules
		470	named by the C<--use> option, so do not expect the symbols from modules
		471	you C<--use>'d earlier on the command line to be available.
		472
		473	Example: force L<AnyEvent> to detect a backend and therefore include it
		474	in the final bundle.
		475
		476	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		477
		478	# or like this
		479	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		480
		481	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		482	and also include this in the final bundle, to be executed automatically
		483	when the interpreter is initialised.
		484
		485	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		486
		487	=item C<--boot> F<filename>
		488
		489	Include the given file in the bundle and arrange for it to be
		490	executed (using C<require>) before the main program when the new perl
		491	is initialised. This can be used to modify C<@INC> or do similar
		492	modifications before the perl interpreter executes scripts given on the
		493	command line (or via C<-e>). This works even in an embedded interpreter -
		494	the file will be executed during interpreter initialisation in that case.
		495
		496	=item C<--incglob> pattern
		497
		498	This goes through all standard library directories and tries to match any
		499	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		500	a file matches, it is added. The pattern is matched against the full path
		501	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		502
		503	This is very useful to include "everything":
		504
		505	--incglob '*'
		506
		507	It is also useful for including perl libraries, or trees of those, such as
		508	the unicode database files needed by some perl built-ins, the regex engine
		509	and other modules.
		510
		511	--incglob '/unicore/**.pl'
		512
		513	=item C<--add> F<file> \| C<--add> "F<file> alias"
		514
		515	Adds the given (perl) file into the bundle (and optionally call it
		516	"alias"). The F<file> is either an absolute path or a path relative to the
		517	current directory. If an alias is specified, then this is the name it will
		518	use for C<@INC> searches, otherwise the path F<file> will be used as the
		519	internal name.
		520
		521	This switch is used to include extra files into the bundle.
		522
		523	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		524	when creating the bundle.
		525
		526	staticperl mkperl --add "httpd httpd.pm"
		527
		528	# can be accessed via "use httpd"
		529
		530	Example: add a file F<initcode> from the current directory.
		531
		532	staticperl mkperl --add 'initcode &initcode'
		533
		534	# can be accessed via "do '&initcode'"
		535
		536	Example: add local files as extra modules in the bundle.
		537
		538	# specification file
		539	add file1 myfiles/file1.pm
		540	add file2 myfiles/file2.pm
		541	add file3 myfiles/file3.pl
		542
		543	# then later, in perl, use
		544	use myfiles::file1;
		545	require myfiles::file2;
		546	my $res = do "myfiles/file3.pl";
		547
		548	=item C<--addbin> F<file> \| C<--addbin> "F<file> alias"
		549
		550	Just like C<--add>, except that it treats the file as binary and adds it
		551	without any postprocessing (perl files might get stripped to reduce their
		552	size).
		553
		554	If you specify an alias you should probably add a C</> prefix to avoid
		555	clashing with embedded perl files (whose paths never start with C</>),
		556	and/or use a special directory prefix, such as C</res/name>.
		557
		558	You can later get a copy of these files by calling C<static::find
		559	"alias">.
		560
		561	An alternative way to embed binary files is to convert them to perl and
		562	use C<do> to get the contents - this method is a bit cumbersome, but works
		563	both inside and outside of a staticperl bundle, without extra ado:
		564
		565	# a "binary" file, call it "bindata.pl"
		566	<<'SOME_MARKER'
		567	binary data NOT containing SOME_MARKER
		568	SOME_MARKER
		569
		570	# load the binary
		571	chomp (my $data = do "bindata.pl");
		572
		573	=item C<--allow-dynamic>
		574
		575	By default, when F<mkbundle> hits a dynamic perl extension (e.g. a F<.so>
		576	or F<.dll> file), it will stop with a fatal error.
		577
		578	When this option is enabled, F<mkbundle> packages the shared
		579	object into the bundle instead, with a prefix of F<!>
		580	(e.g. F<!auto/List/Util/Util.so>). What you do with that is currently up
		581	to you, F<staticperl> has no special support for this at the moment, apart
		582	from working around the lack of availability of F<PerlIO::scalar> while
		583	bootstrapping, at a speed cost.
		584
		585	One way to deal with this is to write all files starting with F<!> into
		586	some directory and then C<unshift> that path onto C<@INC>.
		587
		588	#TODO: example
		589
		590	=back
		591
		592	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		593
		594	After all candidate files and modules are added, they are I<filtered>
		595	by a combination of C<--include> and C<--exclude> patterns (there is an
		596	implicit C<--include *> at the end, so if no filters are specified, all
		597	files are included).
		598
		599	All that this step does is potentially reduce the number of files that are
		600	to be included - no new files are added during this step.
		601
		602	=over 4
		603
		604	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		605
		606	These specify an include or exclude pattern to be applied to the candidate
		607	file list. An include makes sure that the given files will be part of the
		608	resulting file set, an exclude will exclude remaining files. The patterns
		609	are "extended glob patterns" (see below).
		610
		611	The patterns are applied "in order" - files included via earlier
		612	C<--include> specifications cannot be removed by any following
		613	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		614	cannot be added by any following C<--include>.
		615
		616	For example, to include everything except C<Devel> modules, but still
		617	include F<Devel::PPPort>, you could use this:
		618
		619	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		620
		621	=back
		622
		623	=item Step 3: add any extra or "hidden" dependencies.
		624
		625	F<staticperl> currently knows about three extra types of depdendencies
		626	that are added automatically. Only one (F<.packlist> files) is currently
		627	optional and can be influenced, the others are always included:
		628
		629	=over 4
		630
		631	=item C<--usepacklists>
		632
		633	Read F<.packlist> files for each distribution that happens to match a
		634	module name you specified. Sounds weird, and it is, so expect semantics to
		635	change somehow in the future.
		636
		637	The idea is that most CPAN distributions have a F<.pm> file that matches
		638	the name of the distribution (which is rather reasonable after all).
		639
		640	If this switch is enabled, then if any of the F<.pm> files that have been
		641	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		642	and F<.ix> files installed by this distribution are also included.
		643
		644	For example, using this switch, when the L<URI> module is specified, then
		645	all L<URI> submodules that have been installed via the CPAN distribution
		646	are included as well, so you don't have to manually specify them.
		647
		648	=item L<AutoLoader> splitfiles
		649
		650	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		651	are split into separate F<.al> files, and an index (F<.ix>) file contains
		652	the prototypes.
		653
		654	Both F<.ix> and F<.al> files will be detected automatically and added to
		655	the bundle.
		656
		657	=item link libraries (F<.a> files)
		658
		659	Modules using XS (or any other non-perl language extension compiled at
		660	installation time) will have a static archive (typically F<.a>). These
		661	will automatically be added to the linker options in F<bundle.ldopts>.
		662
		663	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		664	will warn about it - obviously this shouldn't happen unless you use
		665	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		666	use dynamic loading.
		667
		668	=item extra libraries (F<extralibs.ld>)
		669
		670	Some modules need linking against external libraries - these are found in
		671	F<extralibs.ld> and added to F<bundle.ldopts>.
		672
		673	=back
		674
		675	=item Step 4: write bundle files and optionally link a program
		676
		677	At this point, the select files will be read, processed (stripped) and
		678	finally the bundle files get written to disk, and F<staticperl mkbundle>
		679	is normally finished. Optionally, it can go a step further and either link
		680	a new F<perl> binary with all selected modules and files inside, or build
		681	a standalone application.
		682
		683	Both the contents of the bundle files and any extra linking is controlled
		684	by these options:
		685
		686	=over 4
		687
357	=item --strip none\|pod\|ppi	688	=item C<--strip> C<none>\|C<pod>\|C<ppi>
358		689
359	Specify the stripping method applied to reduce the file of the perl	690	Specify the stripping method applied to reduce the file of the perl
360	sources included.	691	sources included.
361		692
362	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	693	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
…		…
373	Last not least, if you need accurate line numbers in error messages,	704	Last not least, if you need accurate line numbers in error messages,
374	or in the unlikely case where C<pod> is too slow, or some module gets	705	or in the unlikely case where C<pod> is too slow, or some module gets
375	mistreated, you can specify C<none> to not mangle included perl sources in	706	mistreated, you can specify C<none> to not mangle included perl sources in
376	any way.	707	any way.
377		708
378	=item --perl	709	=item C<--perl>
379		710
380	After writing out the bundle files, try to link a new perl interpreter. It	711	After writing out the bundle files, try to link a new perl interpreter. It
381	will be called F<perl> and will be left in the current working	712	will be called F<perl> and will be left in the current working
382	directory. The bundle files will be removed.	713	directory. The bundle files will be removed.
383		714
384	This switch is automatically used when F<staticperl> is invoked with the	715	This switch is automatically used when F<staticperl> is invoked with the
385	C<mkperl> command (instead of C<mkbundle>):	716	C<mkperl> command instead of C<mkbundle>.
386		717
387	# build a new ./perl with only common::sense in it - very small :)	718	Example: build a new F<./perl> binary with only L<common::sense> inside -
		719	it will be even smaller than the standard perl interpreter as none of the
		720	modules of the base distribution (such as L<Fcntl>) will be included.
		721
388	staticperl mkperl -Mcommon::sense	722	staticperl mkperl -Mcommon::sense
389		723
390	=item --app name	724	=item C<--app> F<name>
391		725
392	After writing out the bundle files, try to link a new standalone	726	After writing out the bundle files, try to link a new standalone
393	program. It will be called C<name>, and the bundle files get removed after	727	program. It will be called C<name>, and the bundle files get removed after
394	linking it.	728	linking it.
		729
		730	This switch is automatically used when F<staticperl> is invoked with the
		731	C<mkapp> command instead of C<mkbundle>.
395		732
396	The difference to the (mutually exclusive) C<--perl> option is that the	733	The difference to the (mutually exclusive) C<--perl> option is that the
397	binary created by this option will not try to act as a perl interpreter -	734	binary created by this option will not try to act as a perl interpreter -
398	instead it will simply initialise the perl interpreter, clean it up and	735	instead it will simply initialise the perl interpreter, clean it up and
399	exit.	736	exit.
400		737
401	This switch is automatically used when F<staticperl> is invoked with the	738	This means that, by default, it will do nothing but burn a few CPU cycles
402	C<mkapp> command (instead of C<mkbundle>):
403
404	To let it do something useful you I<must> add some boot code, e.g. with	739	- for it to do something useful you I<must> add some boot code, e.g. with
405	the C<--boot> option.	740	the C<--boot> option.
406		741
407	Example: create a standalone perl binary that will execute F<appfile> when	742	Example: create a standalone perl binary called F<./myexe> that will
408	it is started.	743	execute F<appfile> when it is started.
409		744
410	staticperl mkbundle --app myexe --boot appfile	745	staticperl mkbundle --app myexe --boot appfile
411		746
412	=item --use module \| -Mmodule	747	=item C<--ignore-env>
413		748
414	Include the named module and all direct dependencies. This is done by	749	Generates extra code to unset some environment variables before
415	C<require>'ing the module in a subprocess and tracing which other modules	750	initialising/running perl. Perl supports a lot of environment variables
416	and files it actually loads. If the module uses L<AutoLoader>, then all	751	that might alter execution in ways that might be undesirablre for
417	splitfiles will be included as well.	752	standalone applications, and this option removes those known to cause
		753	trouble.
418		754
419	Example: include AnyEvent and AnyEvent::Impl::Perl.	755	Specifically, these are removed:
420		756
421	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	757	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause undesirable
		758	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		759	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		760	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
422		761
423	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	762	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
424	maybe other weirdly named files. To do that, you need to quote the name in	763	startup code used by F<staticperl> overrides C<@INC> in all cases.
425	single or double quotes. When given on the command line, you probably need
426	to quote once more to avoid your shell interpreting it. Common cases that
427	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
428		764
429	Example: include the required files for F<perl -V> to work in all its	765	This option will not make your program more secure (unless you are
430	glory (F<Config.pm> is included automatically by this).	766	running with elevated privileges), but it will reduce the surprise effect
		767	when a user has these environment variables set and doesn't expect your
		768	standalone program to act like a perl interpreter.
431		769
432	# bourne shell
433	staticperl mkbundle --use '"Config_heavy.pl"'
434
435	# bundle specification file
436	use "Config_heavy.pl"
437
438	The C<-Mmodule> syntax is included as an alias that might be easier to
439	remember than C<use>. Or maybe it confuses people. Time will tell. Or
440	maybe not. Argh.
441
442	=item --eval "perl code" \| -e "perl code"
443
444	Sometimes it is easier (or necessary) to specify dependencies using perl
445	code, or maybe one of the modules you use need a special use statement. In
446	that case, you can use C<eval> to execute some perl snippet or set some
447	variables or whatever you need. All files C<require>'d or C<use>'d in the
448	script are included in the final bundle.
449
450	Keep in mind that F<mkbundle> will only C<require> the modules named
451	by the C<--use> option, so do not expect the symbols from modules you
452	C<--use>'d earlier on the command line to be available.
453
454	Example: force L<AnyEvent> to detect a backend and therefore include it
455	in the final bundle.
456
457	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
458
459	# or like this
460	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
461
462	Example: use a separate "bootstrap" script that C<use>'s lots of modules
463	and include this in the final bundle, to be executed automatically.
464
465	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
466
467	=item --boot filename
468
469	Include the given file in the bundle and arrange for it to be executed
470	(using a C<require>) before anything else when the new perl is
471	initialised. This can be used to modify C<@INC> or anything else before
472	the perl interpreter executes scripts given on the command line (or via
473	C<-e>). This works even in an embedded interpreter.
474
475	=item --usepacklist
476
477	Read F<.packlist> files for each distribution that happens to match a
478	module name you specified. Sounds weird, and it is, so expect semantics to
479	change somehow in the future.
480
481	The idea is that most CPAN distributions have a F<.pm> file that matches
482	the name of the distribution (which is rather reasonable after all).
483
484	If this switch is enabled, then if any of the F<.pm> files that have been
485	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
486	and F<.ix> files installed by this distribution are also included.
487
488	For example, using this switch, when the L<URI> module is specified, then
489	all L<URI> submodules that have been installed via the CPAN distribution
490	are included as well, so you don't have to manually specify them.
491
492	=item --incglob pattern
493
494	This goes through all library directories and tries to match any F<.pm>
495	and F<.pl> files against the extended glob pattern (see below). If a file
496	matches, it is added. This switch will automatically detect L<AutoLoader>
497	files and the required link libraries for XS modules, but it will I<not>
498	scan the file for dependencies (at the moment).
499
500	This is mainly useful to include "everything":
501
502	--incglob '*'
503
504	Or to include perl libraries, or trees of those, such as the unicode
505	database files needed by many other modules:
506
507	--incglob '/unicore/**.pl'
508
509	=item --add file \| --add "file alias"
510
511	Adds the given (perl) file into the bundle (and optionally call it
512	"alias"). This is useful to include any custom files into the bundle.
513
514	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
515
516	staticperl mkperl --add "httpd httpd.pm"
517
518	It is also a great way to add any custom modules:
519
520	# specification file
521	add file1 myfiles/file1
522	add file2 myfiles/file2
523	add file3 myfiles/file3
524
525	=item --binadd file \| --add "file alias"
526
527	Just like C<--add>, except that it treats the file as binary and adds it
528	without any processing.
529
530	You should probably add a C</> prefix to avoid clashing with embedded
531	perl files (whose paths do not start with C</>), and/or use a special
532	directory, such as C</res/name>.
533
534	You can later get a copy of these files by calling C<staticperl::find
535	"alias">.
536
537	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
538
539	These two options define an include/exclude filter that is used after all
540	files selected by the other options have been found. Each include/exclude
541	is applied to all files found so far - an include makes sure that the
542	given files will be part of the resulting file set, an exclude will
543	exclude files. The patterns are "extended glob patterns" (see below).
544
545	For example, to include everything, except C<Devel> modules, but still
546	include F<Devel::PPPort>, you could use this:
547
548	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
549
550	=item --static	770	=item C<--static>
551		771
552	When C<--perl> is also given, link statically instead of dynamically. The	772	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		773	supported by the OS) executable will be created. This is not immensely
		774	useful when just creating the bundle files, but is most useful when
		775	linking a binary with the C<--perl> or C<--app> options.
		776
553	default is to link the new perl interpreter fully dynamic (that means all	777	The default is to link the new binary dynamically (that means all perl
554	perl modules are linked statically, but all external libraries are still	778	modules are linked statically, but all external libraries are still
555	referenced dynamically).	779	referenced dynamically).
556		780
557	Keep in mind that Solaris doesn't support static linking at all, and	781	Keep in mind that Solaris doesn't support static linking at all, and
558	systems based on GNU libc don't really support it in a usable fashion	782	systems based on GNU libc don't really support it in a very usable
559	either. Try uClibc if you want to create fully statically linked	783	fashion either. Try uClibc if you want to create fully statically linked
560	executables, or try the C<--staticlibs> option to link only some libraries	784	executables, or try the C<--staticlib> option to link only some libraries
561	statically.	785	statically.
562		786
563	=item --staticlib libname	787	=item C<--staticlib> libname
564		788
565	When not linking fully statically, this option allows you to link specific	789	When not linking fully statically, this option allows you to link specific
566	libraries statically. What it does is simply replace all occurances of	790	libraries statically. What it does is simply replace all occurrences of
567	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	791	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
568	option.	792	option.
569		793
570	This will have no effect unless the library is actually linked against,	794	This will have no effect unless the library is actually linked against,
571	specifically, C<--staticlib> will not link against the named library	795	specifically, C<--staticlib> will not link against the named library
572	unless it would be linked against anyway.	796	unless it would be linked against anyway.
573		797
574	Example: link libcrypt statically into the binary.	798	Example: link libcrypt statically into the final binary.
575		799
576	staticperl mkperl -MIO::AIO --staticlib crypt	800	staticperl mkperl -MIO::AIO --staticlib crypt
577		801
578	# ldopts might nwo contain:	802	# ldopts might now contain:
579	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	803	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
580		804
581	=item any other argument	805	=back
582
583	Any other argument is interpreted as a bundle specification file, which
584	supports most long options (without extra quoting), one option per line.
585		806
586	=back	807	=back
587		808
588	=head3 EXTENDED GLOB PATTERNS	809	=head3 EXTENDED GLOB PATTERNS
589		810
…		…
603	=item Patterns not starting with F</> will be anchored at the end of the path.	824	=item Patterns not starting with F</> will be anchored at the end of the path.
604		825
605	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	826	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
606	hierarchy, but not any directories of the same name.	827	hierarchy, but not any directories of the same name.
607		828
608	=item A F<*> matches any single component.	829	=item A F<*> matches anything within a single path component.
609		830
610	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	831	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
611	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	832	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
612	will not match slashes.	833	will not match slashes.
613		834
…		…
680	=item C<STATICPERL>	901	=item C<STATICPERL>
681		902
682	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
683	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
684		905
		906	=item C<DLCACHE>
		907
		908	The path to a directory (will be created if it doesn't exist) where
		909	downloaded perl sources are being cached, to avoid downloading them
		910	again. The default is empty, which means there is no cache.
		911
		912	=item C<PERL_VERSION>
		913
		914	The perl version to install - C<5.12.5> is a good choice for small builds,
		915	but C<5.8.9> is also a good choice (5.8.9 is much smaller than 5.12.5), if
		916	it builds on your system.
		917
		918	You can also set this variable to the full URL of a tarball (F<.tar>,
		919	F<.tar.gz>, F<.tar.bz2>, F<.tar.lzma> or F<.tar.xz>).
		920
		921	The default is currently
		922	F<http://stableperl.schmorp.de/dist/latest.tar.gz>, i.e. the latest
		923	stableperl release.
		924
685	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	925	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
686		926
687	Usually set to C<1> to make modules "less inquisitive" during their	927	Usually set to C<1> to make modules "less inquisitive" during their
688	installation, you can set any environment variable you want - some modules	928	installation. You can set (and export!) any environment variable you want
689	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	929	- some modules (such as L<Coro> or L<EV>) use environment variables for
690		930	further tweaking.
691	=item C<PERL_VERSION>
692
693	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
694	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
695	about as big as 5.12.2).
696		931
697	=item C<PERL_PREFIX>	932	=item C<PERL_PREFIX>
698		933
699	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	934	The directory where perl gets installed (default: F<$STATICPERL/perl>),
700	i.e. where the F<bin> and F<lib> subdirectories will end up.	935	i.e. where the F<bin> and F<lib> subdirectories will end up. Previous
		936	contents will be removed on installation.
701		937
702	=item C<PERL_CONFIGURE>	938	=item C<PERL_CONFIGURE>
703		939
704	Additional Configure options - these are simply passed to the perl	940	Additional Configure options - these are simply passed to the perl
705	Configure script. For example, if you wanted to enable dynamic loading,	941	Configure script. For example, if you wanted to enable dynamic loading,
…		…
721	F<~/.staticperlrc> to override them.	957	F<~/.staticperlrc> to override them.
722		958
723	Most of the variables override (or modify) the corresponding F<Configure>	959	Most of the variables override (or modify) the corresponding F<Configure>
724	variable, except C<PERL_CCFLAGS>, which gets appended.	960	variable, except C<PERL_CCFLAGS>, which gets appended.
725		961
		962	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		963	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		964	all) systems.
		965
		966	For other compilers or more customised optimisation settings, you need to
		967	adjust these, e.g. in your F<~/.staticperlrc>.
		968
		969	With gcc on x86 and amd64, you can get more space-savings by using:
		970
		971	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		972	-mno-inline-stringops-dynamically -mno-align-stringops
		973
		974	And on x86 and pentium3 and newer (basically everything you might ever
		975	want to run on), adding these is even better for space-savings (use
		976	-mtune=core2 or something newer for much faster code, too):
		977
		978	-fomit-frame-pointer -march=pentium3 -mtune=i386
		979
726	=back	980	=back
727		981
728	=head4 Variables you probably I<do not want> to override	982	=head4 Variables you probably I<do not want> to override
729		983
730	=over 4	984	=over 4
…		…
748	=head3 OVERRIDABLE HOOKS	1002	=head3 OVERRIDABLE HOOKS
749		1003
750	In addition to environment variables, it is possible to provide some	1004	In addition to environment variables, it is possible to provide some
751	shell functions that are called at specific times. To provide your own	1005	shell functions that are called at specific times. To provide your own
752	commands, just define the corresponding function.	1006	commands, just define the corresponding function.
		1007
		1008	The actual order in which hooks are invoked during a full install
		1009	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1010	C<postbuild>, C<postinstall>.
753		1011
754	Example: install extra modules from CPAN and from some directories	1012	Example: install extra modules from CPAN and from some directories
755	at F<staticperl install> time.	1013	at F<staticperl install> time.
756		1014
757	postinstall() {	1015	postinstall() {
…		…
764		1022
765	=over 4	1023	=over 4
766		1024
767	=item preconfigure	1025	=item preconfigure
768		1026
769	Called just before running F<./Configur> in the perl source	1027	Called just before running F<./Configure> in the perl source
770	directory. Current working directory is the perl source directory.	1028	directory. Current working directory is the perl source directory.
771		1029
772	This can be used to set any C<PERL_xxx> variables, which might be costly	1030	This can be used to set any C<PERL_xxx> variables, which might be costly
773	to compute.	1031	to compute.
774		1032
		1033	=item patchconfig
		1034
		1035	Called after running F<./Configure> in the perl source directory to create
		1036	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1037	config. Current working directory is the perl source directory.
		1038
		1039	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1040
775	=item postconfigure	1041	=item postconfigure
776		1042
777	Called after configuring, but before building perl. Current working	1043	Called after configuring, but before building perl. Current working
778	directory is the perl source directory.	1044	directory is the perl source directory.
779
780	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
781	or do any other modifications.
782		1045
783	=item postbuild	1046	=item postbuild
784		1047
785	Called after building, but before installing perl. Current working	1048	Called after building, but before installing perl. Current working
786	directory is the perl source directory.	1049	directory is the perl source directory.
…		…
824	A header file that contains the prototypes of the few symbols "exported"	1087	A header file that contains the prototypes of the few symbols "exported"
825	by bundle.c, and also exposes the perl headers to the application.	1088	by bundle.c, and also exposes the perl headers to the application.
826		1089
827	=over 4	1090	=over 4
828		1091
829	=item staticperl_init ()	1092	=item staticperl_init (xs_init = 0)
830		1093
831	Initialises the perl interpreter. You can use the normal perl functions	1094	Initialises the perl interpreter. You can use the normal perl functions
832	after calling this function, for example, to define extra functions or	1095	after calling this function, for example, to define extra functions or
833	to load a .pm file that contains some initialisation code, or the main	1096	to load a .pm file that contains some initialisation code, or the main
834	program function:	1097	program function:
…		…
841	}	1104	}
842		1105
843	static void	1106	static void
844	run_myapp(void)	1107	run_myapp(void)
845	{	1108	{
846	staticperl_init ();	1109	staticperl_init (0);
847	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1110	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
848	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1111	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
849	}	1112	}
850		1113
		1114	When your bootcode already wants to access some XS functions at
		1115	compiletime, then you need to supply an C<xs_init> function pointer that
		1116	is called as soon as perl is initialised enough to define XS functions,
		1117	but before the preamble code is executed:
		1118
		1119	static void
		1120	xs_init (pTHX)
		1121	{
		1122	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1123	}
		1124
		1125	static void
		1126	run_myapp(void)
		1127	{
		1128	staticperl_init (xs_init);
		1129	}
		1130
		1131	=item staticperl_cleanup ()
		1132
		1133	In the unlikely case that you want to destroy the perl interpreter, here
		1134	is the corresponding function.
		1135
851	=item staticperl_xs_init (pTHX)	1136	=item staticperl_xs_init (pTHX)
852		1137
853	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1138	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
854	which case you do not want to use C<staticperl_init> but call them on your	1139	which case you do not want to use C<staticperl_init> but call them on your
855	own.	1140	own.
856		1141
857	Then you need this function - either pass it directly as the C<xs_init>	1142	Then you need this function - either pass it directly as the C<xs_init>
858	function to C<perl_parse>, or call it from your own C<xs_init> function.	1143	function to C<perl_parse>, or call it as one of the first things from your
859		1144	own C<xs_init> function.
860	=item staticperl_cleanup ()
861
862	In the unlikely case that you want to destroy the perl interpreter, here
863	is the corresponding function.
864		1145
865	=item PerlInterpreter *staticperl	1146	=item PerlInterpreter *staticperl
866		1147
867	The perl interpreter pointer used by staticperl. Not normally so useful,	1148	The perl interpreter pointer used by staticperl. Not normally so useful,
868	but there it is.	1149	but there it is.
…		…
881		1162
882	=back	1163	=back
883		1164
884	=head1 RUNTIME FUNCTIONALITY	1165	=head1 RUNTIME FUNCTIONALITY
885		1166
886	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1167	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
887	are required to access the bundled perl sources, but might be useful for	1168	mostly related to the extra files bundled in the binary (the virtual
888	other purposes.	1169	filesystem). All of this data is statically compiled into the binary, and
		1170	accessing means copying it from a read-only section of your binary. Data
		1171	pages in this way is usually freed by the operating system, as it isn't
		1172	use more the onace.
		1173
		1174	=head2 VIRTUAL FILESYSTEM
		1175
		1176	Every bundle has a virtual filesystem. The only information stored in it
		1177	is the path and contents of each file that was bundled.
		1178
		1179	=head3 LAYOUT
		1180
		1181	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1182	reserved by F<staticperl>. They must only be used as described in this
		1183	section.
		1184
		1185	=over 4
		1186
		1187	=item !
		1188
		1189	All files that typically cannot be loaded from memory (such as dynamic
		1190	objects or shared libraries), but have to reside in the filesystem, are
		1191	prefixed with F<!>. Typically these files get written out to some
		1192	(semi-)temporary directory shortly after program startup, or before being
		1193	used.
		1194
		1195	=item !boot
		1196
		1197	The bootstrap file, if specified during bundling.
		1198
		1199	=item !auto/
		1200
		1201	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1202	are stored with an F<!auto/> prefix.
		1203
		1204	=item !lib/
		1205
		1206	External shared libraries are stored in this directory.
		1207
		1208	=item any letter
		1209
		1210	Any path starting with a letter is a perl library file. For example,
		1211	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1212	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1213
		1214	Obviously, module names shouldn't start with any other characters than
		1215	letters :)
		1216
		1217	=back
		1218
		1219	=head3 FUNCTIONS
		1220
		1221	=over 4
		1222
		1223	=item $file = static::find $path
		1224
		1225	Returns the data associated with the given C<$path>
		1226	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1227
		1228	Returns C<undef> if the file isn't embedded.
		1229
		1230	=item @paths = static::list
		1231
		1232	Returns the list of all paths embedded in this binary.
		1233
		1234	=back
		1235
		1236	=head2 EXTRA FEATURES
889		1237
890	In addition, for the embedded loading of perl files to work, F<staticperl>	1238	In addition, for the embedded loading of perl files to work, F<staticperl>
891	overrides the C<@INC> array.	1239	overrides the C<@INC> array.
892		1240
893	=over 4
894
895	=item $file = staticperl::find $path
896
897	Returns the data associated with the given C<$path>
898	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
899	the UNIX path relative to the perl library directory.
900
901	Returns C<undef> if the file isn't embedded.
902
903	=item @paths = staticperl::list
904
905	Returns the list of all paths embedded in this binary.
906
907	=back
908
909	=head1 FULLY STATIC BINARIES - BUILDROOT	1241	=head1 FULLY STATIC BINARIES - ALPINE LINUX
910		1242
911	To make truly static (Linux-) libraries, you might want to have a look at	1243	This section once contained a way to build fully static (including
912	buildroot (L<http://buildroot.uclibc.org/>).	1244	uClibc) binaries with buildroot. Unfortunately, buildroot no longer
		1245	supports a compiler, so I recommend using alpine linux instead
		1246	(L<http://alpinelinux.org/>). Get yourself a VM (e.g. with qemu), run an
		1247	older alpine linux verison in it (e.g. 2.4), copy staticperl inside and
		1248	use it.
913		1249
914	Buildroot is primarily meant to set up a cross-compile environment (which	1250	The reason you might want an older alpine linux is that uClibc can be
915	is not so useful as perl doesn't quite like cross compiles), but it can also compile	1251	quite dependent on kernel versions, so the newest version of alpine linux
916	a chroot environment where you can use F<staticperl>.	1252	might need a newer kernel then you might want for, if you plan to run your
917		1253	binaries on on other kernels.
918	To do so, download buildroot, and enable "Build options => development
919	files in target filesystem" and optionally "Build options => gcc
920	optimization level (optimize for size)". At the time of writing, I had
921	good experiences with GCC 4.4.x but not GCC 4.5.
922
923	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
924	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
925	doesn't decrease codesize much, but it makes the file much more
926	compressible.
927
928	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
929	no thread support). For Coro, it is highly recommended to switch to a
930	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
931	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
932	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
933	twice the address space needed for stacks).
934
935	If you use C<linuxthreads.old>, then you should also be aware that
936	uClibc shares C<errno> between all threads when statically linking. See
937	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
938	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
939
940	C<ccache> support is also recommended, especially if you want
941	to play around with buildroot options. Enabling the C<miniperl>
942	package will probably enable all options required for a successful
943	perl build. F<staticperl> itself additionally needs either C<wget>
944	(recommended, for CPAN) or C<curl>.
945
946	As for shells, busybox should provide all that is needed, but the default
947	busybox configuration doesn't include F<comm> which is needed by perl -
948	either make a custom busybox config, or compile coreutils.
949
950	For the latter route, you might find that bash has some bugs that keep
951	it from working properly in a chroot - either use dash (and link it to
952	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
953	built-in ash shell.
954
955	Finally, you need F</dev/null> inside the chroot for many scripts to work
956	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
957	both provide this.
958
959	After you have compiled and set up your buildroot target, you can copy
960	F<staticperl> from the C<App::Staticperl> distribution or from your
961	perl f<bin> directory (if you installed it) into the F<output/target>
962	filesystem, chroot inside and run it.
963		1254
964	=head1 RECIPES / SPECIFIC MODULES	1255	=head1 RECIPES / SPECIFIC MODULES
965		1256
966	This section contains some common(?) recipes and information about	1257	This section contains some common(?) recipes and information about
967	problems with some common modules or perl constructs that require extra	1258	problems with some common modules or perl constructs that require extra
…		…
975		1266
976	Some functionality in the utf8 module, such as swash handling (used	1267	Some functionality in the utf8 module, such as swash handling (used
977	for unicode character ranges in regexes) is implemented in the	1268	for unicode character ranges in regexes) is implemented in the
978	C<"utf8_heavy.pl"> library:	1269	C<"utf8_heavy.pl"> library:
979		1270
980	-M'"utf8_heavy.pl"'	1271	-Mutf8_heavy.pl
981		1272
982	Many Unicode properties in turn are defined in separate modules,	1273	Many Unicode properties in turn are defined in separate modules,
983	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1274	such as C<"unicore/Heavy.pl"> and more specific data tables such as
984	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1275	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
985	are big (7MB uncompressed, although F<staticperl> contains special	1276	are big (7MB uncompressed, although F<staticperl> contains special
986	handling for those files), so including them on demand by your application	1277	handling for those files), so including them on demand by your application
987	only might pay off.	1278	only might pay off.
988		1279
989	To simply include the whole unicode database, use:	1280	To simply include the whole unicode database, use:
990		1281
991	--incglob '/unicore/*.pl'	1282	--incglob '/unicore/**.pl'
992		1283
993	=item AnyEvent	1284	=item AnyEvent
994		1285
995	AnyEvent needs a backend implementation that it will load in a delayed	1286	AnyEvent needs a backend implementation that it will load in a delayed
996	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1287	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
1001		1292
1002	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1293	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1003	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1294	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1004	C<"AnyEvent/Util/uts46data.pl">.	1295	C<"AnyEvent/Util/uts46data.pl">.
1005		1296
1006	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1297	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1007	everything.	1298	everything.
		1299
		1300	=item Cairo
		1301
		1302	See Glib, same problem, same solution.
1008		1303
1009	=item Carp	1304	=item Carp
1010		1305
1011	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1306	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1012	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1307	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
1015		1310
1016	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1311	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1017	turn might need L<"Config_heavy.pl">. Including the latter gives you	1312	turn might need L<"Config_heavy.pl">. Including the latter gives you
1018	both.	1313	both.
1019		1314
		1315	=item Glib
		1316
		1317	Glib literally requires Glib to be installed already to build - it tries
		1318	to fake this by running Glib out of the build directory before being
		1319	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1320	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1321
		1322	=item Gtk2
		1323
		1324	See Pango, same problems, same solution.
		1325
		1326	=item Net::SSLeay
		1327
		1328	This module hasn't been significantly updated since OpenSSL is called
		1329	OpenSSL, and fails to properly link against dependent libraries, most
		1330	commonly, it forgets to specify -ldl when linking.
		1331
		1332	On GNU/Linux systems this usually goes undetected, as perl usually links
		1333	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1334	chance.
		1335
		1336	For static builds, you either have to configure -ldl manually, or you
		1337	cna use the following snippet in your C<postinstall> hook which patches
		1338	Net::SSLeay after installation, which happens to work most of the time:
		1339
		1340	postinstall() {
		1341	# first install it
		1342	instcpan Net::SSLeay
		1343	# then add -ldl for future linking
		1344	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1345	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1346	}
		1347
		1348	=item Pango
		1349
		1350	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1351	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1352	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1353
1020	=item Term::ReadLine::Perl	1354	=item Term::ReadLine::Perl
1021		1355
1022	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1356	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1023		1357
1024	=item URI	1358	=item URI
1025		1359
1026	URI implements schemes as separate modules - the generic URL scheme is	1360	URI implements schemes as separate modules - the generic URL scheme is
1027	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1361	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1028	you need to use any of these schemes, you should include these manually,	1362	you need to use any of these schemes, you should include these manually,
1029	or use C<--usepacklist>.	1363	or use C<--usepacklists>.
1030		1364
1031	=back	1365	=back
1032		1366
1033	=head2 RECIPES	1367	=head2 RECIPES
1034		1368
1035	=over 4	1369	=over 4
1036		1370
1037	=item Linking everything in	1371	=item Just link everything in
1038		1372
1039	To link just about everything installed in the perl library into a new	1373	To link just about everything installed in the perl library into a new
1040	perl, try this:	1374	perl, try this (the first time this runs it will take a long time, as a
		1375	lot of files need to be parsed):
1041		1376
1042	staticperl mkperl --strip ppi --incglob '*'	1377	staticperl mkperl -v --strip ppi --incglob '*'
1043		1378
		1379	If you don't mind the extra megabytes, this can be a very effective way of
		1380	creating bundles without having to worry about forgetting any modules.
		1381
		1382	You get even more useful variants of this method by first selecting
		1383	everything, and then excluding stuff you are reasonable sure not to need -
		1384	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1385
1044	=item Getting rid of netdb function	1386	=item Getting rid of netdb functions
1045		1387
1046	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1388	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1047	and so on) that few applications use. You can avoid compiling them in by	1389	and so on) that few applications use. You can avoid compiling them in by
1048	putting the following fragment into a C<preconfigure> hook:	1390	putting the following fragment into a C<preconfigure> hook:
1049		1391
…		…
1066	do	1408	do
1067	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1409	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1068	done	1410	done
1069	}	1411	}
1070		1412
1071	This mostly gains space when linking staticaly, as the functions will	1413	This mostly gains space when linking statically, as the functions will
1072	likely not be linked in. The gain for dynamically-linked binaries is	1414	likely not be linked in. The gain for dynamically-linked binaries is
1073	smaller.	1415	smaller.
1074		1416
1075	Also, this leaves C<gethostbyname> in - not only is it actually used	1417	Also, this leaves C<gethostbyname> in - not only is it actually used
1076	often, the L<Socket> module also exposes it, so leaving it out usually	1418	often, the L<Socket> module also exposes it, so leaving it out usually
1077	gains little. Why Socket exposes a C function that is in the core already	1419	gains little. Why Socket exposes a C function that is in the core already
1078	is anybody's guess.	1420	is anybody's guess.
1079		1421
1080	=back	1422	=back
1081		1423
		1424	=head1 ADDITIONAL RESOURCES
		1425
		1426	Some guy has made a repository on github
		1427	(L<https://github.com/gh0stwizard/staticperl-modules>) with some modules
		1428	patched to build with staticperl.
		1429
1082	=head1 AUTHOR	1430	=head1 AUTHOR
1083		1431
1084	Marc Lehmann <schmorp@schmorp.de>	1432	Marc Lehmann <schmorp@schmorp.de>
1085	http://software.schmorp.de/pkg/staticperl.html	1433	http://software.schmorp.de/pkg/staticperl.html
		1434

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC vs. Revision 1.60 by root, Fri Oct 16 01:52:08 2015 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC vs.
Revision 1.60 by root, Fri Oct 16 01:52:08 2015 UTC