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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC vs.
Revision 1.59 by root, Mon Jul 6 23:33:15 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
…		…
122	often as necessary.	123	often as necessary.
123		124
124	=head1 THE F<STATICPERL> SCRIPT	125	=head1 THE F<STATICPERL> SCRIPT
125		126
126	This module installs a script called F<staticperl> into your perl	127	This module installs a script called F<staticperl> into your perl
127	binary directory. The script is fully self-contained, and can be used	128	binary directory. The script is fully self-contained, and can be
128	without perl (for example, in an uClibc chroot environment). In fact,	129	used without perl (for example, in an uClibc chroot environment). In
129	it can be extracted from the C<App::Staticperl> distribution tarball as	130	fact, it can be extracted from the C<App::Staticperl> distribution
130	F<bin/staticperl>, without any installation.	131	tarball as F<bin/staticperl>, without any installation. The
		132	newest (possibly alpha) version can also be downloaded from
		133	L<http://staticperl.schmorp.de/staticperl>.
131		134
132	F<staticperl> interprets the first argument as a command to execute,	135	F<staticperl> interprets the first argument as a command to execute,
133	optionally followed by any parameters.	136	optionally followed by any parameters.
134		137
135	There are two command categories: the "phase 1" commands which deal with	138	There are two command categories: the "phase 1" commands which deal with
…		…
137	with creating binaries and bundle files.	140	with creating binaries and bundle files.
138		141
139	=head2 PHASE 1 COMMANDS: INSTALLING PERL	142	=head2 PHASE 1 COMMANDS: INSTALLING PERL
140		143
141	The most important command is F<install>, which does basically	144	The most important command is F<install>, which does basically
142	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
143	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
144	changed - see L<CONFIGURATION>, below.	147	changed - see L<CONFIGURATION>, below.
145		148
146	The command	149	The command
147		150
148	staticperl install	151	staticperl install
149		152
150	Is normally all you need: It installs the perl interpreter in	153	is normally all you need: It installs the perl interpreter in
151	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	154	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
152	perl interpreter if required.	155	perl interpreter if required.
153		156
154	Most of the following commands simply run one or more steps of this	157	Most of the following F<staticperl> subcommands simply run one or more
155	sequence.	158	steps of this sequence.
		159
		160	If it fails, then most commonly because the compiler options I selected
		161	are not supported by your compiler - either edit the F<staticperl> script
		162	yourself or create F<~/.staticperl> shell script where your set working
		163	C<PERL_CCFLAGS> etc. variables.
156		164
157	To force recompilation or reinstallation, you need to run F<staticperl	165	To force recompilation or reinstallation, you need to run F<staticperl
158	distclean> first.	166	distclean> first.
159		167
160	=over 4	168	=over 4
…		…
178		186
179	=item F<staticperl install>	187	=item F<staticperl install>
180		188
181	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
182	installs the perl distribution, potentially after building it first.	190	installs the perl distribution, potentially after building it first.
		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
183		201
184	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
185		203
186	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
187	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
188	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
189	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.
190		210
191	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
192		212
193	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
194		214
…		…
207		227
208	=item F<staticperl clean>	228	=item F<staticperl clean>
209		229
210	Deletes the perl source directory (and potentially cleans up other	230	Deletes the perl source directory (and potentially cleans up other
211	intermediate files). This can be used to clean up files only needed for	231	intermediate files). This can be used to clean up files only needed for
212	building perl, without removing the installed perl interpreter, or to	232	building perl, without removing the installed perl interpreter.
213	force a re-build from scratch.
214		233
215	At the moment, it doesn't delete downloaded tarballs.	234	At the moment, it doesn't delete downloaded tarballs.
		235
		236	The exact semantics of this command will probably change.
216		237
217	=item F<staticperl distclean>	238	=item F<staticperl distclean>
218		239
219	This wipes your complete F<~/.staticperl> directory. Be careful with this,	240	This wipes your complete F<~/.staticperl> directory. Be careful with this,
220	it nukes your perl download, perl sources, perl distribution and any	241	it nukes your perl download, perl sources, perl distribution and any
…		…
244		265
245	# first make sure we have perl and the required modules	266	# first make sure we have perl and the required modules
246	staticperl instcpan AnyEvent::HTTPD	267	staticperl instcpan AnyEvent::HTTPD
247		268
248	# now build the perl	269	# now build the perl
249	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	270	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
250	-MAnyEvent::HTTPD -MURI::http \	271	-MAnyEvent::HTTPD -MURI::http \
251	--add 'eg/httpd httpd.pm'	272	--add 'eg/httpd httpd.pm'
252		273
253	# finally, invoke it	274	# finally, invoke it
254	./perl -Mhttpd	275	./perl -Mhttpd
…		…
270	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	291	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
271		292
272	# run it	293	# run it
273	./app	294	./app
274		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
275	=head3 OPTION PROCESSING	327	=head3 OPTION PROCESSING
276		328
277	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
278	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
279	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
280	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"
281	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.
282		335
283	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:
284		338
285	staticperl mkperl httpd.bundle	339	staticperl mkperl httpd.bundle
286		340
287	And all options could be in F<httpd.bundle>:	341	With all options stored in the F<httpd.bundle> file (one option per line,
288		342	everything after the option is an argument):
		343
289	use "Config_heavy.pl"	344	use "Config_heavy.pl"
290	use AnyEvent::Impl::Perl	345	use AnyEvent::Impl::Perl
291	use AnyEvent::HTTPD	346	use AnyEvent::HTTPD
292	use URI::http	347	use URI::http
293	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
294		349
295	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
296	order given on the command line (that affects the C<--use> and C<--eval>	351	order given on the command line.
297	options at the moment).
298		352
299	=head3 PACKAGE SELECTION WORKFLOW	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
300		354
301	F<staticperl mkbundle> has a number of options to control package	355	F<staticperl mkbundle> works by first assembling a list of candidate
302	selection. This section describes how they interact with each other. Also,	356	files and modules to include, then filtering them by include/exclude
303	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,
304	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.
305		361
306	The idiom "in order" means "in order that they are specified on the
307	commandline". If you use a bundle specification file, then the options
308	will be processed as if they were given in place of the bundle file name.
309
310	=over 4	362	=over 4
311		363
312	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	364	=item Step 0: Generic argument processing.
313	C<--incglob> options, in order.
314		365
315	In addition, C<--use> and C<--eval> dependencies will be added when the	366	The following options influence F<staticperl mkbundle> itself.
316	options are processed.
317		367
318	=item 2. apply all C<--include> and C<--exclude> options, in order.
319
320	All this step does is potentially reduce the number of files already
321	selected or found in phase 1.
322
323	=item 3. find all modules (== F<.pm> files), gather their static archives
324	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
325	extra libraries they need for linking (F<extralibs.ld>) and optionally
326	evaluate any F<.packlist> files.
327
328	This step is required to link against XS extensions and also adds files
329	required for L<AutoLoader> to do it's job.
330
331	=back
332
333	After this, all the files selected for bundling will be read and processed
334	(stripped), the bundle files will be written, and optionally a new F<perl>
335	or application binary will be linked.
336
337	=head3 MKBUNDLE OPTIONS
338
339	=over 4	368	=over 4
340		369
341	=item --verbose \| -v	370	=item C<--verbose> \| C<-v>
342		371
343	Increases the verbosity level by one (the default is C<1>).	372	Increases the verbosity level by one (the default is C<1>).
344		373
345	=item --quiet \| -q	374	=item C<--quiet> \| C<-q>
346		375
347	Decreases the verbosity level by one.	376	Decreases the verbosity level by one.
348		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
349	=item --strip none\|pod\|ppi	688	=item C<--strip> C<none>\|C<pod>\|C<ppi>
350		689
351	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
352	sources included.	691	sources included.
353		692
354	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
…		…
365	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,
366	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
367	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
368	any way.	707	any way.
369		708
370	=item --perl	709	=item C<--perl>
371		710
372	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
373	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
374	directory. The bundle files will be removed.	713	directory. The bundle files will be removed.
375		714
376	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
377	C<mkperl> command (instead of C<mkbundle>):	716	C<mkperl> command instead of C<mkbundle>.
378		717
379	# 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
380	staticperl mkperl -Mcommon::sense	722	staticperl mkperl -Mcommon::sense
381		723
382	=item --app name	724	=item C<--app> F<name>
383		725
384	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
385	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
386	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>.
387		732
388	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
389	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 -
390	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
391	exit.	736	exit.
392		737
393	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
394	C<mkapp> command (instead of C<mkbundle>):
395
396	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
397	the C<--boot> option.	740	the C<--boot> option.
398		741
399	Example: create a standalone perl binary that will execute F<appfile> when	742	Example: create a standalone perl binary called F<./myexe> that will
400	it is started.	743	execute F<appfile> when it is started.
401		744
402	staticperl mkbundle --app myexe --boot appfile	745	staticperl mkbundle --app myexe --boot appfile
403		746
404	=item --use module \| -Mmodule	747	=item C<--ignore-env>
405		748
406	Include the named module and all direct dependencies. This is done by	749	Generates extra code to unset some environment variables before
407	C<require>'ing the module in a subprocess and tracing which other modules	750	initialising/running perl. Perl supports a lot of environment variables
408	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
409	splitfiles will be included as well.	752	standalone applications, and this option removes those known to cause
		753	trouble.
410		754
411	Example: include AnyEvent and AnyEvent::Impl::Perl.	755	Specifically, these are removed:
412		756
413	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.
414		761
415	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
416	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.
417	single or double quotes. When given on the command line, you probably need
418	to quote once more to avoid your shell interpreting it. Common cases that
419	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
420		764
421	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
422	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.
423		769
424	# bourne shell
425	staticperl mkbundle --use '"Config_heavy.pl"'
426
427	# bundle specification file
428	use "Config_heavy.pl"
429
430	The C<-Mmodule> syntax is included as an alias that might be easier to
431	remember than C<use>. Or maybe it confuses people. Time will tell. Or
432	maybe not. Argh.
433
434	=item --eval "perl code" \| -e "perl code"
435
436	Sometimes it is easier (or necessary) to specify dependencies using perl
437	code, or maybe one of the modules you use need a special use statement. In
438	that case, you can use C<eval> to execute some perl snippet or set some
439	variables or whatever you need. All files C<require>'d or C<use>'d in the
440	script are included in the final bundle.
441
442	Keep in mind that F<mkbundle> will only C<require> the modules named
443	by the C<--use> option, so do not expect the symbols from modules you
444	C<--use>'d earlier on the command line to be available.
445
446	Example: force L<AnyEvent> to detect a backend and therefore include it
447	in the final bundle.
448
449	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
450
451	# or like this
452	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
453
454	Example: use a separate "bootstrap" script that C<use>'s lots of modules
455	and include this in the final bundle, to be executed automatically.
456
457	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
458
459	=item --boot filename
460
461	Include the given file in the bundle and arrange for it to be executed
462	(using a C<require>) before anything else when the new perl is
463	initialised. This can be used to modify C<@INC> or anything else before
464	the perl interpreter executes scripts given on the command line (or via
465	C<-e>). This works even in an embedded interpreter.
466
467	=item --usepacklist
468
469	Read F<.packlist> files for each distribution that happens to match a
470	module name you specified. Sounds weird, and it is, so expect semantics to
471	change somehow in the future.
472
473	The idea is that most CPAN distributions have a F<.pm> file that matches
474	the name of the distribution (which is rather reasonable after all).
475
476	If this switch is enabled, then if any of the F<.pm> files that have been
477	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
478	and F<.ix> files installed by this distribution are also included.
479
480	For example, using this switch, when the L<URI> module is specified, then
481	all L<URI> submodules that have been installed via the CPAN distribution
482	are included as well, so you don't have to manually specify them.
483
484	=item --incglob pattern
485
486	This goes through all library directories and tries to match any F<.pm>
487	and F<.pl> files against the extended glob pattern (see below). If a file
488	matches, it is added. This switch will automatically detect L<AutoLoader>
489	files and the required link libraries for XS modules, but it will I<not>
490	scan the file for dependencies (at the moment).
491
492	This is mainly useful to include "everything":
493
494	--incglob '*'
495
496	Or to include perl libraries, or trees of those, such as the unicode
497	database files needed by many other modules:
498
499	--incglob '/unicore/**.pl'
500
501	=item --add file \| --add "file alias"
502
503	Adds the given (perl) file into the bundle (and optionally call it
504	"alias"). This is useful to include any custom files into the bundle.
505
506	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
507
508	staticperl mkperl --add "httpd httpd.pm"
509
510	It is also a great way to add any custom modules:
511
512	# specification file
513	add file1 myfiles/file1
514	add file2 myfiles/file2
515	add file3 myfiles/file3
516
517	=item --binadd file \| --add "file alias"
518
519	Just like C<--add>, except that it treats the file as binary and adds it
520	without any processing.
521
522	You should probably add a C</> prefix to avoid clashing with embedded
523	perl files (whose paths do not start with C</>), and/or use a special
524	directory, such as C</res/name>.
525
526	You can later get a copy of these files by calling C<staticperl::find
527	"alias">.
528
529	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
530
531	These two options define an include/exclude filter that is used after all
532	files selected by the other options have been found. Each include/exclude
533	is applied to all files found so far - an include makes sure that the
534	given files will be part of the resulting file set, an exclude will
535	exclude files. The patterns are "extended glob patterns" (see below).
536
537	For example, to include everything, except C<Devel> modules, but still
538	include F<Devel::PPPort>, you could use this:
539
540	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
541
542	=item --static	770	=item C<--static>
543		771
544	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
545	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
546	perl modules are linked statically, but all external libraries are still	778	modules are linked statically, but all external libraries are still
547	referenced dynamically).	779	referenced dynamically).
548		780
549	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
550	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
551	either. Try uClibc if you want to create fully statically linked	783	fashion either. Try uClibc if you want to create fully statically linked
552	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
553	statically.	785	statically.
554		786
555	=item --staticlib libname	787	=item C<--staticlib> libname
556		788
557	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
558	libraries statically. What it does is simply replace all occurances of	790	libraries statically. What it does is simply replace all occurrences of
559	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>
560	option.	792	option.
561		793
562	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,
563	specifically, C<--staticlib> will not link against the named library	795	specifically, C<--staticlib> will not link against the named library
564	unless it would be linked against anyway.	796	unless it would be linked against anyway.
565		797
566	Example: link libcrypt statically into the binary.	798	Example: link libcrypt statically into the final binary.
567		799
568	staticperl mkperl -MIO::AIO --staticlib crypt	800	staticperl mkperl -MIO::AIO --staticlib crypt
569		801
570	# ldopts might nwo contain:	802	# ldopts might now contain:
571	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	803	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
572		804
573	=item any other argument	805	=back
574
575	Any other argument is interpreted as a bundle specification file, which
576	supports most long options (without extra quoting), one option per line.
577		806
578	=back	807	=back
579		808
580	=head3 EXTENDED GLOB PATTERNS	809	=head3 EXTENDED GLOB PATTERNS
581		810
…		…
595	=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.
596		825
597	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
598	hierarchy, but not any directories of the same name.	827	hierarchy, but not any directories of the same name.
599		828
600	=item A F<*> matches any single component.	829	=item A F<*> matches anything within a single path component.
601		830
602	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
603	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<*>
604	will not match slashes.	833	will not match slashes.
605		834
…		…
672	=item C<STATICPERL>	901	=item C<STATICPERL>
673		902
674	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
675	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
676		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 - default is currently C<5.12.3>, but C<5.8.9>
		915	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
		916	about as big as 5.12.3).
		917
677	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	918	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
678		919
679	Usually set to C<1> to make modules "less inquisitive" during their	920	Usually set to C<1> to make modules "less inquisitive" during their
680	installation, you can set any environment variable you want - some modules	921	installation. You can set (and export!) any environment variable you want
681	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	922	- some modules (such as L<Coro> or L<EV>) use environment variables for
682		923	further tweaking.
683	=item C<PERL_VERSION>
684
685	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
686	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
687	about as big as 5.12.2).
688		924
689	=item C<PERL_PREFIX>	925	=item C<PERL_PREFIX>
690		926
691	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	927	The directory where perl gets installed (default: F<$STATICPERL/perl>),
692	i.e. where the F<bin> and F<lib> subdirectories will end up.	928	i.e. where the F<bin> and F<lib> subdirectories will end up. Previous
		929	contents will be removed on installation.
693		930
694	=item C<PERL_CONFIGURE>	931	=item C<PERL_CONFIGURE>
695		932
696	Additional Configure options - these are simply passed to the perl	933	Additional Configure options - these are simply passed to the perl
697	Configure script. For example, if you wanted to enable dynamic loading,	934	Configure script. For example, if you wanted to enable dynamic loading,
…		…
701		938
702	More commonly, you would either activate 64 bit integer support	939	More commonly, you would either activate 64 bit integer support
703	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	940	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
704	reduce filesize further.	941	reduce filesize further.
705		942
706	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	943	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
707		944
708	These flags are passed to perl's F<Configure> script, and are generally	945	These flags are passed to perl's F<Configure> script, and are generally
709	optimised for small size (at the cost of performance). Since they also	946	optimised for small size (at the cost of performance). Since they also
710	contain subtle workarounds around various build issues, changing these	947	contain subtle workarounds around various build issues, changing these
711	usually requires understanding their default values - best look at the top	948	usually requires understanding their default values - best look at
712	of the F<staticperl> script for more info on these.	949	the top of the F<staticperl> script for more info on these, and use a
		950	F<~/.staticperlrc> to override them.
		951
		952	Most of the variables override (or modify) the corresponding F<Configure>
		953	variable, except C<PERL_CCFLAGS>, which gets appended.
		954
		955	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		956	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		957	all) systems.
		958
		959	For other compilers or more customised optimisation settings, you need to
		960	adjust these, e.g. in your F<~/.staticperlrc>.
		961
		962	With gcc on x86 and amd64, you can get more space-savings by using:
		963
		964	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		965	-mno-inline-stringops-dynamically -mno-align-stringops
		966
		967	And on x86 and pentium3 and newer (basically everything you might ever
		968	want to run on), adding these is even better for space-savings (use
		969	-mtune=core2 or something newer for much faster code, too):
		970
		971	-fomit-frame-pointer -march=pentium3 -mtune=i386
713		972
714	=back	973	=back
715		974
716	=head4 Variables you probably I<do not want> to override	975	=head4 Variables you probably I<do not want> to override
717		976
718	=over 4	977	=over 4
		978
		979	=item C<MAKE>
		980
		981	The make command to use - default is C<make>.
719		982
720	=item C<MKBUNDLE>	983	=item C<MKBUNDLE>
721		984
722	Where F<staticperl> writes the C<mkbundle> command to	985	Where F<staticperl> writes the C<mkbundle> command to
723	(default: F<$STATICPERL/mkbundle>).	986	(default: F<$STATICPERL/mkbundle>).
…		…
732	=head3 OVERRIDABLE HOOKS	995	=head3 OVERRIDABLE HOOKS
733		996
734	In addition to environment variables, it is possible to provide some	997	In addition to environment variables, it is possible to provide some
735	shell functions that are called at specific times. To provide your own	998	shell functions that are called at specific times. To provide your own
736	commands, just define the corresponding function.	999	commands, just define the corresponding function.
		1000
		1001	The actual order in which hooks are invoked during a full install
		1002	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1003	C<postbuild>, C<postinstall>.
737		1004
738	Example: install extra modules from CPAN and from some directories	1005	Example: install extra modules from CPAN and from some directories
739	at F<staticperl install> time.	1006	at F<staticperl install> time.
740		1007
741	postinstall() {	1008	postinstall() {
…		…
748		1015
749	=over 4	1016	=over 4
750		1017
751	=item preconfigure	1018	=item preconfigure
752		1019
753	Called just before running F<./Configur> in the perl source	1020	Called just before running F<./Configure> in the perl source
754	directory. Current working directory is the perl source directory.	1021	directory. Current working directory is the perl source directory.
755		1022
756	This can be used to set any C<PERL_xxx> variables, which might be costly	1023	This can be used to set any C<PERL_xxx> variables, which might be costly
757	to compute.	1024	to compute.
758		1025
		1026	=item patchconfig
		1027
		1028	Called after running F<./Configure> in the perl source directory to create
		1029	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1030	config. Current working directory is the perl source directory.
		1031
		1032	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1033
759	=item postconfigure	1034	=item postconfigure
760		1035
761	Called after configuring, but before building perl. Current working	1036	Called after configuring, but before building perl. Current working
762	directory is the perl source directory.	1037	directory is the perl source directory.
763
764	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
765	or do any other modifications.
766		1038
767	=item postbuild	1039	=item postbuild
768		1040
769	Called after building, but before installing perl. Current working	1041	Called after building, but before installing perl. Current working
770	directory is the perl source directory.	1042	directory is the perl source directory.
…		…
808	A header file that contains the prototypes of the few symbols "exported"	1080	A header file that contains the prototypes of the few symbols "exported"
809	by bundle.c, and also exposes the perl headers to the application.	1081	by bundle.c, and also exposes the perl headers to the application.
810		1082
811	=over 4	1083	=over 4
812		1084
813	=item staticperl_init ()	1085	=item staticperl_init (xs_init = 0)
814		1086
815	Initialises the perl interpreter. You can use the normal perl functions	1087	Initialises the perl interpreter. You can use the normal perl functions
816	after calling this function, for example, to define extra functions or	1088	after calling this function, for example, to define extra functions or
817	to load a .pm file that contains some initialisation code, or the main	1089	to load a .pm file that contains some initialisation code, or the main
818	program function:	1090	program function:
…		…
825	}	1097	}
826		1098
827	static void	1099	static void
828	run_myapp(void)	1100	run_myapp(void)
829	{	1101	{
830	staticperl_init ();	1102	staticperl_init (0);
831	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1103	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
832	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1104	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
833	}	1105	}
834		1106
		1107	When your bootcode already wants to access some XS functions at
		1108	compiletime, then you need to supply an C<xs_init> function pointer that
		1109	is called as soon as perl is initialised enough to define XS functions,
		1110	but before the preamble code is executed:
		1111
		1112	static void
		1113	xs_init (pTHX)
		1114	{
		1115	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1116	}
		1117
		1118	static void
		1119	run_myapp(void)
		1120	{
		1121	staticperl_init (xs_init);
		1122	}
		1123
		1124	=item staticperl_cleanup ()
		1125
		1126	In the unlikely case that you want to destroy the perl interpreter, here
		1127	is the corresponding function.
		1128
835	=item staticperl_xs_init (pTHX)	1129	=item staticperl_xs_init (pTHX)
836		1130
837	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1131	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
838	which case you do not want to use C<staticperl_init> but call them on your	1132	which case you do not want to use C<staticperl_init> but call them on your
839	own.	1133	own.
840		1134
841	Then you need this function - either pass it directly as the C<xs_init>	1135	Then you need this function - either pass it directly as the C<xs_init>
842	function to C<perl_parse>, or call it from your own C<xs_init> function.	1136	function to C<perl_parse>, or call it as one of the first things from your
843		1137	own C<xs_init> function.
844	=item staticperl_cleanup ()
845
846	In the unlikely case that you want to destroy the perl interpreter, here
847	is the corresponding function.
848		1138
849	=item PerlInterpreter *staticperl	1139	=item PerlInterpreter *staticperl
850		1140
851	The perl interpreter pointer used by staticperl. Not normally so useful,	1141	The perl interpreter pointer used by staticperl. Not normally so useful,
852	but there it is.	1142	but there it is.
…		…
865		1155
866	=back	1156	=back
867		1157
868	=head1 RUNTIME FUNCTIONALITY	1158	=head1 RUNTIME FUNCTIONALITY
869		1159
870	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1160	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
871	are required to access the bundled perl sources, but might be useful for	1161	mostly related to the extra files bundled in the binary (the virtual
872	other purposes.	1162	filesystem). All of this data is statically compiled into the binary, and
		1163	accessing means copying it from a read-only section of your binary. Data
		1164	pages in this way is usually freed by the operating system, as it isn't
		1165	use more the onace.
		1166
		1167	=head2 VIRTUAL FILESYSTEM
		1168
		1169	Every bundle has a virtual filesystem. The only information stored in it
		1170	is the path and contents of each file that was bundled.
		1171
		1172	=head3 LAYOUT
		1173
		1174	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1175	reserved by F<staticperl>. They must only be used as described in this
		1176	section.
		1177
		1178	=over 4
		1179
		1180	=item !
		1181
		1182	All files that typically cannot be loaded from memory (such as dynamic
		1183	objects or shared libraries), but have to reside in the filesystem, are
		1184	prefixed with F<!>. Typically these files get written out to some
		1185	(semi-)temporary directory shortly after program startup, or before being
		1186	used.
		1187
		1188	=item !boot
		1189
		1190	The bootstrap file, if specified during bundling.
		1191
		1192	=item !auto/
		1193
		1194	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1195	are stored with an F<!auto/> prefix.
		1196
		1197	=item !lib/
		1198
		1199	External shared libraries are stored in this directory.
		1200
		1201	=item any letter
		1202
		1203	Any path starting with a letter is a perl library file. For example,
		1204	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1205	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1206
		1207	Obviously, module names shouldn't start with any other characters than
		1208	letters :)
		1209
		1210	=back
		1211
		1212	=head3 FUNCTIONS
		1213
		1214	=over 4
		1215
		1216	=item $file = static::find $path
		1217
		1218	Returns the data associated with the given C<$path>
		1219	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1220
		1221	Returns C<undef> if the file isn't embedded.
		1222
		1223	=item @paths = static::list
		1224
		1225	Returns the list of all paths embedded in this binary.
		1226
		1227	=back
		1228
		1229	=head2 EXTRA FEATURES
873		1230
874	In addition, for the embedded loading of perl files to work, F<staticperl>	1231	In addition, for the embedded loading of perl files to work, F<staticperl>
875	overrides the C<@INC> array.	1232	overrides the C<@INC> array.
876		1233
877	=over 4
878
879	=item $file = staticperl::find $path
880
881	Returns the data associated with the given C<$path>
882	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
883	the UNIX path relative to the perl library directory.
884
885	Returns C<undef> if the file isn't embedded.
886
887	=item @paths = staticperl::list
888
889	Returns the list of all paths embedded in this binary.
890
891	=back
892
893	=head1 FULLY STATIC BINARIES - BUILDROOT	1234	=head1 FULLY STATIC BINARIES - ALPINE LINUX
894		1235
895	To make truly static (Linux-) libraries, you might want to have a look at	1236	This section once contained a way to build fully static (including
896	buildroot (L<http://buildroot.uclibc.org/>).	1237	uClibc) binaries with buildroot. Unfortunately, buildroot no longer
		1238	supports a compiler, so I recommend using alpine linux instead
		1239	(L<http://alpinelinux.org/>). Get yourself a VM (e.g. with qemu), run an
		1240	older alpine linux verison in it (e.g. 2.4), copy staticperl inside and
		1241	use it.
897		1242
898	Buildroot is primarily meant to set up a cross-compile environment (which	1243	The reason you might want an older alpine linux is that uClibc can be
899	is not so useful as perl doesn't quite like cross compiles), but it can also compile	1244	quite dependent on kernel versions, so the newest version of alpine linux
900	a chroot environment where you can use F<staticperl>.	1245	might need a newer kernel then you might want for, if you plan to run your
901		1246	binaries on on other kernels.
902	To do so, download buildroot, and enable "Build options => development
903	files in target filesystem" and optionally "Build options => gcc
904	optimization level (optimize for size)". At the time of writing, I had
905	good experiences with GCC 4.4.x but not GCC 4.5.
906
907	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
908	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
909	doesn't decrease codesize much, but it makes the file much more
910	compressible.
911
912	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
913	no thread support). For Coro, it is highly recommended to switch to a
914	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
915	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
916	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
917	twice the address space needed for stacks).
918
919	If you use C<linuxthreads.old>, then you should also be aware that
920	uClibc shares C<errno> between all threads when statically linking. See
921	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
922	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
923
924	C<ccache> support is also recommended, especially if you want
925	to play around with buildroot options. Enabling the C<miniperl>
926	package will probably enable all options required for a successful
927	perl build. F<staticperl> itself additionally needs either C<wget>
928	(recommended, for CPAN) or C<curl>.
929
930	As for shells, busybox should provide all that is needed, but the default
931	busybox configuration doesn't include F<comm> which is needed by perl -
932	either make a custom busybox config, or compile coreutils.
933
934	For the latter route, you might find that bash has some bugs that keep
935	it from working properly in a chroot - either use dash (and link it to
936	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
937	built-in ash shell.
938
939	Finally, you need F</dev/null> inside the chroot for many scripts to work
940	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
941	both provide this.
942
943	After you have compiled and set up your buildroot target, you can copy
944	F<staticperl> from the C<App::Staticperl> distribution or from your
945	perl f<bin> directory (if you installed it) into the F<output/target>
946	filesystem, chroot inside and run it.
947		1247
948	=head1 RECIPES / SPECIFIC MODULES	1248	=head1 RECIPES / SPECIFIC MODULES
949		1249
950	This section contains some common(?) recipes and information about	1250	This section contains some common(?) recipes and information about
951	problems with some common modules or perl constructs that require extra	1251	problems with some common modules or perl constructs that require extra
…		…
959		1259
960	Some functionality in the utf8 module, such as swash handling (used	1260	Some functionality in the utf8 module, such as swash handling (used
961	for unicode character ranges in regexes) is implemented in the	1261	for unicode character ranges in regexes) is implemented in the
962	C<"utf8_heavy.pl"> library:	1262	C<"utf8_heavy.pl"> library:
963		1263
964	-M'"utf8_heavy.pl"'	1264	-Mutf8_heavy.pl
965		1265
966	Many Unicode properties in turn are defined in separate modules,	1266	Many Unicode properties in turn are defined in separate modules,
967	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1267	such as C<"unicore/Heavy.pl"> and more specific data tables such as
968	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1268	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
969	are big (7MB uncompressed, although F<staticperl> contains special	1269	are big (7MB uncompressed, although F<staticperl> contains special
970	handling for those files), so including them on demand by your application	1270	handling for those files), so including them on demand by your application
971	only might pay off.	1271	only might pay off.
972		1272
973	To simply include the whole unicode database, use:	1273	To simply include the whole unicode database, use:
974		1274
975	--incglob '/unicore/*.pl'	1275	--incglob '/unicore/**.pl'
976		1276
977	=item AnyEvent	1277	=item AnyEvent
978		1278
979	AnyEvent needs a backend implementation that it will load in a delayed	1279	AnyEvent needs a backend implementation that it will load in a delayed
980	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1280	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
985		1285
986	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1286	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
987	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1287	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
988	C<"AnyEvent/Util/uts46data.pl">.	1288	C<"AnyEvent/Util/uts46data.pl">.
989		1289
990	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1290	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
991	everything.	1291	everything.
		1292
		1293	=item Cairo
		1294
		1295	See Glib, same problem, same solution.
992		1296
993	=item Carp	1297	=item Carp
994		1298
995	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1299	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
996	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1300	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
999		1303
1000	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1304	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1001	turn might need L<"Config_heavy.pl">. Including the latter gives you	1305	turn might need L<"Config_heavy.pl">. Including the latter gives you
1002	both.	1306	both.
1003		1307
		1308	=item Glib
		1309
		1310	Glib literally requires Glib to be installed already to build - it tries
		1311	to fake this by running Glib out of the build directory before being
		1312	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1313	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1314
		1315	=item Gtk2
		1316
		1317	See Pango, same problems, same solution.
		1318
		1319	=item Net::SSLeay
		1320
		1321	This module hasn't been significantly updated since OpenSSL is called
		1322	OpenSSL, and fails to properly link against dependent libraries, most
		1323	commonly, it forgets to specify -ldl when linking.
		1324
		1325	On GNU/Linux systems this usually goes undetected, as perl usually links
		1326	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1327	chance.
		1328
		1329	For static builds, you either have to configure -ldl manually, or you
		1330	cna use the following snippet in your C<postinstall> hook which patches
		1331	Net::SSLeay after installation, which happens to work most of the time:
		1332
		1333	postinstall() {
		1334	# first install it
		1335	instcpan Net::SSLeay
		1336	# then add -ldl for future linking
		1337	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1338	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1339	}
		1340
		1341	=item Pango
		1342
		1343	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1344	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1345	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1346
1004	=item Term::ReadLine::Perl	1347	=item Term::ReadLine::Perl
1005		1348
1006	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1349	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1007		1350
1008	=item URI	1351	=item URI
1009		1352
1010	URI implements schemes as separate modules - the generic URL scheme is	1353	URI implements schemes as separate modules - the generic URL scheme is
1011	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1354	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1012	you need to use any of these schemes, you should include these manually,	1355	you need to use any of these schemes, you should include these manually,
1013	or use C<--usepacklist>.	1356	or use C<--usepacklists>.
1014		1357
1015	=back	1358	=back
1016		1359
1017	=head2 RECIPES	1360	=head2 RECIPES
1018		1361
1019	=over 4	1362	=over 4
1020		1363
1021	=item Linking everything in	1364	=item Just link everything in
1022		1365
1023	To link just about everything installed in the perl library into a new	1366	To link just about everything installed in the perl library into a new
1024	perl, try this:	1367	perl, try this (the first time this runs it will take a long time, as a
		1368	lot of files need to be parsed):
1025		1369
1026	staticperl mkperl --strip ppi --incglob '*'	1370	staticperl mkperl -v --strip ppi --incglob '*'
1027		1371
		1372	If you don't mind the extra megabytes, this can be a very effective way of
		1373	creating bundles without having to worry about forgetting any modules.
		1374
		1375	You get even more useful variants of this method by first selecting
		1376	everything, and then excluding stuff you are reasonable sure not to need -
		1377	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1378
1028	=item Getting rid of netdb function	1379	=item Getting rid of netdb functions
1029		1380
1030	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1381	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1031	and so on) that few applications use. You can avoid compiling them in by	1382	and so on) that few applications use. You can avoid compiling them in by
1032	putting the following fragment into a C<preconfigure> hook:	1383	putting the following fragment into a C<preconfigure> hook:
1033		1384
…		…
1050	do	1401	do
1051	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1402	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1052	done	1403	done
1053	}	1404	}
1054		1405
1055	This mostly gains space when linking staticaly, as the functions will	1406	This mostly gains space when linking statically, as the functions will
1056	liekly not be linked in. The gain for dynamically-linked binaries is	1407	likely not be linked in. The gain for dynamically-linked binaries is
1057	smaller.	1408	smaller.
1058		1409
1059	Also, this leaves C<gethostbyname> in - not only is it actually used	1410	Also, this leaves C<gethostbyname> in - not only is it actually used
1060	often, the L<Socket> module also exposes it, so leaving it out usually	1411	often, the L<Socket> module also exposes it, so leaving it out usually
1061	gains little. Why Socket exposes a C function that is in the core already	1412	gains little. Why Socket exposes a C function that is in the core already
1062	is anybody's guess.	1413	is anybody's guess.
1063		1414
1064	=back	1415	=back
1065		1416
		1417	=head1 ADDITIONAL RESOURCES
		1418
		1419	Some guy has made a repository on github
		1420	(L<https://github.com/gh0stwizard/staticperl-modules>) with some modules
		1421	patched to build with staticperl.
		1422
1066	=head1 AUTHOR	1423	=head1 AUTHOR
1067		1424
1068	Marc Lehmann <schmorp@schmorp.de>	1425	Marc Lehmann <schmorp@schmorp.de>
1069	http://software.schmorp.de/pkg/staticperl.html	1426	http://software.schmorp.de/pkg/staticperl.html
		1427

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC vs. Revision 1.59 by root, Mon Jul 6 23:33:15 2015 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC vs.
Revision 1.59 by root, Mon Jul 6 23:33:15 2015 UTC