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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 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
…		…
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
150	staticperl install	151	staticperl install
151		152
152	Is normally all you need: It installs the perl interpreter in	153	is normally all you need: It installs the perl interpreter in
153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	154	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
154	perl interpreter if required.	155	perl interpreter if required.
155		156
156	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
157	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.
158		164
159	To force recompilation or reinstallation, you need to run F<staticperl	165	To force recompilation or reinstallation, you need to run F<staticperl
160	distclean> first.	166	distclean> first.
161		167
162	=over 4	168	=over 4
…		…
180		186
181	=item F<staticperl install>	187	=item F<staticperl install>
182		188
183	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
184	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
185		201
186	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
187		203
188	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
189	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
…		…
209		225
210	=item F<staticperl clean>	226	=item F<staticperl clean>
211		227
212	Deletes the perl source directory (and potentially cleans up other	228	Deletes the perl source directory (and potentially cleans up other
213	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
214	building perl, without removing the installed perl interpreter, or to	230	building perl, without removing the installed perl interpreter.
215	force a re-build from scratch.
216		231
217	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.
218		235
219	=item F<staticperl distclean>	236	=item F<staticperl distclean>
220		237
221	This wipes your complete F<~/.staticperl> directory. Be careful with this,	238	This wipes your complete F<~/.staticperl> directory. Be careful with this,
222	it nukes your perl download, perl sources, perl distribution and any	239	it nukes your perl download, perl sources, perl distribution and any
…		…
246		263
247	# first make sure we have perl and the required modules	264	# first make sure we have perl and the required modules
248	staticperl instcpan AnyEvent::HTTPD	265	staticperl instcpan AnyEvent::HTTPD
249		266
250	# now build the perl	267	# now build the perl
251	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	268	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
252	-MAnyEvent::HTTPD -MURI::http \	269	-MAnyEvent::HTTPD -MURI::http \
253	--add 'eg/httpd httpd.pm'	270	--add 'eg/httpd httpd.pm'
254		271
255	# finally, invoke it	272	# finally, invoke it
256	./perl -Mhttpd	273	./perl -Mhttpd
…		…
272	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	289	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
273		290
274	# run it	291	# run it
275	./app	292	./app
276		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
277	=head3 OPTION PROCESSING	325	=head3 OPTION PROCESSING
278		326
279	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
280	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
281	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
282	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"
283	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.
284		333
285	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:
286		336
287	staticperl mkperl httpd.bundle	337	staticperl mkperl httpd.bundle
288		338
289	And all options could be in F<httpd.bundle>:	339	With all options stored in the F<httpd.bundle> file (one option per line,
290		340	everything after the option is an argument):
		341
291	use "Config_heavy.pl"	342	use "Config_heavy.pl"
292	use AnyEvent::Impl::Perl	343	use AnyEvent::Impl::Perl
293	use AnyEvent::HTTPD	344	use AnyEvent::HTTPD
294	use URI::http	345	use URI::http
295	add eg/httpd httpd.pm	346	add eg/httpd httpd.pm
296		347
297	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
298	order given on the command line (that affects the C<--use> and C<--eval>	349	order given on the command line.
299	options at the moment).
300		350
301	=head3 PACKAGE SELECTION WORKFLOW	351	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
302		352
303	F<staticperl mkbundle> has a number of options to control package	353	F<staticperl mkbundle> works by first assembling a list of candidate
304	selection. This section describes how they interact with each other. Also,	354	files and modules to include, then filtering them by include/exclude
305	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,
306	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.
307		359
308	The idiom "in order" means "in order that they are specified on the
309	commandline". If you use a bundle specification file, then the options
310	will be processed as if they were given in place of the bundle file name.
311
312	=over 4	360	=over 4
313		361
314	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	362	=item Step 0: Generic argument processing.
315	C<--incglob> options, in order.
316		363
317	In addition, C<--use> and C<--eval> dependencies will be added when the	364	The following options influence F<staticperl mkbundle> itself.
318	options are processed.
319		365
320	=item 2. apply all C<--include> and C<--exclude> options, in order.
321
322	All this step does is potentially reduce the number of files already
323	selected or found in phase 1.
324
325	=item 3. find all modules (== F<.pm> files), gather their static archives
326	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
327	extra libraries they need for linking (F<extralibs.ld>) and optionally
328	evaluate any F<.packlist> files.
329
330	This step is required to link against XS extensions and also adds files
331	required for L<AutoLoader> to do it's job.
332
333	=back
334
335	After this, all the files selected for bundling will be read and processed
336	(stripped), the bundle files will be written, and optionally a new F<perl>
337	or application binary will be linked.
338
339	=head3 MKBUNDLE OPTIONS
340
341	=over 4	366	=over 4
342		367
343	=item --verbose \| -v	368	=item C<--verbose> \| C<-v>
344		369
345	Increases the verbosity level by one (the default is C<1>).	370	Increases the verbosity level by one (the default is C<1>).
346		371
347	=item --quiet \| -q	372	=item C<--quiet> \| C<-q>
348		373
349	Decreases the verbosity level by one.	374	Decreases the verbosity level by one.
350		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
351	=item --strip none\|pod\|ppi	669	=item C<--strip> C<none>\|C<pod>\|C<ppi>
352		670
353	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
354	sources included.	672	sources included.
355		673
356	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
…		…
367	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,
368	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
369	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
370	any way.	688	any way.
371		689
372	=item --perl	690	=item C<--perl>
373		691
374	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
375	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
376	directory. The bundle files will be removed.	694	directory. The bundle files will be removed.
377		695
378	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
379	C<mkperl> command (instead of C<mkbundle>):	697	C<mkperl> command instead of C<mkbundle>.
380		698
381	# 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
382	staticperl mkperl -Mcommon::sense	703	staticperl mkperl -Mcommon::sense
383		704
384	=item --app name	705	=item C<--app> F<name>
385		706
386	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
387	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
388	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>.
389		713
390	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
391	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 -
392	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
393	exit.	717	exit.
394		718
395	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
396	C<mkapp> command (instead of C<mkbundle>):
397
398	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
399	the C<--boot> option.	721	the C<--boot> option.
400		722
401	Example: create a standalone perl binary that will execute F<appfile> when	723	Example: create a standalone perl binary called F<./myexe> that will
402	it is started.	724	execute F<appfile> when it is started.
403		725
404	staticperl mkbundle --app myexe --boot appfile	726	staticperl mkbundle --app myexe --boot appfile
405		727
406	=item --use module \| -Mmodule	728	=item C<--ignore-env>
407		729
408	Include the named module and all direct dependencies. This is done by	730	Generates extra code to unset some environment variables before
409	C<require>'ing the module in a subprocess and tracing which other modules	731	initialising/running perl. Perl supports a lot of environment variables
410	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
411	splitfiles will be included as well.	733	standalone applications, and this option removes those known to cause
		734	trouble.
412		735
413	Example: include AnyEvent and AnyEvent::Impl::Perl.	736	Specifically, these are removed:
414		737
415	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.
416		742
417	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
418	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.
419	single or double quotes. When given on the command line, you probably need
420	to quote once more to avoid your shell interpreting it. Common cases that
421	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
422		745
423	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
424	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.
425		750
426	# bourne shell
427	staticperl mkbundle --use '"Config_heavy.pl"'
428
429	# bundle specification file
430	use "Config_heavy.pl"
431
432	The C<-Mmodule> syntax is included as an alias that might be easier to
433	remember than C<use>. Or maybe it confuses people. Time will tell. Or
434	maybe not. Argh.
435
436	=item --eval "perl code" \| -e "perl code"
437
438	Sometimes it is easier (or necessary) to specify dependencies using perl
439	code, or maybe one of the modules you use need a special use statement. In
440	that case, you can use C<eval> to execute some perl snippet or set some
441	variables or whatever you need. All files C<require>'d or C<use>'d in the
442	script are included in the final bundle.
443
444	Keep in mind that F<mkbundle> will only C<require> the modules named
445	by the C<--use> option, so do not expect the symbols from modules you
446	C<--use>'d earlier on the command line to be available.
447
448	Example: force L<AnyEvent> to detect a backend and therefore include it
449	in the final bundle.
450
451	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
452
453	# or like this
454	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
455
456	Example: use a separate "bootstrap" script that C<use>'s lots of modules
457	and include this in the final bundle, to be executed automatically.
458
459	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
460
461	=item --boot filename
462
463	Include the given file in the bundle and arrange for it to be executed
464	(using a C<require>) before anything else when the new perl is
465	initialised. This can be used to modify C<@INC> or anything else before
466	the perl interpreter executes scripts given on the command line (or via
467	C<-e>). This works even in an embedded interpreter.
468
469	=item --usepacklist
470
471	Read F<.packlist> files for each distribution that happens to match a
472	module name you specified. Sounds weird, and it is, so expect semantics to
473	change somehow in the future.
474
475	The idea is that most CPAN distributions have a F<.pm> file that matches
476	the name of the distribution (which is rather reasonable after all).
477
478	If this switch is enabled, then if any of the F<.pm> files that have been
479	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
480	and F<.ix> files installed by this distribution are also included.
481
482	For example, using this switch, when the L<URI> module is specified, then
483	all L<URI> submodules that have been installed via the CPAN distribution
484	are included as well, so you don't have to manually specify them.
485
486	=item --incglob pattern
487
488	This goes through all library directories and tries to match any F<.pm>
489	and F<.pl> files against the extended glob pattern (see below). If a file
490	matches, it is added. This switch will automatically detect L<AutoLoader>
491	files and the required link libraries for XS modules, but it will I<not>
492	scan the file for dependencies (at the moment).
493
494	This is mainly useful to include "everything":
495
496	--incglob '*'
497
498	Or to include perl libraries, or trees of those, such as the unicode
499	database files needed by many other modules:
500
501	--incglob '/unicore/**.pl'
502
503	=item --add file \| --add "file alias"
504
505	Adds the given (perl) file into the bundle (and optionally call it
506	"alias"). This is useful to include any custom files into the bundle.
507
508	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
509
510	staticperl mkperl --add "httpd httpd.pm"
511
512	It is also a great way to add any custom modules:
513
514	# specification file
515	add file1 myfiles/file1
516	add file2 myfiles/file2
517	add file3 myfiles/file3
518
519	=item --binadd file \| --add "file alias"
520
521	Just like C<--add>, except that it treats the file as binary and adds it
522	without any processing.
523
524	You should probably add a C</> prefix to avoid clashing with embedded
525	perl files (whose paths do not start with C</>), and/or use a special
526	directory, such as C</res/name>.
527
528	You can later get a copy of these files by calling C<staticperl::find
529	"alias">.
530
531	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
532
533	These two options define an include/exclude filter that is used after all
534	files selected by the other options have been found. Each include/exclude
535	is applied to all files found so far - an include makes sure that the
536	given files will be part of the resulting file set, an exclude will
537	exclude files. The patterns are "extended glob patterns" (see below).
538
539	For example, to include everything, except C<Devel> modules, but still
540	include F<Devel::PPPort>, you could use this:
541
542	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
543
544	=item --static	751	=item C<--static>
545		752
546	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
547	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
548	perl modules are linked statically, but all external libraries are still	759	modules are linked statically, but all external libraries are still
549	referenced dynamically).	760	referenced dynamically).
550		761
551	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
552	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
553	either. Try uClibc if you want to create fully statically linked	764	fashion either. Try uClibc if you want to create fully statically linked
554	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
555	statically.	766	statically.
556		767
557	=item --staticlib libname	768	=item C<--staticlib> libname
558		769
559	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
560	libraries statically. What it does is simply replace all occurances of	771	libraries statically. What it does is simply replace all occurrences of
561	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>
562	option.	773	option.
563		774
564	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,
565	specifically, C<--staticlib> will not link against the named library	776	specifically, C<--staticlib> will not link against the named library
566	unless it would be linked against anyway.	777	unless it would be linked against anyway.
567		778
568	Example: link libcrypt statically into the binary.	779	Example: link libcrypt statically into the final binary.
569		780
570	staticperl mkperl -MIO::AIO --staticlib crypt	781	staticperl mkperl -MIO::AIO --staticlib crypt
571		782
572	# ldopts might nwo contain:	783	# ldopts might now contain:
573	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	784	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
574		785
575	=item any other argument	786	=back
576
577	Any other argument is interpreted as a bundle specification file, which
578	supports most long options (without extra quoting), one option per line.
579		787
580	=back	788	=back
581		789
582	=head3 EXTENDED GLOB PATTERNS	790	=head3 EXTENDED GLOB PATTERNS
583		791
…		…
597	=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.
598		806
599	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
600	hierarchy, but not any directories of the same name.	808	hierarchy, but not any directories of the same name.
601		809
602	=item A F<*> matches any single component.	810	=item A F<*> matches anything within a single path component.
603		811
604	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
605	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<*>
606	will not match slashes.	814	will not match slashes.
607		815
…		…
674	=item C<STATICPERL>	882	=item C<STATICPERL>
675		883
676	The directory where staticperl stores all its files	884	The directory where staticperl stores all its files
677	(default: F<~/.staticperl>).	885	(default: F<~/.staticperl>).
678		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
679	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	899	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
680		900
681	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
682	installation, you can set any environment variable you want - some modules	902	installation, you can set any environment variable you want - some modules
683	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	903	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
684
685	=item C<PERL_VERSION>
686
687	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
688	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
689	about as big as 5.12.2).
690		904
691	=item C<PERL_PREFIX>	905	=item C<PERL_PREFIX>
692		906
693	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	907	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
694	i.e. where the F<bin> and F<lib> subdirectories will end up.	908	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
703		917
704	More commonly, you would either activate 64 bit integer support	918	More commonly, you would either activate 64 bit integer support
705	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	919	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
706	reduce filesize further.	920	reduce filesize further.
707		921
708	=item C<PERL_CC>, C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	922	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
709		923
710	These flags are passed to perl's F<Configure> script, and are generally	924	These flags are passed to perl's F<Configure> script, and are generally
711	optimised for small size (at the cost of performance). Since they also	925	optimised for small size (at the cost of performance). Since they also
712	contain subtle workarounds around various build issues, changing these	926	contain subtle workarounds around various build issues, changing these
713	usually requires understanding their default values - best look at the top	927	usually requires understanding their default values - best look at
714	of the F<staticperl> script for more info on these.	928	the top of the F<staticperl> script for more info on these, and use a
		929	F<~/.staticperlrc> to override them.
		930
		931	Most of the variables override (or modify) the corresponding F<Configure>
		932	variable, except C<PERL_CCFLAGS>, which gets appended.
		933
		934	You should have a look near the beginning of the F<staticperl> script -
		935	staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
		936	suitable for newer gcc versions. For other compilers or older versions you
		937	need to adjust these, for example, in your F<~/.staticperlrc>.
715		938
716	=back	939	=back
717		940
718	=head4 Variables you probably I<do not want> to override	941	=head4 Variables you probably I<do not want> to override
719		942
…		…
738	=head3 OVERRIDABLE HOOKS	961	=head3 OVERRIDABLE HOOKS
739		962
740	In addition to environment variables, it is possible to provide some	963	In addition to environment variables, it is possible to provide some
741	shell functions that are called at specific times. To provide your own	964	shell functions that are called at specific times. To provide your own
742	commands, just define the corresponding function.	965	commands, just define the corresponding function.
		966
		967	The actual order in which hooks are invoked during a full install
		968	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		969	C<postbuild>, C<postinstall>.
743		970
744	Example: install extra modules from CPAN and from some directories	971	Example: install extra modules from CPAN and from some directories
745	at F<staticperl install> time.	972	at F<staticperl install> time.
746		973
747	postinstall() {	974	postinstall() {
…		…
754		981
755	=over 4	982	=over 4
756		983
757	=item preconfigure	984	=item preconfigure
758		985
759	Called just before running F<./Configur> in the perl source	986	Called just before running F<./Configure> in the perl source
760	directory. Current working directory is the perl source directory.	987	directory. Current working directory is the perl source directory.
761		988
762	This can be used to set any C<PERL_xxx> variables, which might be costly	989	This can be used to set any C<PERL_xxx> variables, which might be costly
763	to compute.	990	to compute.
764		991
		992	=item patchconfig
		993
		994	Called after running F<./Configure> in the perl source directory to create
		995	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		996	config. Current working directory is the perl source directory.
		997
		998	Can be used to tailor/patch F<config.sh> or do any other modifications.
		999
765	=item postconfigure	1000	=item postconfigure
766		1001
767	Called after configuring, but before building perl. Current working	1002	Called after configuring, but before building perl. Current working
768	directory is the perl source directory.	1003	directory is the perl source directory.
769
770	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
771	or do any other modifications.
772		1004
773	=item postbuild	1005	=item postbuild
774		1006
775	Called after building, but before installing perl. Current working	1007	Called after building, but before installing perl. Current working
776	directory is the perl source directory.	1008	directory is the perl source directory.
…		…
814	A header file that contains the prototypes of the few symbols "exported"	1046	A header file that contains the prototypes of the few symbols "exported"
815	by bundle.c, and also exposes the perl headers to the application.	1047	by bundle.c, and also exposes the perl headers to the application.
816		1048
817	=over 4	1049	=over 4
818		1050
819	=item staticperl_init ()	1051	=item staticperl_init (xs_init = 0)
820		1052
821	Initialises the perl interpreter. You can use the normal perl functions	1053	Initialises the perl interpreter. You can use the normal perl functions
822	after calling this function, for example, to define extra functions or	1054	after calling this function, for example, to define extra functions or
823	to load a .pm file that contains some initialisation code, or the main	1055	to load a .pm file that contains some initialisation code, or the main
824	program function:	1056	program function:
…		…
831	}	1063	}
832		1064
833	static void	1065	static void
834	run_myapp(void)	1066	run_myapp(void)
835	{	1067	{
836	staticperl_init ();	1068	staticperl_init (0);
837	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1069	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
838	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1070	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
839	}	1071	}
840		1072
		1073	When your bootcode already wants to access some XS functions at
		1074	compiletime, then you need to supply an C<xs_init> function pointer that
		1075	is called as soon as perl is initialised enough to define XS functions,
		1076	but before the preamble code is executed:
		1077
		1078	static void
		1079	xs_init (pTHX)
		1080	{
		1081	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1082	}
		1083
		1084	static void
		1085	run_myapp(void)
		1086	{
		1087	staticperl_init (xs_init);
		1088	}
		1089
		1090	=item staticperl_cleanup ()
		1091
		1092	In the unlikely case that you want to destroy the perl interpreter, here
		1093	is the corresponding function.
		1094
841	=item staticperl_xs_init (pTHX)	1095	=item staticperl_xs_init (pTHX)
842		1096
843	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1097	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
844	which case you do not want to use C<staticperl_init> but call them on your	1098	which case you do not want to use C<staticperl_init> but call them on your
845	own.	1099	own.
846		1100
847	Then you need this function - either pass it directly as the C<xs_init>	1101	Then you need this function - either pass it directly as the C<xs_init>
848	function to C<perl_parse>, or call it from your own C<xs_init> function.	1102	function to C<perl_parse>, or call it as one of the first things from your
849		1103	own C<xs_init> function.
850	=item staticperl_cleanup ()
851
852	In the unlikely case that you want to destroy the perl interpreter, here
853	is the corresponding function.
854		1104
855	=item PerlInterpreter *staticperl	1105	=item PerlInterpreter *staticperl
856		1106
857	The perl interpreter pointer used by staticperl. Not normally so useful,	1107	The perl interpreter pointer used by staticperl. Not normally so useful,
858	but there it is.	1108	but there it is.
…		…
894		1144
895	Returns the list of all paths embedded in this binary.	1145	Returns the list of all paths embedded in this binary.
896		1146
897	=back	1147	=back
898		1148
899	=head1 FULLY STATIC BINARIES - BUILDROOT	1149	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
900		1150
901	To make truly static (Linux-) libraries, you might want to have a look at	1151	To make truly static (Linux-) libraries, you might want to have a look at
902	buildroot (L<http://buildroot.uclibc.org/>).	1152	buildroot (L<http://buildroot.uclibc.org/>).
903		1153
904	Buildroot is primarily meant to set up a cross-compile environment (which	1154	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
911	good experiences with GCC 4.4.x but not GCC 4.5.	1161	good experiences with GCC 4.4.x but not GCC 4.5.
912		1162
913	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1163	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
914	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>	1164	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
915	doesn't decrease codesize much, but it makes the file much more	1165	doesn't decrease codesize much, but it makes the file much more
916	compressible.	1166	compressible (and the execution a lot slower...).
917		1167
918	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1168	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
919	no thread support). For Coro, it is highly recommended to switch to a	1169	no thread support). For Coro, it is highly recommended to switch to a
920	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201	1170	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
921	snapshot) and enable NPTL, otherwise Coro needs to be configured with the	1171	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
923	twice the address space needed for stacks).	1173	twice the address space needed for stacks).
924		1174
925	If you use C<linuxthreads.old>, then you should also be aware that	1175	If you use C<linuxthreads.old>, then you should also be aware that
926	uClibc shares C<errno> between all threads when statically linking. See	1176	uClibc shares C<errno> between all threads when statically linking. See
927	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a	1177	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
928	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1178	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
929		1179
930	C<ccache> support is also recommended, especially if you want	1180	C<ccache> support is also recommended, especially if you want
931	to play around with buildroot options. Enabling the C<miniperl>	1181	to play around with buildroot options. Enabling the C<miniperl>
932	package will probably enable all options required for a successful	1182	package will probably enable all options required for a successful
933	perl build. F<staticperl> itself additionally needs either C<wget>	1183	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
941	it from working properly in a chroot - either use dash (and link it to	1191	it from working properly in a chroot - either use dash (and link it to
942	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's	1192	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
943	built-in ash shell.	1193	built-in ash shell.
944		1194
945	Finally, you need F</dev/null> inside the chroot for many scripts to work	1195	Finally, you need F</dev/null> inside the chroot for many scripts to work
946	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will	1196	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
947	both provide this.	1197	will provide this.
948		1198
949	After you have compiled and set up your buildroot target, you can copy	1199	After you have compiled and set up your buildroot target, you can copy
950	F<staticperl> from the C<App::Staticperl> distribution or from your	1200	F<staticperl> from the C<App::Staticperl> distribution or from your
951	perl f<bin> directory (if you installed it) into the F<output/target>	1201	perl F<bin> directory (if you installed it) into the F<output/target>
952	filesystem, chroot inside and run it.	1202	filesystem, chroot inside and run it.
953		1203
954	=head1 RECIPES / SPECIFIC MODULES	1204	=head1 RECIPES / SPECIFIC MODULES
955		1205
956	This section contains some common(?) recipes and information about	1206	This section contains some common(?) recipes and information about
…		…
965		1215
966	Some functionality in the utf8 module, such as swash handling (used	1216	Some functionality in the utf8 module, such as swash handling (used
967	for unicode character ranges in regexes) is implemented in the	1217	for unicode character ranges in regexes) is implemented in the
968	C<"utf8_heavy.pl"> library:	1218	C<"utf8_heavy.pl"> library:
969		1219
970	-M'"utf8_heavy.pl"'	1220	-Mutf8_heavy.pl
971		1221
972	Many Unicode properties in turn are defined in separate modules,	1222	Many Unicode properties in turn are defined in separate modules,
973	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1223	such as C<"unicore/Heavy.pl"> and more specific data tables such as
974	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1224	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
975	are big (7MB uncompressed, although F<staticperl> contains special	1225	are big (7MB uncompressed, although F<staticperl> contains special
976	handling for those files), so including them on demand by your application	1226	handling for those files), so including them on demand by your application
977	only might pay off.	1227	only might pay off.
978		1228
979	To simply include the whole unicode database, use:	1229	To simply include the whole unicode database, use:
980		1230
981	--incglob '/unicore/*.pl'	1231	--incglob '/unicore/**.pl'
982		1232
983	=item AnyEvent	1233	=item AnyEvent
984		1234
985	AnyEvent needs a backend implementation that it will load in a delayed	1235	AnyEvent needs a backend implementation that it will load in a delayed
986	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1236	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
991		1241
992	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1242	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
993	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1243	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
994	C<"AnyEvent/Util/uts46data.pl">.	1244	C<"AnyEvent/Util/uts46data.pl">.
995		1245
996	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1246	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
997	everything.	1247	everything.
		1248
		1249	=item Cairo
		1250
		1251	See Glib, same problem, same solution.
998		1252
999	=item Carp	1253	=item Carp
1000		1254
1001	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1255	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1002	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1256	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
1005		1259
1006	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1260	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1007	turn might need L<"Config_heavy.pl">. Including the latter gives you	1261	turn might need L<"Config_heavy.pl">. Including the latter gives you
1008	both.	1262	both.
1009		1263
		1264	=item Glib
		1265
		1266	Glib literally requires Glib to be installed already to build - it tries
		1267	to fake this by running Glib out of the build directory before being
		1268	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1269	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1270
		1271	=item Gtk2
		1272
		1273	See Pango, same problems, same solution.
		1274
		1275	=item Pango
		1276
		1277	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1278	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1279	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1280
1010	=item Term::ReadLine::Perl	1281	=item Term::ReadLine::Perl
1011		1282
1012	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1283	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1013		1284
1014	=item URI	1285	=item URI
1015		1286
1016	URI implements schemes as separate modules - the generic URL scheme is	1287	URI implements schemes as separate modules - the generic URL scheme is
1017	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1288	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1018	you need to use any of these schemes, you should include these manually,	1289	you need to use any of these schemes, you should include these manually,
1019	or use C<--usepacklist>.	1290	or use C<--usepacklists>.
1020		1291
1021	=back	1292	=back
1022		1293
1023	=head2 RECIPES	1294	=head2 RECIPES
1024		1295
1025	=over 4	1296	=over 4
1026		1297
1027	=item Linking everything in	1298	=item Just link everything in
1028		1299
1029	To link just about everything installed in the perl library into a new	1300	To link just about everything installed in the perl library into a new
1030	perl, try this:	1301	perl, try this (the first time this runs it will take a long time, as a
		1302	lot of files need to be parsed):
1031		1303
1032	staticperl mkperl --strip ppi --incglob '*'	1304	staticperl mkperl -v --strip ppi --incglob '*'
1033		1305
		1306	If you don't mind the extra megabytes, this can be a very effective way of
		1307	creating bundles without having to worry about forgetting any modules.
		1308
		1309	You get even more useful variants of this method by first selecting
		1310	everything, and then excluding stuff you are reasonable sure not to need -
		1311	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1312
1034	=item Getting rid of netdb function	1313	=item Getting rid of netdb functions
1035		1314
1036	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1315	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1037	and so on) that few applications use. You can avoid compiling them in by	1316	and so on) that few applications use. You can avoid compiling them in by
1038	putting the following fragment into a C<preconfigure> hook:	1317	putting the following fragment into a C<preconfigure> hook:
1039		1318
…		…
1056	do	1335	do
1057	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1336	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1058	done	1337	done
1059	}	1338	}
1060		1339
1061	This mostly gains space when linking staticaly, as the functions will	1340	This mostly gains space when linking statically, as the functions will
1062	likely not be linked in. The gain for dynamically-linked binaries is	1341	likely not be linked in. The gain for dynamically-linked binaries is
1063	smaller.	1342	smaller.
1064		1343
1065	Also, this leaves C<gethostbyname> in - not only is it actually used	1344	Also, this leaves C<gethostbyname> in - not only is it actually used
1066	often, the L<Socket> module also exposes it, so leaving it out usually	1345	often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs. Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC