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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.6 by root, Mon Dec 6 21:18:50 2010 UTC vs.
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 50 modules all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one 500kb file
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	staticperl help # print the embedded documentation	7	staticperl help # print the embedded documentation
8	staticperl fetch # fetch and unpack perl sources	8	staticperl fetch # fetch and unpack perl sources
14	staticperl cpan # invoke CPAN shell	14	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	15	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	16	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	17	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	18	staticperl mkperl <bundle-args...> # see documentation
		19	staticperl mkapp appname <bundle-args...> # see documentation
19		20
20	Typical Examples:	21	Typical Examples:
21		22
22	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
23	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
24	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V
25	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26	# build a perl with the above modules linked in	27	# build a perl with the above modules linked in
		28	staticperl mkapp myapp --boot mainprog mymodules
		29	# build a binary "myapp" from mainprog and mymodules
27		30
28	=head1 DESCRIPTION	31	=head1 DESCRIPTION
29		32
30	This script helps you creating single-file perl interpreters, or embedding	33	This script helps you to create single-file perl interpreters
31	a perl interpreter in your applications. Single-file means that it is	34	or applications, or embedding a perl interpreter in your
32	fully self-contained - no separate shared objects, no autoload fragments,	35	applications. Single-file means that it is fully self-contained - no
33	no .pm or .pl files are needed. And when linking statically, you can	36	separate shared objects, no autoload fragments, no .pm or .pl files are
34	create (or embed) a single file that contains perl interpreter, libc, all	37	needed. And when linking statically, you can create (or embed) a single
35	the modules you need and all the libraries you need.	38	file that contains perl interpreter, libc, all the modules you need, all
		39	the libraries you need and of course your actual program.
36		40
37	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary that	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38	contains perl and 50 modules such as AnyEvent, EV, IO::AIO, Coro and so	42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39	on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
		44
		45	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	modules: just follow the links at L<http://staticperl.schmorp.de/>.
40		48
41	The created files do not need write access to the file system (like PAR	49	The created files do not need write access to the file system (like PAR
42	does). In fact, since this script is in many ways similar to PAR::Packer,	50	does). In fact, since this script is in many ways similar to PAR::Packer,
43	here are the differences:	51	here are the differences:
44		52
…		…
63	=item * The generated executables don't need a writable filesystem.	71	=item * The generated executables don't need a writable filesystem.
64		72
65	F<staticperl> loads all required files directly from memory. There is no	73	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	74	need to unpack files into a temporary directory.
67		75
68	=item * More control over included files.	76	=item * More control over included files, more burden.
69		77
70	PAR tries to be maintenance and hassle-free - it tries to include more	78	PAR tries to be maintenance and hassle-free - it tries to include more
71	files than necessary to make sure everything works out of the box. The	79	files than necessary to make sure everything works out of the box. It
72	extra files (such as the unicode database) can take substantial amounts of	80	mostly succeeds at this, but he extra files (such as the unicode database)
73	memory and file size.	81	can take substantial amounts of memory and file size.
74		82
75	With F<staticperl>, the burden is mostly with the developer - only direct	83	With F<staticperl>, the burden is mostly with the developer - only direct
76	compile-time dependencies and L<AutoLoader> are handled automatically.	84	compile-time dependencies and L<AutoLoader> are handled automatically.
77	This means the modules to include often need to be tweaked manually.	85	This means the modules to include often need to be tweaked manually.
		86
		87	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	manually.
78		90
79	=item * PAR works out of the box, F<staticperl> does not.	91	=item * PAR works out of the box, F<staticperl> does not.
80		92
81	Maintaining your own custom perl build can be a pain in the ass, and while	93	Maintaining your own custom perl build can be a pain in the ass, and while
82	F<staticperl> tries to make this easy, it still requires a custom perl	94	F<staticperl> tries to make this easy, it still requires a custom perl
83	build and possibly fiddling with some modules. PAR is likely to produce	95	build and possibly fiddling with some modules. PAR is likely to produce
84	results faster.	96	results faster.
		97
		98	Ok, PAR never has worked for me out of the box, and for some people,
		99	F<staticperl> does work out of the box, as they don't count "fiddling with
		100	module use lists" against it, but nevertheless, F<staticperl> is certainly
		101	a bit more difficult to use.
85		102
86	=back	103	=back
87		104
88	=head1 HOW DOES IT WORK?	105	=head1 HOW DOES IT WORK?
89		106
…		…
98	Afterwards, you create a list of files and modules you want to include,	115	Afterwards, you create a list of files and modules you want to include,
99	and then either build a new perl binary (that acts just like a normal perl	116	and then either build a new perl binary (that acts just like a normal perl
100	except everything is compiled in), or you create bundle files (basically C	117	except everything is compiled in), or you create bundle files (basically C
101	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
102		119
103	This step is very fast (a few seconds if PPI is not used for stripping,	120	This step is very fast (a few seconds if PPI is not used for stripping, or
104	more seconds otherwise, as PPI is very slow), and can be tweaked and	121	the stripped files are in the cache), and can be tweaked and repeated as
105	repeated as often as necessary.	122	often as necessary.
106		123
107	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
108		125
109	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
110	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
111	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
112	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
113	F<bin/staticperl>, without any installation.	130	tarball as F<bin/staticperl>, without any installation. The
		131	newest (possibly alpha) version can also be downloaded from
		132	L<http://staticperl.schmorp.de/staticperl>.
114		133
115	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
116	optionally followed by any parameters.	135	optionally followed by any parameters.
117		136
118	There are two command categories: the "phase 1" commands which deal with	137	There are two command categories: the "phase 1" commands which deal with
…		…
128		147
129	The command	148	The command
130		149
131	staticperl install	150	staticperl install
132		151
133	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
134	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
135	perl interpreter if required.	154	perl interpreter if required.
136		155
137	Most of the following commands simply run one or more steps of this	156	Most of the following F<staticperl> subcommands simply run one or more
138	sequence.	157	steps of this sequence.
		158
		159	If it fails, then most commonly because the compiler options I selected
		160	are not supported by your compiler - either edit the F<staticperl> script
		161	yourself or create F<~/.staticperl> shell script where your set working
		162	C<PERL_CCFLAGS> etc. variables.
139		163
140	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
141	distclean> first.	165	distclean> first.
142		166
143	=over 4	167	=over 4
		168
		169	=item F<staticperl version>
		170
		171	Prints some info about the version of the F<staticperl> script you are using.
144		172
145	=item F<staticperl fetch>	173	=item F<staticperl fetch>
146		174
147	Runs only the download and unpack phase, unless this has already happened.	175	Runs only the download and unpack phase, unless this has already happened.
148		176
…		…
184	command by specifying all the directories with modules in them that you	212	command by specifying all the directories with modules in them that you
185	want to have built.	213	want to have built.
186		214
187	=item F<staticperl clean>	215	=item F<staticperl clean>
188		216
189	Runs F<make distclean> in the perl source directory (and potentially	217	Deletes the perl source directory (and potentially cleans up other
190	cleans up other intermediate files). This can be used to clean up	218	intermediate files). This can be used to clean up files only needed for
191	intermediate files without removing the installed perl interpreter.	219	building perl, without removing the installed perl interpreter.
		220
		221	At the moment, it doesn't delete downloaded tarballs.
		222
		223	The exact semantics of this command will probably change.
192		224
193	=item F<staticperl distclean>	225	=item F<staticperl distclean>
194		226
195	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
196	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
236	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	268	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
237	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	269	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
238	to include that module. I found out about these dependencies by carefully	270	to include that module. I found out about these dependencies by carefully
239	watching any error messages about missing modules...	271	watching any error messages about missing modules...
240		272
		273	Instead of building a new perl binary, you can also build a standalone
		274	application:
		275
		276	# build the app
		277	staticperl mkapp app --boot eg/httpd \
		278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		279
		280	# run it
		281	./app
		282
		283	Here are the three phase 2 commands:
		284
		285	=over 4
		286
		287	=item F<staticperl mkbundle> args...
		288
		289	The "default" bundle command - it interprets the given bundle options and
		290	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		291	files, useful for embedding.
		292
		293	=item F<staticperl mkperl> args...
		294
		295	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		296	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		297	links a new perl interpreter that embeds the created bundle, then deletes
		298	all intermediate files.
		299
		300	=item F<staticperl mkapp> filename args...
		301
		302	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		303	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		304	and links a new standalone application that simply initialises the perl
		305	interpreter.
		306
		307	The difference to F<staticperl mkperl> is that the standalone application
		308	does not act like a perl interpreter would - in fact, by default it would
		309	just do nothing and exit immediately, so you should specify some code to
		310	be executed via the F<--boot> option.
		311
		312	=back
		313
241	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
242		315
243	All options can be given as arguments on the command line (typically	316	All options can be given as arguments on the command line (typically
244	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	317	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
245	specifying a lot of modules can make the command line very cumbersome,	318	specifying a lot of modules can make the command line very cumbersome, you
246	you can put all long options into a "bundle specification file" (with or	319	can put all long options into a "bundle specification file" (one option
247	without C<--> prefix) and specify this bundle file instead.	320	per line, with or without C<--> prefix) and specify this bundle file
		321	instead.
248		322
249	For example, the command given earlier could also look like this:	323	For example, the command given earlier could also look like this:
250		324
251	staticperl mkperl httpd.bundle	325	staticperl mkperl httpd.bundle
252		326
…		…
257	use AnyEvent::HTTPD	331	use AnyEvent::HTTPD
258	use URI::http	332	use URI::http
259	add eg/httpd httpd.pm	333	add eg/httpd httpd.pm
260		334
261	All options that specify modules or files to be added are processed in the	335	All options that specify modules or files to be added are processed in the
262	order given on the command line (that affects the C<--use> and C<--eval>	336	order given on the command line.
263	options at the moment).
264		337
265	=head3 MKBUNDLE OPTIONS	338	=head3 BUNDLE CREATION WORKFLOW
		339
		340	F<staticperl mkbundle> works by first assembling a list of candidate
		341	files and modules to include, then filtering them by include/exclude
		342	patterns. The remaining modules (together with their direct depdendencies,
		343	such as link libraries and AutoLoader files) are then converted into
		344	bundle files suitable for embedding. Afterwards, F<staticperl mkbundle>
		345	can optionally build a new perl interpreter or a standalone application.
		346
		347	=over 4
		348
		349	=item Step 0: Generic argument processing.
		350
		351	The following options influence F<staticperl mkbundle> itself.
266		352
267	=over 4	353	=over 4
268		354
269	=item --verbose \| -v	355	=item --verbose \| -v
270		356
…		…
272		358
273	=item --quiet \| -q	359	=item --quiet \| -q
274		360
275	Decreases the verbosity level by one.	361	Decreases the verbosity level by one.
276		362
277	=item --strip none\|pod\|ppi	363	=item any other argument
278		364
279	Specify the stripping method applied to reduce the file of the perl	365	Any other argument is interpreted as a bundle specification file, which
280	sources included.	366	supports most long options (without extra quoting), one option per line.
281		367
282	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	368	=back
283	pod documentation, which is very fast and reduces file size a lot.
284		369
285	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	370	=item Step 1: gather candidate files and modules
286	saves a lot more than just L<Pod::Strip>, and is generally safer, but
287	is also a lot slower, so is best used for production builds. Note that
288	this method doesn't optimise for raw file size, but for best compression
289	(that means that the uncompressed file size is a bit larger, but the files
290	compress better, e.g. with F<upx>).
291		371
292	Last not least, in the unlikely case where C<pod> is too slow, or some	372	In this step, modules, perl libraries (F<.pl> files) and other files are
293	module gets mistreated, you can specify C<none> to not mangle included	373	selected for inclusion in the bundle. The relevant options are executed
294	perl sources in any way.	374	in order (this makes a difference mostly for C<--eval>, which can rely on
		375	earlier C<--use> options to have been executed).
295		376
296	=item --perl	377	=over 4
297		378
298	After writing out the bundle files, try to link a new perl interpreter. It
299	will be called F<perl> and will be left in the current working
300	directory. The bundle files will be removed.
301
302	This switch is automatically used when F<staticperl> is invoked with the
303	C<mkperl> command (instead of C<mkbundle>):
304
305	# build a new ./perl with only common::sense in it - very small :)
306	staticperl mkperl -Mcommon::sense
307
308	=item --use module \| -Mmodule	379	=item C<--use> F<module> \| C<-M>F<module>
309		380
310	Include the named module and all direct dependencies. This is done by	381	Include the named module and trace direct dependencies. This is done by
311	C<require>'ing the module in a subprocess and tracing which other modules	382	C<require>'ing the module in a subprocess and tracing which other modules
312	and files it actually loads. If the module uses L<AutoLoader>, then all	383	and files it actually loads.
313	splitfiles will be included as well.
314		384
315	Example: include AnyEvent and AnyEvent::Impl::Perl.	385	Example: include AnyEvent and AnyEvent::Impl::Perl.
316		386
317	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	387	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
318		388
…		…
329	staticperl mkbundle --use '"Config_heavy.pl"'	399	staticperl mkbundle --use '"Config_heavy.pl"'
330		400
331	# bundle specification file	401	# bundle specification file
332	use "Config_heavy.pl"	402	use "Config_heavy.pl"
333		403
334	The C<-Mmodule> syntax is included as an alias that might be easier to	404	The C<-M>module syntax is included as an alias that might be easier to
335	remember than C<use>. Or maybe it confuses people. Time will tell. Or	405	remember than C<--use>. Or maybe it confuses people. Time will tell. Or
336	maybe not. Argh.	406	maybe not. Sigh.
337		407
338	=item --eval "perl code" \| -e "perl code"	408	=item C<--eval> "perl code" \| C<-e> "perl code"
339		409
340	Sometimes it is easier (or necessary) to specify dependencies using perl	410	Sometimes it is easier (or necessary) to specify dependencies using perl
341	code, or maybe one of the modules you use need a special use statement. In	411	code, or maybe one of the modules you use need a special use statement. In
342	that case, you can use C<eval> to execute some perl snippet or set some	412	that case, you can use C<--eval> to execute some perl snippet or set some
343	variables or whatever you need. All files C<require>'d or C<use>'d in the	413	variables or whatever you need. All files C<require>'d or C<use>'d while
344	script are included in the final bundle.	414	executing the snippet are included in the final bundle.
345		415
346	Keep in mind that F<mkbundle> will only C<require> the modules named	416	Keep in mind that F<mkbundle> will only C<require> the modules named
347	by the C<--use> option, so do not expect the symbols from modules you	417	by the C<--use> option, so do not expect the symbols from modules you
348	C<--use>'d earlier on the command line to be available.	418	C<--use>'d earlier on the command line to be available.
349		419
…		…
351	in the final bundle.	421	in the final bundle.
352		422
353	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'	423	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
354		424
355	# or like this	425	# or like this
356	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'	426	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
357		427
358	Example: use a separate "bootstrap" script that C<use>'s lots of modules	428	Example: use a separate "bootstrap" script that C<use>'s lots of modules
359	and include this in the final bundle, to be executed automatically.	429	and also include this in the final bundle, to be executed automatically
		430	when the interpreter is initialised.
360		431
361	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap	432	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
362		433
363	=item --boot filename	434	=item C<--boot> F<filename>
364		435
365	Include the given file in the bundle and arrange for it to be executed	436	Include the given file in the bundle and arrange for it to be
366	(using a C<require>) before anything else when the new perl is	437	executed (using C<require>) before the main program when the new perl
367	initialised. This can be used to modify C<@INC> or anything else before	438	is initialised. This can be used to modify C<@INC> or do similar
368	the perl interpreter executes scripts given on the command line (or via	439	modifications before the perl interpreter executes scripts given on the
369	C<-e>). This works even in an embedded interpreter.	440	command line (or via C<-e>). This works even in an embedded interpreter -
		441	the file will be executed during interpreter initialisation in that case.
370		442
		443	=item C<--incglob> pattern
		444
		445	This goes through all standard library directories and tries to match any
		446	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		447	a file matches, it is added. The pattern is matched against the full path
		448	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		449
		450	This is very useful to include "everything":
		451
		452	--incglob '*'
		453
		454	It is also useful for including perl libraries, or trees of those, such as
		455	the unicode database files needed by some perl builtins, the regex engine
		456	and other modules.
		457
		458	--incglob '/unicore/**.pl'
		459
371	=item --add "file" \| --add "file alias"	460	=item C<--add> F<file> \| C<--add> "F<file> alias"
372		461
373	Adds the given (perl) file into the bundle (and optionally call it	462	Adds the given (perl) file into the bundle (and optionally call it
374	"alias"). This is useful to include any custom files into the bundle.	463	"alias"). The F<file> is either an absolute path or a path relative to
		464	the current directory. If an alias is specified, then this is the name it
		465	will use for C<@INC> searches, otherfile the F<file> will be used as the
		466	internal name.
375		467
376	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	468	This switch is used to include extra files into the bundle.
		469
		470	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		471	when creating the bundle.
377		472
378	staticperl mkperl --add "httpd httpd.pm"	473	staticperl mkperl --add "httpd httpd.pm"
379		474
380	It is also a great way to add any custom modules:	475	Example: add local files as extra modules in the bundle.
381		476
382	# specification file	477	# specification file
383	add file1 myfiles/file1	478	add file1 myfiles/file1.pm
384	add file2 myfiles/file2	479	add file2 myfiles/file2.pm
385	add file3 myfiles/file3	480	add file3 myfiles/file3.pl
		481
		482	# then later, in perl, use
		483	use myfiles::file1;
		484	require myfiles::file2;
		485	my $res = do "myfiles/file3.pl";
		486
		487	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		488
		489	Just like C<--add>, except that it treats the file as binary and adds it
		490	without any postprocessing (perl files might get stripped to reduce their
		491	size).
		492
		493	You should probably add a C</> prefix to avoid clashing with embedded perl
		494	files (whose paths do not start with C</>), and/or use a special directory
		495	prefix, such as C</res/name>.
		496
		497	You can later get a copy of these files by calling C<staticperl::find
		498	"alias">.
		499
		500	An alternative way to embed binary files is to convert them to perl and
		501	use C<do> to get the contents - this method is a bit cumbersome, but works
		502	both inside and outside of a staticperl bundle:
		503
		504	# a "binary" file, call it "bindata.pl"
		505	<<'SOME_MARKER'
		506	binary data NOT containing SOME_MARKER
		507	SOME_MARKER
		508
		509	# load the binary
		510	chomp (my $data = do "bindata.pl");
		511
		512	=back
		513
		514	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		515
		516	After all candidate files and modules are added, they are I<filtered>
		517	by a combination of C<--include> and C<--exclude> patterns (there is an
		518	implicit C<--include **> at the end, so if no filters are specified, all
		519	files are included).
		520
		521	All that this step does is potentially reduce the number of files that are
		522	to be included - no new files are added during this step.
		523
		524	=over 4
		525
		526	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		527
		528	These specify an include or exclude pattern to be applied to the candidate
		529	file list. An include makes sure that the given files will be part of the
		530	resulting file set, an exclude will exclude remaining files. The patterns
		531	are "extended glob patterns" (see below).
		532
		533	The patterns are applied "in order" - files included via earlier
		534	C<--include> specifications cannot be removed by any following
		535	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		536	cannot be added by any following C<--include>.
		537
		538	For example, to include everything except C<Devel> modules, but still
		539	include F<Devel::PPPort>, you could use this:
		540
		541	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		542
		543	=back
		544
		545	=item Step 3: add any extra or "hidden" dependencies.
		546
		547	F<staticperl> currently knows about three extra types of depdendencies
		548	that are added automatically. Only one (F<.packlist> files) is currently
		549	optional and can be influenced, the others are always included:
		550
		551	=over 4
		552
		553	=item C<--usepacklist>
		554
		555	Read F<.packlist> files for each distribution that happens to match a
		556	module name you specified. Sounds weird, and it is, so expect semantics to
		557	change somehow in the future.
		558
		559	The idea is that most CPAN distributions have a F<.pm> file that matches
		560	the name of the distribution (which is rather reasonable after all).
		561
		562	If this switch is enabled, then if any of the F<.pm> files that have been
		563	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		564	and F<.ix> files installed by this distribution are also included.
		565
		566	For example, using this switch, when the L<URI> module is specified, then
		567	all L<URI> submodules that have been installed via the CPAN distribution
		568	are included as well, so you don't have to manually specify them.
		569
		570	=item L<AutoLoader> splitfiles
		571
		572	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		573	are split into separate F<.al> files, and an index (F<.ix>) file contains
		574	the prototypes.
		575
		576	Both F<.ix> and F<.al> files will be detected automatically and added to
		577	the bundle.
		578
		579	=item link libraries (F<.a> files)
		580
		581	Modules using XS (or any other non-perl language extension compiled at
		582	installation time) will have a static archive (typically F<.a>). These
		583	will automatically be added to the linker options in F<bundle.ldopts>.
		584
		585	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		586	will warn about it - obviously this shouldn't happen unless you use
		587	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		588	use dynamic loading.
		589
		590	=item extra libraries (F<extralibs.ld>)
		591
		592	Some modules need linking against external libraries - these are found in
		593	F<extralibs.ld> and added to F<bundle.ldopts>.
		594
		595	=back
		596
		597	=item Step 4: write bundle files and optionally link a program
		598
		599	At this point, the select files will be read, processed (stripped) and
		600	finally the bundle files get written to disk, and F<staticperl mkbundle>
		601	is normally finished. Optionally, it can go a step further and either link
		602	a new F<perl> binary with all selected modules and files inside, or build
		603	a standalone application.
		604
		605	Both the contents of the bundle files and any extra linking is controlled
		606	by these options:
		607
		608	=over 4
		609
		610	=item C<--strip> C<none>\|C<pod>\|C<ppi>
		611
		612	Specify the stripping method applied to reduce the file of the perl
		613	sources included.
		614
		615	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
		616	pod documentation, which is very fast and reduces file size a lot.
		617
		618	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
		619	saves a lot more than just L<Pod::Strip>, and is generally safer,
		620	but is also a lot slower (some files take almost a minute to strip -
		621	F<staticperl> maintains a cache of stripped files to speed up subsequent
		622	runs for this reason). Note that this method doesn't optimise for raw file
		623	size, but for best compression (that means that the uncompressed file size
		624	is a bit larger, but the files compress better, e.g. with F<upx>).
		625
		626	Last not least, if you need accurate line numbers in error messages,
		627	or in the unlikely case where C<pod> is too slow, or some module gets
		628	mistreated, you can specify C<none> to not mangle included perl sources in
		629	any way.
		630
		631	=item --perl
		632
		633	After writing out the bundle files, try to link a new perl interpreter. It
		634	will be called F<perl> and will be left in the current working
		635	directory. The bundle files will be removed.
		636
		637	This switch is automatically used when F<staticperl> is invoked with the
		638	C<mkperl> command instead of C<mkbundle>.
		639
		640	Example: build a new F<./perl> binary with only L<common::sense> inside -
		641	it will be even smaller than the standard perl interpreter as none of the
		642	modules of the base distribution (such as L<Fcntl>) will be included.
		643
		644	staticperl mkperl -Mcommon::sense
		645
		646	=item --app name
		647
		648	After writing out the bundle files, try to link a new standalone
		649	program. It will be called C<name>, and the bundle files get removed after
		650	linking it.
		651
		652	This switch is automatically used when F<staticperl> is invoked with the
		653	C<mkapp> command instead of C<mkbundle>.
		654
		655	The difference to the (mutually exclusive) C<--perl> option is that the
		656	binary created by this option will not try to act as a perl interpreter -
		657	instead it will simply initialise the perl interpreter, clean it up and
		658	exit.
		659
		660	This means that, by default, it will do nothing but burna few CPU cycles
		661	- for it to do something useful you I<must> add some boot code, e.g. with
		662	the C<--boot> option.
		663
		664	Example: create a standalone perl binary called F<./myexe> that will
		665	execute F<appfile> when it is started.
		666
		667	staticperl mkbundle --app myexe --boot appfile
386		668
387	=item --static	669	=item --static
388		670
389	When C<--perl> is also given, link statically instead of dynamically. The	671	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		672	supported by the OS) executable will be created. This is not immensely
		673	useful when just creating the bundle files, but is most useful when
		674	linking a binary with the C<--perl> or C<--app> options.
		675
390	default is to link the new perl interpreter fully dynamic (that means all	676	The default is to link the new binary dynamically (that means all perl
391	perl modules are linked statically, but all external libraries are still	677	modules are linked statically, but all external libraries are still
392	referenced dynamically).	678	referenced dynamically).
393		679
394	Keep in mind that Solaris doesn't support static linking at all, and	680	Keep in mind that Solaris doesn't support static linking at all, and
395	systems based on GNU libc don't really support it in a usable fashion	681	systems based on GNU libc don't really support it in a very usable
396	either. Try uClibc if you want to create fully statically linked	682	fashion either. Try uClibc if you want to create fully statically linked
397	executables, or try the C<--staticlibs> option to link only some libraries	683	executables, or try the C<--staticlib> option to link only some libraries
398	statically.	684	statically.
399		685
400	=item any other argument	686	=item --staticlib libname
401		687
402	Any other argument is interpreted as a bundle specification file, which	688	When not linking fully statically, this option allows you to link specific
403	supports most long options (without extra quoting), one option per line.	689	libraries statically. What it does is simply replace all occurances of
		690	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		691	option.
404		692
405	=back	693	This will have no effect unless the library is actually linked against,
		694	specifically, C<--staticlib> will not link against the named library
		695	unless it would be linked against anyway.
406		696
		697	Example: link libcrypt statically into the binary.
		698
		699	staticperl mkperl -MIO::AIO --staticlib crypt
		700
		701	# ldopts might now contain:
		702	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		703
		704	=back
		705
		706	=back
		707
		708	=head3 EXTENDED GLOB PATTERNS
		709
		710	Some options of F<staticperl mkbundle> expect an I<extended glob
		711	pattern>. This is neither a normal shell glob nor a regex, but something
		712	in between. The idea has been copied from rsync, and there are the current
		713	matching rules:
		714
		715	=over 4
		716
		717	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		718
		719	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		720	nothing inside, and neither any other file or directory called F<unicore>
		721	anywhere else in the hierarchy.
		722
		723	=item Patterns not starting with F</> will be anchored at the end of the path.
		724
		725	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		726	hierarchy, but not any directories of the same name.
		727
		728	=item A F<*> matches any single component.
		729
		730	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		731	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		732	will not match slashes.
		733
		734	=item A F<**> matches anything.
		735
		736	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		737	no matter how deeply nested they are inside subdirectories.
		738
		739	=item A F<?> matches a single character within a component.
		740
		741	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		742	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		743
		744	=back
		745
407	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	746	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
408		747
409	During (each) startup, F<staticperl> tries to source the following shell	748	During (each) startup, F<staticperl> tries to source some shell files to
		749	allow you to fine-tune/override configuration settings.
		750
		751	In them you can override shell variables, or define shell functions
		752	("hooks") to be called at specific phases during installation. For
		753	example, you could define a C<postinstall> hook to install additional
		754	modules from CPAN each time you start from scratch.
		755
		756	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		757	to source the file named with it only. Otherwise, it tries the following
410	files in order:	758	shell files in order:
411		759
412	/etc/staticperlrc	760	/etc/staticperlrc
413	~/.staticperlrc	761	~/.staticperlrc
414	$STATICPERL/rc	762	$STATICPERL/rc
415		763
416	They can be used to override shell variables, or define functions to be
417	called at specific phases.
418
419	Note that the last file is erased during F<staticperl distclean>, so	764	Note that the last file is erased during F<staticperl distclean>, so
420	generally should not be used.	765	generally should not be used.
421		766
422	=head3 CONFIGURATION VARIABLES	767	=head3 CONFIGURATION VARIABLES
423		768
…		…
428	=item C<EMAIL>	773	=item C<EMAIL>
429		774
430	The e-mail address of the person who built this binary. Has no good	775	The e-mail address of the person who built this binary. Has no good
431	default, so should be specified by you.	776	default, so should be specified by you.
432		777
		778	=item C<CPAN>
		779
		780	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
		781
		782	=item C<EXTRA_MODULES>
		783
		784	Additional modules installed during F<staticperl install>. Here you can
		785	set which modules you want have to installed from CPAN.
		786
		787	Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO.
		788
		789	EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO"
		790
		791	Note that you can also use a C<postinstall> hook to achieve this, and
		792	more.
		793
433	=back	794	=back
434		795
435	=head4 Variables you might I<want> to override	796	=head4 Variables you might I<want> to override
436		797
437	=over 4	798	=over 4
438		799
		800	=item C<STATICPERL>
		801
		802	The directory where staticperl stores all its files
		803	(default: F<~/.staticperl>).
		804
		805	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
		806
		807	Usually set to C<1> to make modules "less inquisitive" during their
		808	installation, you can set any environment variable you want - some modules
		809	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
		810
439	=item C<PERLVER>	811	=item C<PERL_VERSION>
440		812
441	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	813	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
442	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is	814	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
443	about as big as 5.12.2).	815	about as big as 5.12.2).
444		816
445	=item C<CPAN>
446
447	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
448
449	=item C<EXTRA_MODULES>
450
451	Additional modules installed during F<staticperl install>. Here you can
452	set which modules you want have to installed from CPAN.
453
454	Example: I really really need EV, AnyEvent, Coro and IO::AIO.
455
456	EXTRA_MODULES="EV AnyEvent Coro IO::AIO"
457
458	Note that you can also use a C<postinstall> hook to achieve this, and
459	more.
460
461	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
462
463	Usually set to C<1> to make modules "less inquisitive" during their
464	installation, you can set any environment variable you want - some modules
465	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
466
467	=item C<STATICPERL>
468
469	The directory where staticperl stores all its files
470	(default: F<~/.staticperl>).
471
472	=item C<PREFIX>	817	=item C<PERL_PREFIX>
473		818
474	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	819	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
475	i.e. where the F<bin> and F<lib> subdirectories will end up.	820	i.e. where the F<bin> and F<lib> subdirectories will end up.
476		821
		822	=item C<PERL_CONFIGURE>
		823
		824	Additional Configure options - these are simply passed to the perl
		825	Configure script. For example, if you wanted to enable dynamic loading,
		826	you could pass C<-Dusedl>. To enable ithreads (Why would you want that
		827	insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads>
		828	and so on.
		829
		830	More commonly, you would either activate 64 bit integer support
		831	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
		832	reduce filesize further.
		833
477	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	834	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
478		835
479	These flags are passed to perl's F<Configure> script, and are generally	836	These flags are passed to perl's F<Configure> script, and are generally
480	optimised for small size (at the cost of performance). Since they also	837	optimised for small size (at the cost of performance). Since they also
481	contain subtle workarounds around various build issues, changing these	838	contain subtle workarounds around various build issues, changing these
482	usually requires understanding their default values - best look at the top	839	usually requires understanding their default values - best look at
483	of the F<staticperl> script for more info on these.	840	the top of the F<staticperl> script for more info on these, and use a
		841	F<~/.staticperlrc> to override them.
		842
		843	Most of the variables override (or modify) the corresponding F<Configure>
		844	variable, except C<PERL_CCFLAGS>, which gets appended.
484		845
485	=back	846	=back
486		847
487	=head4 Variables you probably I<do not want> to override	848	=head4 Variables you probably I<do not want> to override
488		849
489	=over 4	850	=over 4
		851
		852	=item C<MAKE>
		853
		854	The make command to use - default is C<make>.
490		855
491	=item C<MKBUNDLE>	856	=item C<MKBUNDLE>
492		857
493	Where F<staticperl> writes the C<mkbundle> command to	858	Where F<staticperl> writes the C<mkbundle> command to
494	(default: F<$STATICPERL/mkbundle>).	859	(default: F<$STATICPERL/mkbundle>).
…		…
517	instcpan Anyevent::AIO AnyEvent::HTTPD	882	instcpan Anyevent::AIO AnyEvent::HTTPD
518	}	883	}
519		884
520	=over 4	885	=over 4
521		886
		887	=item preconfigure
		888
		889	Called just before running F<./Configur> in the perl source
		890	directory. Current working directory is the perl source directory.
		891
		892	This can be used to set any C<PERL_xxx> variables, which might be costly
		893	to compute.
		894
522	=item postconfigure	895	=item postconfigure
523		896
524	Called after configuring, but before building perl. Current working	897	Called after configuring, but before building perl. Current working
525	directory is the perl source directory.	898	directory is the perl source directory.
526		899
527	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or	900	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
528	do any other modifications.	901	or do any other modifications.
529		902
530	=item postbuild	903	=item postbuild
531		904
532	Called after building, but before installing perl. Current working	905	Called after building, but before installing perl. Current working
533	directory is the perl source directory.	906	directory is the perl source directory.
…		…
548	The script must return with a zero exit status, or the installation will	921	The script must return with a zero exit status, or the installation will
549	fail.	922	fail.
550		923
551	=back	924	=back
552		925
		926	=head1 ANATOMY OF A BUNDLE
		927
		928	When not building a new perl binary, C<mkbundle> will leave a number of
		929	files in the current working directory, which can be used to embed a perl
		930	interpreter in your program.
		931
		932	Intimate knowledge of L<perlembed> and preferably some experience with
		933	embedding perl is highly recommended.
		934
		935	C<mkperl> (or the C<--perl> option) basically does this to link the new
		936	interpreter (it also adds a main program to F<bundle.>):
		937
		938	$Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts)
		939
		940	=over 4
		941
		942	=item bundle.h
		943
		944	A header file that contains the prototypes of the few symbols "exported"
		945	by bundle.c, and also exposes the perl headers to the application.
		946
		947	=over 4
		948
		949	=item staticperl_init ()
		950
		951	Initialises the perl interpreter. You can use the normal perl functions
		952	after calling this function, for example, to define extra functions or
		953	to load a .pm file that contains some initialisation code, or the main
		954	program function:
		955
		956	XS (xsfunction)
		957	{
		958	dXSARGS;
		959
		960	// now we have items, ST(i) etc.
		961	}
		962
		963	static void
		964	run_myapp(void)
		965	{
		966	staticperl_init ();
		967	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		968	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
		969	}
		970
		971	=item staticperl_xs_init (pTHX)
		972
		973	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
		974	which case you do not want to use C<staticperl_init> but call them on your
		975	own.
		976
		977	Then you need this function - either pass it directly as the C<xs_init>
		978	function to C<perl_parse>, or call it from your own C<xs_init> function.
		979
		980	=item staticperl_cleanup ()
		981
		982	In the unlikely case that you want to destroy the perl interpreter, here
		983	is the corresponding function.
		984
		985	=item PerlInterpreter *staticperl
		986
		987	The perl interpreter pointer used by staticperl. Not normally so useful,
		988	but there it is.
		989
		990	=back
		991
		992	=item bundle.ccopts
		993
		994	Contains the compiler options required to compile at least F<bundle.c> and
		995	any file that includes F<bundle.h> - you should probably use it in your
		996	C<CFLAGS>.
		997
		998	=item bundle.ldopts
		999
		1000	The linker options needed to link the final program.
		1001
		1002	=back
		1003
		1004	=head1 RUNTIME FUNCTIONALITY
		1005
		1006	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which
		1007	are required to access the bundled perl sources, but might be useful for
		1008	other purposes.
		1009
		1010	In addition, for the embedded loading of perl files to work, F<staticperl>
		1011	overrides the C<@INC> array.
		1012
		1013	=over 4
		1014
		1015	=item $file = staticperl::find $path
		1016
		1017	Returns the data associated with the given C<$path>
		1018	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
		1019	the UNIX path relative to the perl library directory.
		1020
		1021	Returns C<undef> if the file isn't embedded.
		1022
		1023	=item @paths = staticperl::list
		1024
		1025	Returns the list of all paths embedded in this binary.
		1026
		1027	=back
		1028
		1029	=head1 FULLY STATIC BINARIES - BUILDROOT
		1030
		1031	To make truly static (Linux-) libraries, you might want to have a look at
		1032	buildroot (L<http://buildroot.uclibc.org/>).
		1033
		1034	Buildroot is primarily meant to set up a cross-compile environment (which
		1035	is not so useful as perl doesn't quite like cross compiles), but it can also compile
		1036	a chroot environment where you can use F<staticperl>.
		1037
		1038	To do so, download buildroot, and enable "Build options => development
		1039	files in target filesystem" and optionally "Build options => gcc
		1040	optimization level (optimize for size)". At the time of writing, I had
		1041	good experiences with GCC 4.4.x but not GCC 4.5.
		1042
		1043	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
		1044	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
		1045	doesn't decrease codesize much, but it makes the file much more
		1046	compressible.
		1047
		1048	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
		1049	no thread support). For Coro, it is highly recommended to switch to a
		1050	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
		1051	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
		1052	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
		1053	twice the address space needed for stacks).
		1054
		1055	If you use C<linuxthreads.old>, then you should also be aware that
		1056	uClibc shares C<errno> between all threads when statically linking. See
		1057	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
		1058	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
		1059
		1060	C<ccache> support is also recommended, especially if you want
		1061	to play around with buildroot options. Enabling the C<miniperl>
		1062	package will probably enable all options required for a successful
		1063	perl build. F<staticperl> itself additionally needs either C<wget>
		1064	(recommended, for CPAN) or C<curl>.
		1065
		1066	As for shells, busybox should provide all that is needed, but the default
		1067	busybox configuration doesn't include F<comm> which is needed by perl -
		1068	either make a custom busybox config, or compile coreutils.
		1069
		1070	For the latter route, you might find that bash has some bugs that keep
		1071	it from working properly in a chroot - either use dash (and link it to
		1072	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
		1073	built-in ash shell.
		1074
		1075	Finally, you need F</dev/null> inside the chroot for many scripts to work
		1076	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
		1077	both provide this.
		1078
		1079	After you have compiled and set up your buildroot target, you can copy
		1080	F<staticperl> from the C<App::Staticperl> distribution or from your
		1081	perl f<bin> directory (if you installed it) into the F<output/target>
		1082	filesystem, chroot inside and run it.
		1083
		1084	=head1 RECIPES / SPECIFIC MODULES
		1085
		1086	This section contains some common(?) recipes and information about
		1087	problems with some common modules or perl constructs that require extra
		1088	files to be included.
		1089
		1090	=head2 MODULES
		1091
		1092	=over 4
		1093
		1094	=item utf8
		1095
		1096	Some functionality in the utf8 module, such as swash handling (used
		1097	for unicode character ranges in regexes) is implemented in the
		1098	C<"utf8_heavy.pl"> library:
		1099
		1100	-M'"utf8_heavy.pl"'
		1101
		1102	Many Unicode properties in turn are defined in separate modules,
		1103	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1104	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1105	are big (7MB uncompressed, although F<staticperl> contains special
		1106	handling for those files), so including them on demand by your application
		1107	only might pay off.
		1108
		1109	To simply include the whole unicode database, use:
		1110
		1111	--incglob '/unicore/*.pl'
		1112
		1113	=item AnyEvent
		1114
		1115	AnyEvent needs a backend implementation that it will load in a delayed
		1116	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1117	for AnyEvent if it can't find anything else, and is usually a safe
		1118	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1119	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1120	well.
		1121
		1122	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1123	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1124	C<"AnyEvent/Util/uts46data.pl">.
		1125
		1126	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		1127	everything.
		1128
		1129	=item Carp
		1130
		1131	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1132	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1133
		1134	=item Config
		1135
		1136	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1137	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1138	both.
		1139
		1140	=item Term::ReadLine::Perl
		1141
		1142	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1143
		1144	=item URI
		1145
		1146	URI implements schemes as separate modules - the generic URL scheme is
		1147	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1148	you need to use any of these schemes, you should include these manually,
		1149	or use C<--usepacklist>.
		1150
		1151	=back
		1152
		1153	=head2 RECIPES
		1154
		1155	=over 4
		1156
		1157	=item Linking everything in
		1158
		1159	To link just about everything installed in the perl library into a new
		1160	perl, try this:
		1161
		1162	staticperl mkperl --strip ppi --incglob '*'
		1163
		1164	=item Getting rid of netdb function
		1165
		1166	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1167	and so on) that few applications use. You can avoid compiling them in by
		1168	putting the following fragment into a C<preconfigure> hook:
		1169
		1170	preconfigure() {
		1171	for sym in \
		1172	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1173	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1174	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1175	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1176	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1177	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1178	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1179	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1180	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1181	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1182	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1183	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1184	d_getspnam_r d_getsbyname
		1185	# d_gethbyname
		1186	do
		1187	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1188	done
		1189	}
		1190
		1191	This mostly gains space when linking staticaly, as the functions will
		1192	likely not be linked in. The gain for dynamically-linked binaries is
		1193	smaller.
		1194
		1195	Also, this leaves C<gethostbyname> in - not only is it actually used
		1196	often, the L<Socket> module also exposes it, so leaving it out usually
		1197	gains little. Why Socket exposes a C function that is in the core already
		1198	is anybody's guess.
		1199
		1200	=back
		1201
553	=head1 AUTHOR	1202	=head1 AUTHOR
554		1203
555	Marc Lehmann <schmorp@schmorp.de>	1204	Marc Lehmann <schmorp@schmorp.de>
556	http://software.schmorp.de/pkg/staticperl.html	1205	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.6 by root, Mon Dec 6 21:18:50 2010 UTC vs. Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.6 by root, Mon Dec 6 21:18:50 2010 UTC vs.
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC