[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.46 by root, Wed Jun 29 14:37:59 2011 UTC

…		…
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 instmod 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
…		…
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,
…		…
207		225
208	=item F<staticperl clean>	226	=item F<staticperl clean>
209		227
210	Deletes the perl source directory (and potentially cleans up other	228	Deletes the perl source directory (and potentially cleans up other
211	intermediate files). This can be used to clean up files only needed for	229	intermediate files). This can be used to clean up files only needed for
212	building perl, without removing the installed perl interpreter, or to	230	building perl, without removing the installed perl interpreter.
213	force a re-build from scratch.
214		231
215	At the moment, it doesn't delete downloaded tarballs.	232	At the moment, it doesn't delete downloaded tarballs.
		233
		234	The exact semantics of this command will probably change.
216		235
217	=item F<staticperl distclean>	236	=item F<staticperl distclean>
218		237
219	This wipes your complete F<~/.staticperl> directory. Be careful with this,	238	This wipes your complete F<~/.staticperl> directory. Be careful with this,
220	it nukes your perl download, perl sources, perl distribution and any	239	it nukes your perl download, perl sources, perl distribution and any
…		…
244		263
245	# first make sure we have perl and the required modules	264	# first make sure we have perl and the required modules
246	staticperl instcpan AnyEvent::HTTPD	265	staticperl instcpan AnyEvent::HTTPD
247		266
248	# now build the perl	267	# now build the perl
249	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	268	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
250	-MAnyEvent::HTTPD -MURI::http \	269	-MAnyEvent::HTTPD -MURI::http \
251	--add 'eg/httpd httpd.pm'	270	--add 'eg/httpd httpd.pm'
252		271
253	# finally, invoke it	272	# finally, invoke it
254	./perl -Mhttpd	273	./perl -Mhttpd
…		…
270	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	289	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
271		290
272	# run it	291	# run it
273	./app	292	./app
274		293
		294	Here are the three phase 2 commands:
		295
		296	=over 4
		297
		298	=item F<staticperl mkbundle> args...
		299
		300	The "default" bundle command - it interprets the given bundle options and
		301	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		302	files, useful for embedding.
		303
		304	=item F<staticperl mkperl> args...
		305
		306	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		307	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		308	links a new perl interpreter that embeds the created bundle, then deletes
		309	all intermediate files.
		310
		311	=item F<staticperl mkapp> filename args...
		312
		313	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		314	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		315	and links a new standalone application that simply initialises the perl
		316	interpreter.
		317
		318	The difference to F<staticperl mkperl> is that the standalone application
		319	does not act like a perl interpreter would - in fact, by default it would
		320	just do nothing and exit immediately, so you should specify some code to
		321	be executed via the F<--boot> option.
		322
		323	=back
		324
275	=head3 OPTION PROCESSING	325	=head3 OPTION PROCESSING
276		326
277	All options can be given as arguments on the command line (typically	327	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	328	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,	329	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	330	unwieldy, you can put all long options into a "bundle specification file"
281	without C<--> prefix) and specify this bundle file instead.	331	(one option per line, with or without C<--> prefix) and specify this
		332	bundle file instead.
282		333
283	For example, the command given earlier could also look like this:	334	For example, the command given earlier to link a new F<perl> could also
		335	look like this:
284		336
285	staticperl mkperl httpd.bundle	337	staticperl mkperl httpd.bundle
286		338
287	And all options could be in F<httpd.bundle>:	339	With all options stored in the F<httpd.bundle> file (one option per line,
288		340	everything after the option is an argument):
		341
289	use "Config_heavy.pl"	342	use "Config_heavy.pl"
290	use AnyEvent::Impl::Perl	343	use AnyEvent::Impl::Perl
291	use AnyEvent::HTTPD	344	use AnyEvent::HTTPD
292	use URI::http	345	use URI::http
293	add eg/httpd httpd.pm	346	add eg/httpd httpd.pm
294		347
295	All options that specify modules or files to be added are processed in the	348	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>	349	order given on the command line.
297	options at the moment).
298		350
299	=head3 PACKAGE SELECTION WORKFLOW	351	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
300		352
301	F<staticperl mkbundle> has a number of options to control package	353	F<staticperl mkbundle> works by first assembling a list of candidate
302	selection. This section describes how they interact with each other. Also,	354	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	355	patterns. The remaining modules (together with their direct dependencies,
304	F<staticperl> will change this, so watch out :)	356	such as link libraries and L<AutoLoader> files) are then converted into
		357	bundle files suitable for embedding. F<staticperl mkbundle> can then
		358	optionally build a new perl interpreter or a standalone application.
305		359
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	360	=over 4
311		361
312	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	362	=item Step 0: Generic argument processing.
313	C<--incglob> options, in order.
314		363
315	In addition, C<--use> and C<--eval> dependencies will be added when the	364	The following options influence F<staticperl mkbundle> itself.
316	options are processed.
317		365
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	366	=over 4
340		367
341	=item --verbose \| -v	368	=item C<--verbose> \| C<-v>
342		369
343	Increases the verbosity level by one (the default is C<1>).	370	Increases the verbosity level by one (the default is C<1>).
344		371
345	=item --quiet \| -q	372	=item C<--quiet> \| C<-q>
346		373
347	Decreases the verbosity level by one.	374	Decreases the verbosity level by one.
348		375
		376	=item any other argument
		377
		378	Any other argument is interpreted as a bundle specification file, which
		379	supports all options (without extra quoting), one option per line, in the
		380	format C<option> or C<option argument>. They will effectively be expanded
		381	and processed as if they were directly written on the command line, in
		382	place of the file name.
		383
		384	=back
		385
		386	=item Step 1: gather candidate files and modules
		387
		388	In this step, modules, perl libraries (F<.pl> files) and other files are
		389	selected for inclusion in the bundle. The relevant options are executed
		390	in order (this makes a difference mostly for C<--eval>, which can rely on
		391	earlier C<--use> options to have been executed).
		392
		393	=over 4
		394
		395	=item C<--use> F<module> \| C<-M>F<module>
		396
		397	Include the named module or perl library and trace direct
		398	dependencies. This is done by loading the module in a subprocess and
		399	tracing which other modules and files it actually loads.
		400
		401	Example: include AnyEvent and AnyEvent::Impl::Perl.
		402
		403	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		404
		405	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
		406	maybe other weirdly named files. To support this, the C<--use> option
		407	actually tries to do what you mean, depending on the string you specify:
		408
		409	=over 4
		410
		411	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		412	F<Coro::Mysql>.
		413
		414	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		415	assumes that it is a normal module name. It will create a new package and
		416	evaluate a C<use module> in it, i.e. it will load the package and do a
		417	default import.
		418
		419	The import step is done because many modules trigger more dependencies
		420	when something is imported than without.
		421
		422	=item anything that contains F</> or F<.> characters,
		423	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		424
		425	The string will be quoted and passed to require, as if you used C<require
		426	$module>. Nothing will be imported.
		427
		428	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		429
		430	If you enclose the name into single or double quotes, then the quotes will
		431	be removed and the resulting string will be passed to require. This syntax
		432	is form compatibility with older versions of staticperl and should not be
		433	used anymore.
		434
		435	=back
		436
		437	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		438	symbols), and once via C<require>, not importing any symbols. The first
		439	form is preferred as many modules load some extra dependencies when asked
		440	to export symbols.
		441
		442	staticperl mkbundle -MAnyEvent::Socket # use + import
		443	staticperl mkbundle -MAnyEvent/Socket.pm # require only
		444
		445	Example: include the required files for F<perl -V> to work in all its
		446	glory (F<Config.pm> is included automatically by the dependency tracker).
		447
		448	# shell command
		449	staticperl mkbundle -MConfig_heavy.pl
		450
		451	# bundle specification file
		452	use Config_heavy.pl
		453
		454	The C<-M>module syntax is included as a convenience that might be easier
		455	to remember than C<--use> - it's the same switch as perl itself uses
		456	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		457	not. Sigh.
		458
		459	=item C<--eval> "perl code" \| C<-e> "perl code"
		460
		461	Sometimes it is easier (or necessary) to specify dependencies using perl
		462	code, or maybe one of the modules you use need a special use statement. In
		463	that case, you can use C<--eval> to execute some perl snippet or set some
		464	variables or whatever you need. All files C<require>'d or C<use>'d while
		465	executing the snippet are included in the final bundle.
		466
		467	Keep in mind that F<mkbundle> will not import any symbols from the modules
		468	named by the C<--use> option, so do not expect the symbols from modules
		469	you C<--use>'d earlier on the command line to be available.
		470
		471	Example: force L<AnyEvent> to detect a backend and therefore include it
		472	in the final bundle.
		473
		474	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		475
		476	# or like this
		477	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		478
		479	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		480	and also include this in the final bundle, to be executed automatically
		481	when the interpreter is initialised.
		482
		483	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		484
		485	=item C<--boot> F<filename>
		486
		487	Include the given file in the bundle and arrange for it to be
		488	executed (using C<require>) before the main program when the new perl
		489	is initialised. This can be used to modify C<@INC> or do similar
		490	modifications before the perl interpreter executes scripts given on the
		491	command line (or via C<-e>). This works even in an embedded interpreter -
		492	the file will be executed during interpreter initialisation in that case.
		493
		494	=item C<--incglob> pattern
		495
		496	This goes through all standard library directories and tries to match any
		497	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		498	a file matches, it is added. The pattern is matched against the full path
		499	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		500
		501	This is very useful to include "everything":
		502
		503	--incglob '*'
		504
		505	It is also useful for including perl libraries, or trees of those, such as
		506	the unicode database files needed by some perl built-ins, the regex engine
		507	and other modules.
		508
		509	--incglob '/unicore/**.pl'
		510
		511	=item C<--add> F<file> \| C<--add> "F<file> alias"
		512
		513	Adds the given (perl) file into the bundle (and optionally call it
		514	"alias"). The F<file> is either an absolute path or a path relative to the
		515	current directory. If an alias is specified, then this is the name it will
		516	use for C<@INC> searches, otherwise the path F<file> will be used as the
		517	internal name.
		518
		519	This switch is used to include extra files into the bundle.
		520
		521	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		522	when creating the bundle.
		523
		524	staticperl mkperl --add "httpd httpd.pm"
		525
		526	# can be accessed via "use httpd"
		527
		528	Example: add a file F<initcode> from the current directory.
		529
		530	staticperl mkperl --add 'initcode &initcode'
		531
		532	# can be accessed via "do '&initcode'"
		533
		534	Example: add local files as extra modules in the bundle.
		535
		536	# specification file
		537	add file1 myfiles/file1.pm
		538	add file2 myfiles/file2.pm
		539	add file3 myfiles/file3.pl
		540
		541	# then later, in perl, use
		542	use myfiles::file1;
		543	require myfiles::file2;
		544	my $res = do "myfiles/file3.pl";
		545
		546	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		547
		548	Just like C<--add>, except that it treats the file as binary and adds it
		549	without any postprocessing (perl files might get stripped to reduce their
		550	size).
		551
		552	If you specify an alias you should probably add a C<&> prefix to avoid
		553	clashing with embedded perl files (whose paths never start with C<&>),
		554	and/or use a special directory prefix, such as C<&res/name>.
		555
		556	You can later get a copy of these files by calling C<staticperl::find
		557	"alias">.
		558
		559	An alternative way to embed binary files is to convert them to perl and
		560	use C<do> to get the contents - this method is a bit cumbersome, but works
		561	both inside and outside of a staticperl bundle:
		562
		563	# a "binary" file, call it "bindata.pl"
		564	<<'SOME_MARKER'
		565	binary data NOT containing SOME_MARKER
		566	SOME_MARKER
		567
		568	# load the binary
		569	chomp (my $data = do "bindata.pl");
		570
		571	=back
		572
		573	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		574
		575	After all candidate files and modules are added, they are I<filtered>
		576	by a combination of C<--include> and C<--exclude> patterns (there is an
		577	implicit C<--include *> at the end, so if no filters are specified, all
		578	files are included).
		579
		580	All that this step does is potentially reduce the number of files that are
		581	to be included - no new files are added during this step.
		582
		583	=over 4
		584
		585	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		586
		587	These specify an include or exclude pattern to be applied to the candidate
		588	file list. An include makes sure that the given files will be part of the
		589	resulting file set, an exclude will exclude remaining files. The patterns
		590	are "extended glob patterns" (see below).
		591
		592	The patterns are applied "in order" - files included via earlier
		593	C<--include> specifications cannot be removed by any following
		594	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		595	cannot be added by any following C<--include>.
		596
		597	For example, to include everything except C<Devel> modules, but still
		598	include F<Devel::PPPort>, you could use this:
		599
		600	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		601
		602	=back
		603
		604	=item Step 3: add any extra or "hidden" dependencies.
		605
		606	F<staticperl> currently knows about three extra types of depdendencies
		607	that are added automatically. Only one (F<.packlist> files) is currently
		608	optional and can be influenced, the others are always included:
		609
		610	=over 4
		611
		612	=item C<--usepacklists>
		613
		614	Read F<.packlist> files for each distribution that happens to match a
		615	module name you specified. Sounds weird, and it is, so expect semantics to
		616	change somehow in the future.
		617
		618	The idea is that most CPAN distributions have a F<.pm> file that matches
		619	the name of the distribution (which is rather reasonable after all).
		620
		621	If this switch is enabled, then if any of the F<.pm> files that have been
		622	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		623	and F<.ix> files installed by this distribution are also included.
		624
		625	For example, using this switch, when the L<URI> module is specified, then
		626	all L<URI> submodules that have been installed via the CPAN distribution
		627	are included as well, so you don't have to manually specify them.
		628
		629	=item L<AutoLoader> splitfiles
		630
		631	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		632	are split into separate F<.al> files, and an index (F<.ix>) file contains
		633	the prototypes.
		634
		635	Both F<.ix> and F<.al> files will be detected automatically and added to
		636	the bundle.
		637
		638	=item link libraries (F<.a> files)
		639
		640	Modules using XS (or any other non-perl language extension compiled at
		641	installation time) will have a static archive (typically F<.a>). These
		642	will automatically be added to the linker options in F<bundle.ldopts>.
		643
		644	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		645	will warn about it - obviously this shouldn't happen unless you use
		646	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		647	use dynamic loading.
		648
		649	=item extra libraries (F<extralibs.ld>)
		650
		651	Some modules need linking against external libraries - these are found in
		652	F<extralibs.ld> and added to F<bundle.ldopts>.
		653
		654	=back
		655
		656	=item Step 4: write bundle files and optionally link a program
		657
		658	At this point, the select files will be read, processed (stripped) and
		659	finally the bundle files get written to disk, and F<staticperl mkbundle>
		660	is normally finished. Optionally, it can go a step further and either link
		661	a new F<perl> binary with all selected modules and files inside, or build
		662	a standalone application.
		663
		664	Both the contents of the bundle files and any extra linking is controlled
		665	by these options:
		666
		667	=over 4
		668
349	=item --strip none\|pod\|ppi	669	=item C<--strip> C<none>\|C<pod>\|C<ppi>
350		670
351	Specify the stripping method applied to reduce the file of the perl	671	Specify the stripping method applied to reduce the file of the perl
352	sources included.	672	sources included.
353		673
354	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	674	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,	685	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	686	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	687	mistreated, you can specify C<none> to not mangle included perl sources in
368	any way.	688	any way.
369		689
370	=item --perl	690	=item C<--perl>
371		691
372	After writing out the bundle files, try to link a new perl interpreter. It	692	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	693	will be called F<perl> and will be left in the current working
374	directory. The bundle files will be removed.	694	directory. The bundle files will be removed.
375		695
376	This switch is automatically used when F<staticperl> is invoked with the	696	This switch is automatically used when F<staticperl> is invoked with the
377	C<mkperl> command (instead of C<mkbundle>):	697	C<mkperl> command instead of C<mkbundle>.
378		698
379	# build a new ./perl with only common::sense in it - very small :)	699	Example: build a new F<./perl> binary with only L<common::sense> inside -
		700	it will be even smaller than the standard perl interpreter as none of the
		701	modules of the base distribution (such as L<Fcntl>) will be included.
		702
380	staticperl mkperl -Mcommon::sense	703	staticperl mkperl -Mcommon::sense
381		704
382	=item --app name	705	=item C<--app> F<name>
383		706
384	After writing out the bundle files, try to link a new standalone	707	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	708	program. It will be called C<name>, and the bundle files get removed after
386	linking it.	709	linking it.
		710
		711	This switch is automatically used when F<staticperl> is invoked with the
		712	C<mkapp> command instead of C<mkbundle>.
387		713
388	The difference to the (mutually exclusive) C<--perl> option is that the	714	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 -	715	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	716	instead it will simply initialise the perl interpreter, clean it up and
391	exit.	717	exit.
392		718
393	This switch is automatically used when F<staticperl> is invoked with the	719	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	720	- for it to do something useful you I<must> add some boot code, e.g. with
397	the C<--boot> option.	721	the C<--boot> option.
398		722
399	Example: create a standalone perl binary that will execute F<appfile> when	723	Example: create a standalone perl binary called F<./myexe> that will
400	it is started.	724	execute F<appfile> when it is started.
401		725
402	staticperl mkbundle --app myexe --boot appfile	726	staticperl mkbundle --app myexe --boot appfile
403		727
404	=item --use module \| -Mmodule	728	=item C<--ignore-env>
405		729
406	Include the named module and all direct dependencies. This is done by	730	Generates extra code to unset some environment variables before
407	C<require>'ing the module in a subprocess and tracing which other modules	731	initialising/running perl. Perl supports a lot of environment variables
408	and files it actually loads. If the module uses L<AutoLoader>, then all	732	that might alter execution in ways that might be undesirablre for
409	splitfiles will be included as well.	733	standalone applications, and this option removes those known to cause
		734	trouble.
410		735
411	Example: include AnyEvent and AnyEvent::Impl::Perl.	736	Specifically, these are removed:
412		737
413	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	738	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
		739	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		740	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		741	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
414		742
415	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	743	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	744	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		745
421	Example: include the required files for F<perl -V> to work in all its	746	This option will not make your program more secure (unless you are
422	glory (F<Config.pm> is included automatically by this).	747	running with elevated privileges), but it will reduce the surprise effect
		748	when a user has these environment variables set and doesn't expect your
		749	standalone program to act like a perl interpreter.
423		750
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	751	=item C<--static>
543		752
544	When C<--perl> is also given, link statically instead of dynamically. The	753	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		754	supported by the OS) executable will be created. This is not immensely
		755	useful when just creating the bundle files, but is most useful when
		756	linking a binary with the C<--perl> or C<--app> options.
		757
545	default is to link the new perl interpreter fully dynamic (that means all	758	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	759	modules are linked statically, but all external libraries are still
547	referenced dynamically).	760	referenced dynamically).
548		761
549	Keep in mind that Solaris doesn't support static linking at all, and	762	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	763	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	764	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	765	executables, or try the C<--staticlib> option to link only some libraries
553	statically.	766	statically.
554		767
555	=item --staticlib libname	768	=item C<--staticlib> libname
556		769
557	When not linking fully statically, this option allows you to link specific	770	When not linking fully statically, this option allows you to link specific
558	libraries statically. What it does is simply replace all occurances of	771	libraries statically. What it does is simply replace all occurrences of
559	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	772	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
560	option.	773	option.
561		774
562	This will have no effect unless the library is actually linked against,	775	This will have no effect unless the library is actually linked against,
563	specifically, C<--staticlib> will not link against the named library	776	specifically, C<--staticlib> will not link against the named library
564	unless it would be linked against anyway.	777	unless it would be linked against anyway.
565		778
566	Example: link libcrypt statically into the binary.	779	Example: link libcrypt statically into the final binary.
567		780
568	staticperl mkperl -MIO::AIO --staticlib crypt	781	staticperl mkperl -MIO::AIO --staticlib crypt
569		782
570	# ldopts might nwo contain:	783	# ldopts might now contain:
571	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	784	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
572		785
573	=item any other argument	786	=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		787
578	=back	788	=back
579		789
580	=head3 EXTENDED GLOB PATTERNS	790	=head3 EXTENDED GLOB PATTERNS
581		791
…		…
595	=item Patterns not starting with F</> will be anchored at the end of the path.	805	=item Patterns not starting with F</> will be anchored at the end of the path.
596		806
597	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	807	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.	808	hierarchy, but not any directories of the same name.
599		809
600	=item A F<*> matches any single component.	810	=item A F<*> matches anything within a single path component.
601		811
602	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	812	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<*>	813	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
604	will not match slashes.	814	will not match slashes.
605		815
…		…
672	=item C<STATICPERL>	882	=item C<STATICPERL>
673		883
674	The directory where staticperl stores all its files	884	The directory where staticperl stores all its files
675	(default: F<~/.staticperl>).	885	(default: F<~/.staticperl>).
676		886
		887	=item C<DLCACHE>
		888
		889	The path to a directory (will be created if it doesn't exist) where
		890	downloaded perl sources are being cached, to avoid downloading them
		891	again. The default is empty, which means there is no cache.
		892
		893	=item C<PERL_VERSION>
		894
		895	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
		896	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
		897	about as big as 5.12.3).
		898
677	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	899	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
678		900
679	Usually set to C<1> to make modules "less inquisitive" during their	901	Usually set to C<1> to make modules "less inquisitive" during their
680	installation, you can set any environment variable you want - some modules	902	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.	903	- some modules (such as L<Coro> or L<EV>) use environment variables for
682		904	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		905
689	=item C<PERL_PREFIX>	906	=item C<PERL_PREFIX>
690		907
691	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	908	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
692	i.e. where the F<bin> and F<lib> subdirectories will end up.	909	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
701		918
702	More commonly, you would either activate 64 bit integer support	919	More commonly, you would either activate 64 bit integer support
703	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	920	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
704	reduce filesize further.	921	reduce filesize further.
705		922
706	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	923	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
707		924
708	These flags are passed to perl's F<Configure> script, and are generally	925	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	926	optimised for small size (at the cost of performance). Since they also
710	contain subtle workarounds around various build issues, changing these	927	contain subtle workarounds around various build issues, changing these
711	usually requires understanding their default values - best look at the top	928	usually requires understanding their default values - best look at
712	of the F<staticperl> script for more info on these.	929	the top of the F<staticperl> script for more info on these, and use a
		930	F<~/.staticperlrc> to override them.
		931
		932	Most of the variables override (or modify) the corresponding F<Configure>
		933	variable, except C<PERL_CCFLAGS>, which gets appended.
		934
		935	You should have a look near the beginning of the F<staticperl> script -
		936	staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
		937	suitable for newer gcc versions. For other compilers or older versions you
		938	need to adjust these, for example, in your F<~/.staticperlrc>.
713		939
714	=back	940	=back
715		941
716	=head4 Variables you probably I<do not want> to override	942	=head4 Variables you probably I<do not want> to override
717		943
718	=over 4	944	=over 4
		945
		946	=item C<MAKE>
		947
		948	The make command to use - default is C<make>.
719		949
720	=item C<MKBUNDLE>	950	=item C<MKBUNDLE>
721		951
722	Where F<staticperl> writes the C<mkbundle> command to	952	Where F<staticperl> writes the C<mkbundle> command to
723	(default: F<$STATICPERL/mkbundle>).	953	(default: F<$STATICPERL/mkbundle>).
…		…
732	=head3 OVERRIDABLE HOOKS	962	=head3 OVERRIDABLE HOOKS
733		963
734	In addition to environment variables, it is possible to provide some	964	In addition to environment variables, it is possible to provide some
735	shell functions that are called at specific times. To provide your own	965	shell functions that are called at specific times. To provide your own
736	commands, just define the corresponding function.	966	commands, just define the corresponding function.
		967
		968	The actual order in which hooks are invoked during a full install
		969	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		970	C<postbuild>, C<postinstall>.
737		971
738	Example: install extra modules from CPAN and from some directories	972	Example: install extra modules from CPAN and from some directories
739	at F<staticperl install> time.	973	at F<staticperl install> time.
740		974
741	postinstall() {	975	postinstall() {
…		…
748		982
749	=over 4	983	=over 4
750		984
751	=item preconfigure	985	=item preconfigure
752		986
753	Called just before running F<./Configur> in the perl source	987	Called just before running F<./Configure> in the perl source
754	directory. Current working directory is the perl source directory.	988	directory. Current working directory is the perl source directory.
755		989
756	This can be used to set any C<PERL_xxx> variables, which might be costly	990	This can be used to set any C<PERL_xxx> variables, which might be costly
757	to compute.	991	to compute.
758		992
		993	=item patchconfig
		994
		995	Called after running F<./Configure> in the perl source directory to create
		996	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		997	config. Current working directory is the perl source directory.
		998
		999	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1000
759	=item postconfigure	1001	=item postconfigure
760		1002
761	Called after configuring, but before building perl. Current working	1003	Called after configuring, but before building perl. Current working
762	directory is the perl source directory.	1004	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		1005
767	=item postbuild	1006	=item postbuild
768		1007
769	Called after building, but before installing perl. Current working	1008	Called after building, but before installing perl. Current working
770	directory is the perl source directory.	1009	directory is the perl source directory.
…		…
808	A header file that contains the prototypes of the few symbols "exported"	1047	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.	1048	by bundle.c, and also exposes the perl headers to the application.
810		1049
811	=over 4	1050	=over 4
812		1051
813	=item staticperl_init ()	1052	=item staticperl_init (xs_init = 0)
814		1053
815	Initialises the perl interpreter. You can use the normal perl functions	1054	Initialises the perl interpreter. You can use the normal perl functions
816	after calling this function, for example, to define extra functions or	1055	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	1056	to load a .pm file that contains some initialisation code, or the main
818	program function:	1057	program function:
…		…
825	}	1064	}
826		1065
827	static void	1066	static void
828	run_myapp(void)	1067	run_myapp(void)
829	{	1068	{
830	staticperl_init ();	1069	staticperl_init (0);
831	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1070	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
832	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1071	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
833	}	1072	}
834		1073
		1074	When your bootcode already wants to access some XS functions at
		1075	compiletime, then you need to supply an C<xs_init> function pointer that
		1076	is called as soon as perl is initialised enough to define XS functions,
		1077	but before the preamble code is executed:
		1078
		1079	static void
		1080	xs_init (pTHX)
		1081	{
		1082	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1083	}
		1084
		1085	static void
		1086	run_myapp(void)
		1087	{
		1088	staticperl_init (xs_init);
		1089	}
		1090
		1091	=item staticperl_cleanup ()
		1092
		1093	In the unlikely case that you want to destroy the perl interpreter, here
		1094	is the corresponding function.
		1095
835	=item staticperl_xs_init (pTHX)	1096	=item staticperl_xs_init (pTHX)
836		1097
837	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1098	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	1099	which case you do not want to use C<staticperl_init> but call them on your
839	own.	1100	own.
840		1101
841	Then you need this function - either pass it directly as the C<xs_init>	1102	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.	1103	function to C<perl_parse>, or call it as one of the first things from your
843		1104	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		1105
849	=item PerlInterpreter *staticperl	1106	=item PerlInterpreter *staticperl
850		1107
851	The perl interpreter pointer used by staticperl. Not normally so useful,	1108	The perl interpreter pointer used by staticperl. Not normally so useful,
852	but there it is.	1109	but there it is.
…		…
888		1145
889	Returns the list of all paths embedded in this binary.	1146	Returns the list of all paths embedded in this binary.
890		1147
891	=back	1148	=back
892		1149
893	=head1 FULLY STATIC BINARIES - BUILDROOT	1150	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
894		1151
895	To make truly static (Linux-) libraries, you might want to have a look at	1152	To make truly static (Linux-) libraries, you might want to have a look at
896	buildroot (L<http://buildroot.uclibc.org/>).	1153	buildroot (L<http://buildroot.uclibc.org/>).
897		1154
898	Buildroot is primarily meant to set up a cross-compile environment (which	1155	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
905	good experiences with GCC 4.4.x but not GCC 4.5.	1162	good experiences with GCC 4.4.x but not GCC 4.5.
906		1163
907	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1164	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>	1165	-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	1166	doesn't decrease codesize much, but it makes the file much more
910	compressible.	1167	compressible (and the execution a lot slower...).
911		1168
912	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1169	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	1170	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	1171	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	1172	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
917	twice the address space needed for stacks).	1174	twice the address space needed for stacks).
918		1175
919	If you use C<linuxthreads.old>, then you should also be aware that	1176	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	1177	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	1178	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
922	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1179	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
923		1180
924	C<ccache> support is also recommended, especially if you want	1181	C<ccache> support is also recommended, especially if you want
925	to play around with buildroot options. Enabling the C<miniperl>	1182	to play around with buildroot options. Enabling the C<miniperl>
926	package will probably enable all options required for a successful	1183	package will probably enable all options required for a successful
927	perl build. F<staticperl> itself additionally needs either C<wget>	1184	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
935	it from working properly in a chroot - either use dash (and link it to	1192	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	1193	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
937	built-in ash shell.	1194	built-in ash shell.
938		1195
939	Finally, you need F</dev/null> inside the chroot for many scripts to work	1196	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	1197	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
941	both provide this.	1198	will provide this.
942		1199
943	After you have compiled and set up your buildroot target, you can copy	1200	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	1201	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>	1202	perl F<bin> directory (if you installed it) into the F<output/target>
946	filesystem, chroot inside and run it.	1203	filesystem, chroot inside and run it.
947		1204
948	=head1 RECIPES / SPECIFIC MODULES	1205	=head1 RECIPES / SPECIFIC MODULES
949		1206
950	This section contains some common(?) recipes and information about	1207	This section contains some common(?) recipes and information about
…		…
959		1216
960	Some functionality in the utf8 module, such as swash handling (used	1217	Some functionality in the utf8 module, such as swash handling (used
961	for unicode character ranges in regexes) is implemented in the	1218	for unicode character ranges in regexes) is implemented in the
962	C<"utf8_heavy.pl"> library:	1219	C<"utf8_heavy.pl"> library:
963		1220
964	-M'"utf8_heavy.pl"'	1221	-Mutf8_heavy.pl
965		1222
966	Many Unicode properties in turn are defined in separate modules,	1223	Many Unicode properties in turn are defined in separate modules,
967	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1224	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	1225	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
969	are big (7MB uncompressed, although F<staticperl> contains special	1226	are big (7MB uncompressed, although F<staticperl> contains special
970	handling for those files), so including them on demand by your application	1227	handling for those files), so including them on demand by your application
971	only might pay off.	1228	only might pay off.
972		1229
973	To simply include the whole unicode database, use:	1230	To simply include the whole unicode database, use:
974		1231
975	--incglob '/unicore/*.pl'	1232	--incglob '/unicore/**.pl'
976		1233
977	=item AnyEvent	1234	=item AnyEvent
978		1235
979	AnyEvent needs a backend implementation that it will load in a delayed	1236	AnyEvent needs a backend implementation that it will load in a delayed
980	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1237	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
985		1242
986	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1243	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	1244	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
988	C<"AnyEvent/Util/uts46data.pl">.	1245	C<"AnyEvent/Util/uts46data.pl">.
989		1246
990	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1247	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
991	everything.	1248	everything.
		1249
		1250	=item Cairo
		1251
		1252	See Glib, same problem, same solution.
992		1253
993	=item Carp	1254	=item Carp
994		1255
995	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1256	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.	1257	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
999		1260
1000	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1261	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	1262	turn might need L<"Config_heavy.pl">. Including the latter gives you
1002	both.	1263	both.
1003		1264
		1265	=item Glib
		1266
		1267	Glib literally requires Glib to be installed already to build - it tries
		1268	to fake this by running Glib out of the build directory before being
		1269	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1270	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1271
		1272	=item Gtk2
		1273
		1274	See Pango, same problems, same solution.
		1275
		1276	=item Pango
		1277
		1278	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1279	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1280	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1281
1004	=item Term::ReadLine::Perl	1282	=item Term::ReadLine::Perl
1005		1283
1006	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1284	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1007		1285
1008	=item URI	1286	=item URI
1009		1287
1010	URI implements schemes as separate modules - the generic URL scheme is	1288	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	1289	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,	1290	you need to use any of these schemes, you should include these manually,
1013	or use C<--usepacklist>.	1291	or use C<--usepacklists>.
1014		1292
1015	=back	1293	=back
1016		1294
1017	=head2 RECIPES	1295	=head2 RECIPES
1018		1296
1019	=over 4	1297	=over 4
1020		1298
1021	=item Linking everything in	1299	=item Just link everything in
1022		1300
1023	To link just about everything installed in the perl library into a new	1301	To link just about everything installed in the perl library into a new
1024	perl, try this:	1302	perl, try this (the first time this runs it will take a long time, as a
		1303	lot of files need to be parsed):
1025		1304
1026	staticperl mkperl --strip ppi --incglob '*'	1305	staticperl mkperl -v --strip ppi --incglob '*'
1027		1306
		1307	If you don't mind the extra megabytes, this can be a very effective way of
		1308	creating bundles without having to worry about forgetting any modules.
		1309
		1310	You get even more useful variants of this method by first selecting
		1311	everything, and then excluding stuff you are reasonable sure not to need -
		1312	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1313
1028	=item Getting rid of netdb function	1314	=item Getting rid of netdb functions
1029		1315
1030	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1316	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	1317	and so on) that few applications use. You can avoid compiling them in by
1032	putting the following fragment into a C<preconfigure> hook:	1318	putting the following fragment into a C<preconfigure> hook:
1033		1319
…		…
1050	do	1336	do
1051	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1337	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1052	done	1338	done
1053	}	1339	}
1054		1340
1055	This mostly gains space when linking staticaly, as the functions will	1341	This mostly gains space when linking statically, as the functions will
1056	liekly not be linked in. The gain for dynamically-linked binaries is	1342	likely not be linked in. The gain for dynamically-linked binaries is
1057	smaller.	1343	smaller.
1058		1344
1059	Also, this leaves C<gethostbyname> in - not only is it actually used	1345	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	1346	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	1347	gains little. Why Socket exposes a C function that is in the core already

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.46 by root, Wed Jun 29 14:37:59 2011 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.46 by root, Wed Jun 29 14:37:59 2011 UTC