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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs.
Revision 1.65 by root, Mon Jul 31 21:04:06 2023 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
…		…
313		326
314	=head3 OPTION PROCESSING	327	=head3 OPTION PROCESSING
315		328
316	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
317	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
318	specifying a lot of modules can make the command line very cumbersome, you	331	specifying a lot of options can make the command line very long and
319	can put all long options into a "bundle specification file" (one option	332	unwieldy, you can put all long options into a "bundle specification file"
320	per line, with or without C<--> prefix) and specify this bundle file	333	(one option per line, with or without C<--> prefix) and specify this
321	instead.	334	bundle file instead.
322		335
323	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:
324		338
325	staticperl mkperl httpd.bundle	339	staticperl mkperl httpd.bundle
326		340
327	And all options could be in F<httpd.bundle>:	341	With all options stored in the F<httpd.bundle> file (one option per line,
328		342	everything after the option is an argument):
		343
329	use "Config_heavy.pl"	344	use "Config_heavy.pl"
330	use AnyEvent::Impl::Perl	345	use AnyEvent::Impl::Perl
331	use AnyEvent::HTTPD	346	use AnyEvent::HTTPD
332	use URI::http	347	use URI::http
333	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
334		349
335	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
336	order given on the command line.	351	order given on the command line.
337		352
338	=head3 PACKAGE SELECTION WORKFLOW	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
339		354
340	F<staticperl mkbundle> has a number of options to control package	355	F<staticperl mkbundle> works by first assembling a list of candidate
341	selection. This section describes how they interact with each other. Also,	356	files and modules to include, then filtering them by include/exclude
342	since I am still a newbie w.r.t. these issues, maybe future versions of	357	patterns. The remaining modules (together with their direct dependencies,
343	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.
344		361
345	The idiom "in order" means "in order that they are specified on the
346	commandline". If you use a bundle specification file, then the options
347	will be processed as if they were given in place of the bundle file name.
348
349	=over 4	362	=over 4
350		363
351	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	364	=item Step 0: Generic argument processing.
352	C<--incglob> options, in order.
353		365
354	In addition, C<--use> and C<--eval> dependencies will be added when the	366	The following options influence F<staticperl mkbundle> itself.
355	options are processed.
356		367
357	=item 2. apply all C<--include> and C<--exclude> options, in order.
358
359	All this step does is potentially reduce the number of files already
360	selected or found in phase 1.
361
362	=item 3. find all modules (== F<.pm> files), gather their static archives
363	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
364	extra libraries they need for linking (F<extralibs.ld>) and optionally
365	evaluate any F<.packlist> files.
366
367	This step is required to link against XS extensions and also adds files
368	required for L<AutoLoader> to do it's job.
369
370	=back
371
372	After this, all the files selected for bundling will be read and processed
373	(stripped), the bundle files will be written, and optionally a new F<perl>
374	or application binary will be linked.
375
376	=head3 MKBUNDLE OPTIONS
377
378	=over 4	368	=over 4
379		369
380	=item --verbose \| -v	370	=item C<--verbose> \| C<-v>
381		371
382	Increases the verbosity level by one (the default is C<1>).	372	Increases the verbosity level by one (the default is C<1>).
383		373
384	=item --quiet \| -q	374	=item C<--quiet> \| C<-q>
385		375
386	Decreases the verbosity level by one.	376	Decreases the verbosity level by one.
387		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
388	=item --strip none\|pod\|ppi	688	=item C<--strip> C<none>\|C<pod>\|C<ppi>
389		689
390	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
391	sources included.	691	sources included.
392		692
393	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
…		…
404	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,
405	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
406	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
407	any way.	707	any way.
408		708
409	=item --perl	709	=item C<--perl>
410		710
411	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
412	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
413	directory. The bundle files will be removed.	713	directory. The bundle files will be removed.
414		714
415	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
416	C<mkperl> command (instead of C<mkbundle>):	716	C<mkperl> command instead of C<mkbundle>.
417		717
418	# 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
419	staticperl mkperl -Mcommon::sense	722	staticperl mkperl -Mcommon::sense
420		723
421	=item --app name	724	=item C<--app> F<name>
422		725
423	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
424	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
425	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>.
426		732
427	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
428	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 -
429	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
430	exit.	736	exit.
431		737
432	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
433	C<mkapp> command (instead of C<mkbundle>):
434
435	To let it do something useful you I<must> add some boot code, e.g. with	739	- for it to do something useful you I<must> add some boot code, e.g. with
436	the C<--boot> option.	740	the C<--boot> option.
437		741
438	Example: create a standalone perl binary that will execute F<appfile> when	742	Example: create a standalone perl binary called F<./myexe> that will
439	it is started.	743	execute F<appfile> when it is started.
440		744
441	staticperl mkbundle --app myexe --boot appfile	745	staticperl mkbundle --app myexe --boot appfile
442		746
443	=item --use module \| -Mmodule	747	=item C<--ignore-env>
444		748
445	Include the named module and all direct dependencies. This is done by	749	Generates extra code to unset some environment variables before
446	C<require>'ing the module in a subprocess and tracing which other modules	750	initialising/running perl. Perl supports a lot of environment variables
447	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
448	splitfiles will be included as well.	752	standalone applications, and this option removes those known to cause
		753	trouble.
449		754
450	Example: include AnyEvent and AnyEvent::Impl::Perl.	755	Specifically, these are removed:
451		756
452	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.
453		761
454	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
455	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.
456	single or double quotes. When given on the command line, you probably need
457	to quote once more to avoid your shell interpreting it. Common cases that
458	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
459		764
460	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
461	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.
462		769
463	# bourne shell
464	staticperl mkbundle --use '"Config_heavy.pl"'
465
466	# bundle specification file
467	use "Config_heavy.pl"
468
469	The C<-Mmodule> syntax is included as an alias that might be easier to
470	remember than C<use>. Or maybe it confuses people. Time will tell. Or
471	maybe not. Argh.
472
473	=item --eval "perl code" \| -e "perl code"
474
475	Sometimes it is easier (or necessary) to specify dependencies using perl
476	code, or maybe one of the modules you use need a special use statement. In
477	that case, you can use C<eval> to execute some perl snippet or set some
478	variables or whatever you need. All files C<require>'d or C<use>'d in the
479	script are included in the final bundle.
480
481	Keep in mind that F<mkbundle> will only C<require> the modules named
482	by the C<--use> option, so do not expect the symbols from modules you
483	C<--use>'d earlier on the command line to be available.
484
485	Example: force L<AnyEvent> to detect a backend and therefore include it
486	in the final bundle.
487
488	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
489
490	# or like this
491	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
492
493	Example: use a separate "bootstrap" script that C<use>'s lots of modules
494	and include this in the final bundle, to be executed automatically.
495
496	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
497
498	=item --boot filename
499
500	Include the given file in the bundle and arrange for it to be executed
501	(using a C<require>) before anything else when the new perl is
502	initialised. This can be used to modify C<@INC> or anything else before
503	the perl interpreter executes scripts given on the command line (or via
504	C<-e>). This works even in an embedded interpreter.
505
506	=item --usepacklist
507
508	Read F<.packlist> files for each distribution that happens to match a
509	module name you specified. Sounds weird, and it is, so expect semantics to
510	change somehow in the future.
511
512	The idea is that most CPAN distributions have a F<.pm> file that matches
513	the name of the distribution (which is rather reasonable after all).
514
515	If this switch is enabled, then if any of the F<.pm> files that have been
516	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
517	and F<.ix> files installed by this distribution are also included.
518
519	For example, using this switch, when the L<URI> module is specified, then
520	all L<URI> submodules that have been installed via the CPAN distribution
521	are included as well, so you don't have to manually specify them.
522
523	=item --incglob pattern
524
525	This goes through all library directories and tries to match any F<.pm>
526	and F<.pl> files against the extended glob pattern (see below). If a file
527	matches, it is added. This switch will automatically detect L<AutoLoader>
528	files and the required link libraries for XS modules, but it will I<not>
529	scan the file for dependencies (at the moment).
530
531	This is mainly useful to include "everything":
532
533	--incglob '*'
534
535	Or to include perl libraries, or trees of those, such as the unicode
536	database files needed by many other modules:
537
538	--incglob '/unicore/**.pl'
539
540	=item --add file \| --add "file alias"
541
542	Adds the given (perl) file into the bundle (and optionally call it
543	"alias"). This is useful to include any custom files into the bundle.
544
545	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
546
547	staticperl mkperl --add "httpd httpd.pm"
548
549	It is also a great way to add any custom modules:
550
551	# specification file
552	add file1 myfiles/file1
553	add file2 myfiles/file2
554	add file3 myfiles/file3
555
556	=item --binadd file \| --add "file alias"
557
558	Just like C<--add>, except that it treats the file as binary and adds it
559	without any processing.
560
561	You should probably add a C</> prefix to avoid clashing with embedded
562	perl files (whose paths do not start with C</>), and/or use a special
563	directory, such as C</res/name>.
564
565	You can later get a copy of these files by calling C<staticperl::find
566	"alias">.
567
568	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
569
570	These two options define an include/exclude filter that is used after all
571	files selected by the other options have been found. Each include/exclude
572	is applied to all files found so far - an include makes sure that the
573	given files will be part of the resulting file set, an exclude will
574	exclude files. The patterns are "extended glob patterns" (see below).
575
576	For example, to include everything, except C<Devel> modules, but still
577	include F<Devel::PPPort>, you could use this:
578
579	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
580
581	=item --static	770	=item C<--static>
582		771
583	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
584	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
585	perl modules are linked statically, but all external libraries are still	778	modules are linked statically, but all external libraries are still
586	referenced dynamically).	779	referenced dynamically).
587		780
588	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
589	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
590	either. Try uClibc if you want to create fully statically linked	783	fashion either. Try uClibc if you want to create fully statically linked
591	executables, or try the C<--staticlibs> option to link only some libraries	784	executables, or try the C<--staticlib> option to link only some libraries
592	statically.	785	statically.
593		786
594	=item --staticlib libname	787	=item C<--staticlib> libname
595		788
596	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
597	libraries statically. What it does is simply replace all occurances of	790	libraries statically. What it does is simply replace all occurrences of
598	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>
599	option.	792	option.
600		793
601	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,
602	specifically, C<--staticlib> will not link against the named library	795	specifically, C<--staticlib> will not link against the named library
603	unless it would be linked against anyway.	796	unless it would be linked against anyway.
604		797
605	Example: link libcrypt statically into the binary.	798	Example: link libcrypt statically into the final binary.
606		799
607	staticperl mkperl -MIO::AIO --staticlib crypt	800	staticperl mkperl -MIO::AIO --staticlib crypt
608		801
609	# ldopts might nwo contain:	802	# ldopts might now contain:
610	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	803	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
611		804
612	=item any other argument	805	=item C<--extra-cflags> string
613		806
614	Any other argument is interpreted as a bundle specification file, which	807	Specifies extra compiler flags, used when compiling the bundle file. The
615	supports most long options (without extra quoting), one option per line.	808	flags are appended to all the existing flags, so can be sued to override
		809	settings.
		810
		811	=item C<--extra-ldflags> string
		812
		813	Specifies extra linker flags, used when linking the bundle.
		814
		815	=item C<--extra-libs> string
		816
		817	Extra linker flags, appended at the end when linking. The difference to
		818	C<--extra-ldflags> is that the ldflags are appended to the flags, before
		819	the objects and libraries, and the extra libs are added at the end.
		820
		821	=back
616		822
617	=back	823	=back
618		824
619	=head3 EXTENDED GLOB PATTERNS	825	=head3 EXTENDED GLOB PATTERNS
620		826
…		…
634	=item Patterns not starting with F</> will be anchored at the end of the path.	840	=item Patterns not starting with F</> will be anchored at the end of the path.
635		841
636	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	842	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
637	hierarchy, but not any directories of the same name.	843	hierarchy, but not any directories of the same name.
638		844
639	=item A F<*> matches any single component.	845	=item A F<*> matches anything within a single path component.
640		846
641	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	847	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
642	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	848	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
643	will not match slashes.	849	will not match slashes.
644		850
…		…
711	=item C<STATICPERL>	917	=item C<STATICPERL>
712		918
713	The directory where staticperl stores all its files	919	The directory where staticperl stores all its files
714	(default: F<~/.staticperl>).	920	(default: F<~/.staticperl>).
715		921
		922	=item C<DLCACHE>
		923
		924	The path to a directory (will be created if it doesn't exist) where
		925	downloaded perl sources are being cached, to avoid downloading them
		926	again. The default is empty, which means there is no cache.
		927
		928	=item C<PERL_VERSION>
		929
		930	The perl version to install - C<5.12.5> is a good choice for small builds,
		931	but C<5.8.9> is also a good choice (5.8.9 is much smaller than 5.12.5), if
		932	it builds on your system.
		933
		934	You can also set this variable to the absolute URL of a tarball (F<.tar>,
		935	F<.tar.gz>, F<.tar.bz2>, F<.tar.lzma> or F<.tar.xz>), or to the absolute
		936	path of an unpacked perl source tree, which will be copied.
		937
		938	The default is currently
		939	F<http://stableperl.schmorp.de/dist/latest.tar.gz>, i.e. the latest
		940	stableperl release.
		941
716	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	942	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
717		943
718	Usually set to C<1> to make modules "less inquisitive" during their	944	Usually set to C<1> to make modules "less inquisitive" during their
719	installation, you can set any environment variable you want - some modules	945	installation. You can set (and export!) any environment variable you want
720	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	946	- some modules (such as L<Coro> or L<EV>) use environment variables for
721		947	further tweaking.
722	=item C<PERL_VERSION>
723
724	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
725	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
726	about as big as 5.12.2).
727		948
728	=item C<PERL_PREFIX>	949	=item C<PERL_PREFIX>
729		950
730	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	951	The directory where perl gets installed (default: F<$STATICPERL/perl>),
731	i.e. where the F<bin> and F<lib> subdirectories will end up.	952	i.e. where the F<bin> and F<lib> subdirectories will end up. Previous
		953	contents will be removed on installation.
732		954
733	=item C<PERL_CONFIGURE>	955	=item C<PERL_CONFIGURE>
734		956
735	Additional Configure options - these are simply passed to the perl	957	Additional Configure options - these are simply passed to the perl
736	Configure script. For example, if you wanted to enable dynamic loading,	958	Configure script. For example, if you wanted to enable dynamic loading,
…		…
752	F<~/.staticperlrc> to override them.	974	F<~/.staticperlrc> to override them.
753		975
754	Most of the variables override (or modify) the corresponding F<Configure>	976	Most of the variables override (or modify) the corresponding F<Configure>
755	variable, except C<PERL_CCFLAGS>, which gets appended.	977	variable, except C<PERL_CCFLAGS>, which gets appended.
756		978
		979	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		980	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		981	all) systems.
		982
		983	For other compilers or more customised optimisation settings, you need to
		984	adjust these, e.g. in your F<~/.staticperlrc>.
		985
		986	With gcc on x86 and amd64, you can get more space-savings by using:
		987
		988	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		989	-mno-inline-stringops-dynamically -mno-align-stringops
		990
		991	And on x86 and pentium3 and newer (basically everything you might ever
		992	want to run on), adding these is even better for space-savings (use
		993	-mtune=core2 or something newer for much faster code, too):
		994
		995	-fomit-frame-pointer -march=pentium3 -mtune=i386
		996
757	=back	997	=back
758		998
759	=head4 Variables you probably I<do not want> to override	999	=head4 Variables you probably I<do not want> to override
760		1000
761	=over 4	1001	=over 4
…		…
779	=head3 OVERRIDABLE HOOKS	1019	=head3 OVERRIDABLE HOOKS
780		1020
781	In addition to environment variables, it is possible to provide some	1021	In addition to environment variables, it is possible to provide some
782	shell functions that are called at specific times. To provide your own	1022	shell functions that are called at specific times. To provide your own
783	commands, just define the corresponding function.	1023	commands, just define the corresponding function.
		1024
		1025	The actual order in which hooks are invoked during a full install
		1026	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1027	C<postbuild>, C<postinstall>.
784		1028
785	Example: install extra modules from CPAN and from some directories	1029	Example: install extra modules from CPAN and from some directories
786	at F<staticperl install> time.	1030	at F<staticperl install> time.
787		1031
788	postinstall() {	1032	postinstall() {
…		…
795		1039
796	=over 4	1040	=over 4
797		1041
798	=item preconfigure	1042	=item preconfigure
799		1043
800	Called just before running F<./Configur> in the perl source	1044	Called just before running F<./Configure> in the perl source
801	directory. Current working directory is the perl source directory.	1045	directory. Current working directory is the perl source directory.
802		1046
803	This can be used to set any C<PERL_xxx> variables, which might be costly	1047	This can be used to set any C<PERL_xxx> variables, which might be costly
804	to compute.	1048	to compute.
805		1049
		1050	=item patchconfig
		1051
		1052	Called after running F<./Configure> in the perl source directory to create
		1053	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1054	config. Current working directory is the perl source directory.
		1055
		1056	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1057
806	=item postconfigure	1058	=item postconfigure
807		1059
808	Called after configuring, but before building perl. Current working	1060	Called after configuring, but before building perl. Current working
809	directory is the perl source directory.	1061	directory is the perl source directory.
810		1062
811	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
812	or do any other modifications.
813
814	=item postbuild	1063	=item postbuild
815		1064
816	Called after building, but before installing perl. Current working	1065	Called after building, but before installing perl. Current working
817	directory is the perl source directory.	1066	directory is the perl source directory.
818		1067
819	I have no clue what this could be used for - tell me.	1068	I have no clue what this could be used for - tell me.
		1069
		1070	=item postcpanconfig
		1071
		1072	Called just after CPAN has been configured, but before it has been used to
		1073	install anything. You can further change the configuration like this:
		1074
		1075	"$PERL_PREFIX"/bin/perl -MCPAN::MyConfig -MCPAN -e '
		1076	CPAN::Shell->o (conf => urllist => push => "'"$CPAN"'");
		1077	' \|\| fatal "error while initialising CPAN in postcpanconfig"
820		1078
821	=item postinstall	1079	=item postinstall
822		1080
823	Called after perl and any extra modules have been installed in C<$PREFIX>,	1081	Called after perl and any extra modules have been installed in C<$PREFIX>,
824	but before setting the "installation O.K." flag.	1082	but before setting the "installation O.K." flag.
…		…
855	A header file that contains the prototypes of the few symbols "exported"	1113	A header file that contains the prototypes of the few symbols "exported"
856	by bundle.c, and also exposes the perl headers to the application.	1114	by bundle.c, and also exposes the perl headers to the application.
857		1115
858	=over 4	1116	=over 4
859		1117
860	=item staticperl_init ()	1118	=item staticperl_init (xs_init = 0)
861		1119
862	Initialises the perl interpreter. You can use the normal perl functions	1120	Initialises the perl interpreter. You can use the normal perl functions
863	after calling this function, for example, to define extra functions or	1121	after calling this function, for example, to define extra functions or
864	to load a .pm file that contains some initialisation code, or the main	1122	to load a .pm file that contains some initialisation code, or the main
865	program function:	1123	program function:
…		…
872	}	1130	}
873		1131
874	static void	1132	static void
875	run_myapp(void)	1133	run_myapp(void)
876	{	1134	{
877	staticperl_init ();	1135	staticperl_init (0);
878	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1136	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
879	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1137	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
880	}	1138	}
881		1139
		1140	When your bootcode already wants to access some XS functions at
		1141	compiletime, then you need to supply an C<xs_init> function pointer that
		1142	is called as soon as perl is initialised enough to define XS functions,
		1143	but before the preamble code is executed:
		1144
		1145	static void
		1146	xs_init (pTHX)
		1147	{
		1148	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1149	}
		1150
		1151	static void
		1152	run_myapp(void)
		1153	{
		1154	staticperl_init (xs_init);
		1155	}
		1156
		1157	=item staticperl_cleanup ()
		1158
		1159	In the unlikely case that you want to destroy the perl interpreter, here
		1160	is the corresponding function.
		1161
882	=item staticperl_xs_init (pTHX)	1162	=item staticperl_xs_init (pTHX)
883		1163
884	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1164	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
885	which case you do not want to use C<staticperl_init> but call them on your	1165	which case you do not want to use C<staticperl_init> but call them on your
886	own.	1166	own.
887		1167
888	Then you need this function - either pass it directly as the C<xs_init>	1168	Then you need this function - either pass it directly as the C<xs_init>
889	function to C<perl_parse>, or call it from your own C<xs_init> function.	1169	function to C<perl_parse>, or call it as one of the first things from your
890		1170	own C<xs_init> function.
891	=item staticperl_cleanup ()
892
893	In the unlikely case that you want to destroy the perl interpreter, here
894	is the corresponding function.
895		1171
896	=item PerlInterpreter *staticperl	1172	=item PerlInterpreter *staticperl
897		1173
898	The perl interpreter pointer used by staticperl. Not normally so useful,	1174	The perl interpreter pointer used by staticperl. Not normally so useful,
899	but there it is.	1175	but there it is.
…		…
912		1188
913	=back	1189	=back
914		1190
915	=head1 RUNTIME FUNCTIONALITY	1191	=head1 RUNTIME FUNCTIONALITY
916		1192
917	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1193	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
918	are required to access the bundled perl sources, but might be useful for	1194	mostly related to the extra files bundled in the binary (the virtual
919	other purposes.	1195	filesystem). All of this data is statically compiled into the binary, and
		1196	accessing means copying it from a read-only section of your binary. Data
		1197	pages in this way are usually freed by the operating system, as they aren't
		1198	used more then once.
		1199
		1200	=head2 VIRTUAL FILESYSTEM
		1201
		1202	Every bundle has a virtual filesystem. The only information stored in it
		1203	is the path and contents of each file that was bundled.
		1204
		1205	=head3 LAYOUT
		1206
		1207	Any paths starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1208	reserved by F<staticperl>. They must only be used as described in this
		1209	section.
		1210
		1211	=over 4
		1212
		1213	=item !
		1214
		1215	All files that typically cannot be loaded from memory (such as dynamic
		1216	objects or shared libraries), but have to reside in the filesystem, are
		1217	prefixed with F<!>. Typically these files get written out to some
		1218	(semi-)temporary directory shortly after program startup, or before being
		1219	used.
		1220
		1221	=item !boot
		1222
		1223	The bootstrap file, if specified during bundling.
		1224
		1225	=item !auto/
		1226
		1227	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1228	are stored with an F<!auto/> prefix.
		1229
		1230	=item !lib/
		1231
		1232	External shared libraries are stored in this directory.
		1233
		1234	=item any letter
		1235
		1236	Any path starting with a letter is a perl library file. For example,
		1237	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1238	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1239
		1240	Obviously, module names shouldn't start with any other characters than
		1241	letters :)
		1242
		1243	=back
		1244
		1245	=head3 FUNCTIONS
		1246
		1247	=over 4
		1248
		1249	=item $file = static::find $path
		1250
		1251	Returns the data associated with the given C<$path>
		1252	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1253
		1254	Returns C<undef> if the file isn't embedded.
		1255
		1256	=item @paths = static::list
		1257
		1258	Returns the list of all paths embedded in this binary.
		1259
		1260	=back
		1261
		1262	=head2 EXTRA FEATURES
920		1263
921	In addition, for the embedded loading of perl files to work, F<staticperl>	1264	In addition, for the embedded loading of perl files to work, F<staticperl>
922	overrides the C<@INC> array.	1265	overrides the C<@INC> array.
923		1266
924	=over 4
925
926	=item $file = staticperl::find $path
927
928	Returns the data associated with the given C<$path>
929	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
930	the UNIX path relative to the perl library directory.
931
932	Returns C<undef> if the file isn't embedded.
933
934	=item @paths = staticperl::list
935
936	Returns the list of all paths embedded in this binary.
937
938	=back
939
940	=head1 FULLY STATIC BINARIES - BUILDROOT	1267	=head1 FULLY STATIC BINARIES - ALPINE LINUX
941		1268
942	To make truly static (Linux-) libraries, you might want to have a look at	1269	This section once contained a way to build fully static (including
943	buildroot (L<http://buildroot.uclibc.org/>).	1270	uClibc) binaries with buildroot. Unfortunately, buildroot no longer
		1271	supports a compiler, so I recommend using alpine linux instead
		1272	(L<http://alpinelinux.org/>). Get yourself a VM (e.g. with qemu), run an
		1273	older alpine linux verison in it (e.g. 2.4), copy staticperl inside and
		1274	use it.
944		1275
945	Buildroot is primarily meant to set up a cross-compile environment (which	1276	The reason you might want an older alpine linux is that uClibc can be
946	is not so useful as perl doesn't quite like cross compiles), but it can also compile	1277	quite dependent on kernel versions, so the newest version of alpine linux
947	a chroot environment where you can use F<staticperl>.	1278	might need a newer kernel then you might want for, if you plan to run your
948		1279	binaries on on other kernels.
949	To do so, download buildroot, and enable "Build options => development
950	files in target filesystem" and optionally "Build options => gcc
951	optimization level (optimize for size)". At the time of writing, I had
952	good experiences with GCC 4.4.x but not GCC 4.5.
953
954	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
955	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
956	doesn't decrease codesize much, but it makes the file much more
957	compressible.
958
959	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
960	no thread support). For Coro, it is highly recommended to switch to a
961	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
962	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
963	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
964	twice the address space needed for stacks).
965
966	If you use C<linuxthreads.old>, then you should also be aware that
967	uClibc shares C<errno> between all threads when statically linking. See
968	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
969	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
970
971	C<ccache> support is also recommended, especially if you want
972	to play around with buildroot options. Enabling the C<miniperl>
973	package will probably enable all options required for a successful
974	perl build. F<staticperl> itself additionally needs either C<wget>
975	(recommended, for CPAN) or C<curl>.
976
977	As for shells, busybox should provide all that is needed, but the default
978	busybox configuration doesn't include F<comm> which is needed by perl -
979	either make a custom busybox config, or compile coreutils.
980
981	For the latter route, you might find that bash has some bugs that keep
982	it from working properly in a chroot - either use dash (and link it to
983	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
984	built-in ash shell.
985
986	Finally, you need F</dev/null> inside the chroot for many scripts to work
987	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
988	both provide this.
989
990	After you have compiled and set up your buildroot target, you can copy
991	F<staticperl> from the C<App::Staticperl> distribution or from your
992	perl f<bin> directory (if you installed it) into the F<output/target>
993	filesystem, chroot inside and run it.
994		1280
995	=head1 RECIPES / SPECIFIC MODULES	1281	=head1 RECIPES / SPECIFIC MODULES
996		1282
997	This section contains some common(?) recipes and information about	1283	This section contains some common(?) recipes and information about
998	problems with some common modules or perl constructs that require extra	1284	problems with some common modules or perl constructs that require extra
…		…
1006		1292
1007	Some functionality in the utf8 module, such as swash handling (used	1293	Some functionality in the utf8 module, such as swash handling (used
1008	for unicode character ranges in regexes) is implemented in the	1294	for unicode character ranges in regexes) is implemented in the
1009	C<"utf8_heavy.pl"> library:	1295	C<"utf8_heavy.pl"> library:
1010		1296
1011	-M'"utf8_heavy.pl"'	1297	-Mutf8_heavy.pl
1012		1298
1013	Many Unicode properties in turn are defined in separate modules,	1299	Many Unicode properties in turn are defined in separate modules,
1014	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1300	such as C<"unicore/Heavy.pl"> and more specific data tables such as
1015	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1301	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1016	are big (7MB uncompressed, although F<staticperl> contains special	1302	are big (7MB uncompressed, although F<staticperl> contains special
1017	handling for those files), so including them on demand by your application	1303	handling for those files), so including them only on demand in your
1018	only might pay off.	1304	application might pay off.
1019		1305
1020	To simply include the whole unicode database, use:	1306	To simply include the whole unicode database, use:
1021		1307
1022	--incglob '/unicore/*.pl'	1308	--incglob '/unicore/**.pl'
1023		1309
1024	=item AnyEvent	1310	=item AnyEvent
1025		1311
1026	AnyEvent needs a backend implementation that it will load in a delayed	1312	AnyEvent needs a backend implementation that it will load in a delayed
1027	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1313	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
1032		1318
1033	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1319	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1034	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1320	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1035	C<"AnyEvent/Util/uts46data.pl">.	1321	C<"AnyEvent/Util/uts46data.pl">.
1036		1322
1037	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1323	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1038	everything.	1324	everything.
		1325
		1326	=item Cairo
		1327
		1328	See Glib, same problem, same solution.
1039		1329
1040	=item Carp	1330	=item Carp
1041		1331
1042	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1332	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1043	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1333	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
1046		1336
1047	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1337	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1048	turn might need L<"Config_heavy.pl">. Including the latter gives you	1338	turn might need L<"Config_heavy.pl">. Including the latter gives you
1049	both.	1339	both.
1050		1340
		1341	=item Glib
		1342
		1343	Glib literally requires Glib to be installed already to build - it tries
		1344	to fake this by running Glib out of the build directory before being
		1345	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1346	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1347
		1348	=item Gtk2
		1349
		1350	See Pango, same problems, same solution.
		1351
		1352	=item Net::SSLeay
		1353
		1354	This module hasn't been significantly updated since OpenSSL is called
		1355	OpenSSL, and fails to properly link against dependent libraries, most
		1356	commonly, it forgets to specify -ldl when linking.
		1357
		1358	On GNU/Linux systems this usually goes undetected, as perl usually links
		1359	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1360	chance.
		1361
		1362	For static builds, you either have to configure -ldl manually, or you
		1363	cna use the following snippet in your C<postinstall> hook which patches
		1364	Net::SSLeay after installation, which happens to work most of the time:
		1365
		1366	postinstall() {
		1367	# first install it
		1368	instcpan Net::SSLeay
		1369	# then add -ldl for future linking
		1370	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1371	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1372	}
		1373
		1374	=item Pango
		1375
		1376	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1377	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1378	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1379
1051	=item Term::ReadLine::Perl	1380	=item Term::ReadLine::Perl
1052		1381
1053	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1382	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1054		1383
1055	=item URI	1384	=item URI
1056		1385
1057	URI implements schemes as separate modules - the generic URL scheme is	1386	URI implements schemes as separate modules - the generic URL scheme is
1058	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1387	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1059	you need to use any of these schemes, you should include these manually,	1388	you need to use any of these schemes, you should include these manually,
1060	or use C<--usepacklist>.	1389	or use C<--usepacklists>.
1061		1390
1062	=back	1391	=back
1063		1392
1064	=head2 RECIPES	1393	=head2 RECIPES
1065		1394
1066	=over 4	1395	=over 4
1067		1396
1068	=item Linking everything in	1397	=item Just link everything in
1069		1398
1070	To link just about everything installed in the perl library into a new	1399	To link just about everything installed in the perl library into a new
1071	perl, try this:	1400	perl, try this (the first time this runs it will take a long time, as a
		1401	lot of files need to be parsed):
1072		1402
1073	staticperl mkperl --strip ppi --incglob '*'	1403	staticperl mkperl -v --strip ppi --incglob '*'
1074		1404
		1405	If you don't mind the extra megabytes, this can be a very effective way of
		1406	creating bundles without having to worry about forgetting any modules.
		1407
		1408	You get even more useful variants of this method by first selecting
		1409	everything, and then excluding stuff you are reasonable sure not to need -
		1410	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1411
1075	=item Getting rid of netdb function	1412	=item Getting rid of netdb functions
1076		1413
1077	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1414	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1078	and so on) that few applications use. You can avoid compiling them in by	1415	and so on) that few applications use. You can avoid compiling them in by
1079	putting the following fragment into a C<preconfigure> hook:	1416	putting the following fragment into a C<preconfigure> hook:
1080		1417
…		…
1097	do	1434	do
1098	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1435	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1099	done	1436	done
1100	}	1437	}
1101		1438
1102	This mostly gains space when linking staticaly, as the functions will	1439	This mostly gains space when linking statically, as the functions will
1103	likely not be linked in. The gain for dynamically-linked binaries is	1440	likely not be linked in. The gain for dynamically-linked binaries is
1104	smaller.	1441	smaller.
1105		1442
1106	Also, this leaves C<gethostbyname> in - not only is it actually used	1443	Also, this leaves C<gethostbyname> in - not only is it actually used
1107	often, the L<Socket> module also exposes it, so leaving it out usually	1444	often, the L<Socket> module also exposes it, so leaving it out usually
1108	gains little. Why Socket exposes a C function that is in the core already	1445	gains little. Why Socket exposes a C function that is in the core already
1109	is anybody's guess.	1446	is anybody's guess.
1110		1447
1111	=back	1448	=back
1112		1449
		1450	=head1 ADDITIONAL RESOURCES
		1451
		1452	Some guy has made a repository on github
		1453	(L<https://github.com/gh0stwizard/staticperl-modules>) with some modules
		1454	patched to build with staticperl.
		1455
1113	=head1 AUTHOR	1456	=head1 AUTHOR
1114		1457
1115	Marc Lehmann <schmorp@schmorp.de>	1458	Marc Lehmann <schmorp@schmorp.de>
1116	http://software.schmorp.de/pkg/staticperl.html	1459	http://software.schmorp.de/pkg/staticperl.html
		1460

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs. Revision 1.65 by root, Mon Jul 31 21:04:06 2023 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC vs.
Revision 1.65 by root, Mon Jul 31 21:04:06 2023 UTC