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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.7 by root, Mon Dec 6 21:21:44 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 2011 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
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	staticperl mkapp appname <bundle-args...> # see documentation
19		21
20	Typical Examples:	22	Typical Examples:
21		23
22	staticperl install # fetch, configure, build and install perl	24	staticperl install # fetch, configure, build and install perl
23	staticperl cpan # run interactive cpan shell	25	staticperl cpan # run interactive cpan shell
24	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	26	staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
25	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	27	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26	# build a perl with the above modules linked in	28	# build a perl with the above modules linked in
		29	staticperl mkapp myapp --boot mainprog mymodules
		30	# build a binary "myapp" from mainprog and mymodules
27		31
28	=head1 DESCRIPTION	32	=head1 DESCRIPTION
29		33
30	This script helps you creating single-file perl interpreters, or embedding	34	This script helps you to create single-file perl interpreters
31	a perl interpreter in your applications. Single-file means that it is	35	or applications, or embedding a perl interpreter in your
32	fully self-contained - no separate shared objects, no autoload fragments,	36	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	37	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	38	needed. And when linking statically, you can create (or embed) a single
35	the modules you need and all the libraries you need.	39	file that contains perl interpreter, libc, all the modules you need, all
		40	the libraries you need and of course your actual program.
36		41
37	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary that	42	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	43	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39	on. Or any other choice of modules.	44	Coro and so on. Or any other choice of modules (and some other size :).
		45
		46	To see how this turns out, you can try out smallperl and bigperl, two
		47	pre-built static and compressed perl binaries with many and even more
		48	modules: just follow the links at L<http://staticperl.schmorp.de/>.
40		49
41	The created files do not need write access to the file system (like PAR	50	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,	51	does). In fact, since this script is in many ways similar to PAR::Packer,
43	here are the differences:	52	here are the differences:
44		53
63	=item * The generated executables don't need a writable filesystem.	72	=item * The generated executables don't need a writable filesystem.
64		73
65	F<staticperl> loads all required files directly from memory. There is no	74	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	75	need to unpack files into a temporary directory.
67		76
68	=item * More control over included files.	77	=item * More control over included files, more burden.
69		78
70	PAR tries to be maintenance and hassle-free - it tries to include more	79	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	80	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	81	mostly succeeds at this, but he extra files (such as the unicode database)
73	memory and file size.	82	can take substantial amounts of memory and file size.
74		83
75	With F<staticperl>, the burden is mostly with the developer - only direct	84	With F<staticperl>, the burden is mostly with the developer - only direct
76	compile-time dependencies and L<AutoLoader> are handled automatically.	85	compile-time dependencies and L<AutoLoader> are handled automatically.
77	This means the modules to include often need to be tweaked manually.	86	This means the modules to include often need to be tweaked manually.
		87
		88	All this does not preclude more permissive modes to be implemented in
		89	the future, but right now, you have to resolve state hidden dependencies
		90	manually.
78		91
79	=item * PAR works out of the box, F<staticperl> does not.	92	=item * PAR works out of the box, F<staticperl> does not.
80		93
81	Maintaining your own custom perl build can be a pain in the ass, and while	94	Maintaining your own custom perl build can be a pain in the ass, and while
82	F<staticperl> tries to make this easy, it still requires a custom perl	95	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	96	build and possibly fiddling with some modules. PAR is likely to produce
84	results faster.	97	results faster.
		98
		99	Ok, PAR never has worked for me out of the box, and for some people,
		100	F<staticperl> does work out of the box, as they don't count "fiddling with
		101	module use lists" against it, but nevertheless, F<staticperl> is certainly
		102	a bit more difficult to use.
85		103
86	=back	104	=back
87		105
88	=head1 HOW DOES IT WORK?	106	=head1 HOW DOES IT WORK?
89		107
…		…
98	Afterwards, you create a list of files and modules you want to include,	116	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	117	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	118	except everything is compiled in), or you create bundle files (basically C
101	sources you can use to embed all files into your project).	119	sources you can use to embed all files into your project).
102		120
103	This step is very fast (a few seconds if PPI is not used for stripping,	121	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	122	the stripped files are in the cache), and can be tweaked and repeated as
105	repeated as often as necessary.	123	often as necessary.
106		124
107	=head1 THE F<STATICPERL> SCRIPT	125	=head1 THE F<STATICPERL> SCRIPT
108		126
109	This module installs a script called F<staticperl> into your perl	127	This module installs a script called F<staticperl> into your perl
110	binary directory. The script is fully self-contained, and can be used	128	binary directory. The script is fully self-contained, and can be
111	without perl (for example, in an uClibc chroot environment). In fact,	129	used without perl (for example, in an uClibc chroot environment). In
112	it can be extracted from the C<App::Staticperl> distribution tarball as	130	fact, it can be extracted from the C<App::Staticperl> distribution
113	F<bin/staticperl>, without any installation.	131	tarball as F<bin/staticperl>, without any installation. The
		132	newest (possibly alpha) version can also be downloaded from
		133	L<http://staticperl.schmorp.de/staticperl>.
114		134
115	F<staticperl> interprets the first argument as a command to execute,	135	F<staticperl> interprets the first argument as a command to execute,
116	optionally followed by any parameters.	136	optionally followed by any parameters.
117		137
118	There are two command categories: the "phase 1" commands which deal with	138	There are two command categories: the "phase 1" commands which deal with
…		…
120	with creating binaries and bundle files.	140	with creating binaries and bundle files.
121		141
122	=head2 PHASE 1 COMMANDS: INSTALLING PERL	142	=head2 PHASE 1 COMMANDS: INSTALLING PERL
123		143
124	The most important command is F<install>, which does basically	144	The most important command is F<install>, which does basically
125	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
126	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
127	changed - see L<CONFIGURATION>, below.	147	changed - see L<CONFIGURATION>, below.
128		148
129	The command	149	The command
130		150
131	staticperl install	151	staticperl install
132		152
133	Is normally all you need: It installs the perl interpreter in	153	is normally all you need: It installs the perl interpreter in
134	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	154	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
135	perl interpreter if required.	155	perl interpreter if required.
136		156
137	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
138	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.
139		164
140	To force recompilation or reinstallation, you need to run F<staticperl	165	To force recompilation or reinstallation, you need to run F<staticperl
141	distclean> first.	166	distclean> first.
142		167
143	=over 4	168	=over 4
144		169
		170	=item F<staticperl version>
		171
		172	Prints some info about the version of the F<staticperl> script you are using.
		173
145	=item F<staticperl fetch>	174	=item F<staticperl fetch>
146		175
147	Runs only the download and unpack phase, unless this has already happened.	176	Runs only the download and unpack phase, unless this has already happened.
148		177
149	=item F<staticperl configure>	178	=item F<staticperl configure>
…		…
157		186
158	=item F<staticperl install>	187	=item F<staticperl install>
159		188
160	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
161	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
162		201
163	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
164		203
165	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
166	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
…		…
184	command by specifying all the directories with modules in them that you	223	command by specifying all the directories with modules in them that you
185	want to have built.	224	want to have built.
186		225
187	=item F<staticperl clean>	226	=item F<staticperl clean>
188		227
189	Runs F<make distclean> in the perl source directory (and potentially	228	Deletes the perl source directory (and potentially cleans up other
190	cleans up other intermediate files). This can be used to clean up	229	intermediate files). This can be used to clean up files only needed for
191	intermediate files without removing the installed perl interpreter.	230	building perl, without removing the installed perl interpreter.
		231
		232	At the moment, it doesn't delete downloaded tarballs.
		233
		234	The exact semantics of this command will probably change.
192		235
193	=item F<staticperl distclean>	236	=item F<staticperl distclean>
194		237
195	This wipes your complete F<~/.staticperl> directory. Be careful with this,	238	This wipes your complete F<~/.staticperl> directory. Be careful with this,
196	it nukes your perl download, perl sources, perl distribution and any	239	it nukes your perl download, perl sources, perl distribution and any
…		…
220		263
221	# first make sure we have perl and the required modules	264	# first make sure we have perl and the required modules
222	staticperl instcpan AnyEvent::HTTPD	265	staticperl instcpan AnyEvent::HTTPD
223		266
224	# now build the perl	267	# now build the perl
225	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	268	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
226	-MAnyEvent::HTTPD -MURI::http \	269	-MAnyEvent::HTTPD -MURI::http \
227	--add 'eg/httpd httpd.pm'	270	--add 'eg/httpd httpd.pm'
228		271
229	# finally, invoke it	272	# finally, invoke it
230	./perl -Mhttpd	273	./perl -Mhttpd
…		…
236	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	279	(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	280	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	281	to include that module. I found out about these dependencies by carefully
239	watching any error messages about missing modules...	282	watching any error messages about missing modules...
240		283
		284	Instead of building a new perl binary, you can also build a standalone
		285	application:
		286
		287	# build the app
		288	staticperl mkapp app --boot eg/httpd \
		289	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		290
		291	# run it
		292	./app
		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
241	=head3 OPTION PROCESSING	325	=head3 OPTION PROCESSING
242		326
243	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
244	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
245	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
246	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"
247	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.
248		333
249	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:
250		336
251	staticperl mkperl httpd.bundle	337	staticperl mkperl httpd.bundle
252		338
253	And all options could be in F<httpd.bundle>:	339	With all options stored in the F<httpd.bundle> file (one option per line,
254		340	everything after the option is an argument):
		341
255	use "Config_heavy.pl"	342	use "Config_heavy.pl"
256	use AnyEvent::Impl::Perl	343	use AnyEvent::Impl::Perl
257	use AnyEvent::HTTPD	344	use AnyEvent::HTTPD
258	use URI::http	345	use URI::http
259	add eg/httpd httpd.pm	346	add eg/httpd httpd.pm
260		347
261	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
262	order given on the command line (that affects the C<--use> and C<--eval>	349	order given on the command line.
263	options at the moment).
264		350
265	=head3 MKBUNDLE OPTIONS	351	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
266		352
267	=over 4	353	F<staticperl mkbundle> works by first assembling a list of candidate
		354	files and modules to include, then filtering them by include/exclude
		355	patterns. The remaining modules (together with their direct dependencies,
		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.
268		359
		360	=over 4
		361
		362	=item Step 0: Generic argument processing.
		363
		364	The following options influence F<staticperl mkbundle> itself.
		365
		366	=over 4
		367
269	=item --verbose \| -v	368	=item C<--verbose> \| C<-v>
270		369
271	Increases the verbosity level by one (the default is C<1>).	370	Increases the verbosity level by one (the default is C<1>).
272		371
273	=item --quiet \| -q	372	=item C<--quiet> \| C<-q>
274		373
275	Decreases the verbosity level by one.	374	Decreases the verbosity level by one.
276		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
277	=item --strip none\|pod\|ppi	669	=item C<--strip> C<none>\|C<pod>\|C<ppi>
278		670
279	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
280	sources included.	672	sources included.
281		673
282	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
283	pod documentation, which is very fast and reduces file size a lot.	675	pod documentation, which is very fast and reduces file size a lot.
284		676
285	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	677	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
286	saves a lot more than just L<Pod::Strip>, and is generally safer, but	678	saves a lot more than just L<Pod::Strip>, and is generally safer,
287	is also a lot slower, so is best used for production builds. Note that	679	but is also a lot slower (some files take almost a minute to strip -
288	this method doesn't optimise for raw file size, but for best compression	680	F<staticperl> maintains a cache of stripped files to speed up subsequent
289	(that means that the uncompressed file size is a bit larger, but the files	681	runs for this reason). Note that this method doesn't optimise for raw file
290	compress better, e.g. with F<upx>).	682	size, but for best compression (that means that the uncompressed file size
		683	is a bit larger, but the files compress better, e.g. with F<upx>).
291		684
		685	Last not least, if you need accurate line numbers in error messages,
292	Last not least, in the unlikely case where C<pod> is too slow, or some	686	or in the unlikely case where C<pod> is too slow, or some module gets
293	module gets mistreated, you can specify C<none> to not mangle included	687	mistreated, you can specify C<none> to not mangle included perl sources in
294	perl sources in any way.	688	any way.
295		689
296	=item --perl	690	=item C<--perl>
297		691
298	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
299	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
300	directory. The bundle files will be removed.	694	directory. The bundle files will be removed.
301		695
302	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
303	C<mkperl> command (instead of C<mkbundle>):	697	C<mkperl> command instead of C<mkbundle>.
304		698
305	# 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
306	staticperl mkperl -Mcommon::sense	703	staticperl mkperl -Mcommon::sense
307		704
308	=item --use module \| -Mmodule	705	=item C<--app> F<name>
309		706
310	Include the named module and all direct dependencies. This is done by	707	After writing out the bundle files, try to link a new standalone
311	C<require>'ing the module in a subprocess and tracing which other modules	708	program. It will be called C<name>, and the bundle files get removed after
312	and files it actually loads. If the module uses L<AutoLoader>, then all	709	linking it.
313	splitfiles will be included as well.
314		710
315	Example: include AnyEvent and AnyEvent::Impl::Perl.	711	This switch is automatically used when F<staticperl> is invoked with the
		712	C<mkapp> command instead of C<mkbundle>.
316		713
317	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	714	The difference to the (mutually exclusive) C<--perl> option is that the
		715	binary created by this option will not try to act as a perl interpreter -
		716	instead it will simply initialise the perl interpreter, clean it up and
		717	exit.
318		718
319	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	719	This means that, by default, it will do nothing but burn a few CPU cycles
320	maybe other weirdly named files. To do that, you need to quote the name in	720	- for it to do something useful you I<must> add some boot code, e.g. with
321	single or double quotes. When given on the command line, you probably need	721	the C<--boot> option.
322	to quote once more to avoid your shell interpreting it. Common cases that
323	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
324		722
325	Example: include the required files for F<perl -V> to work in all its	723	Example: create a standalone perl binary called F<./myexe> that will
326	glory (F<Config.pm> is included automatically by this).	724	execute F<appfile> when it is started.
327		725
328	# bourne shell	726	staticperl mkbundle --app myexe --boot appfile
329	staticperl mkbundle --use '"Config_heavy.pl"'
330		727
331	# bundle specification file	728	=item C<--ignore-env>
332	use "Config_heavy.pl"
333		729
334	The C<-Mmodule> syntax is included as an alias that might be easier to	730	Generates extra code to unset some environment variables before
335	remember than C<use>. Or maybe it confuses people. Time will tell. Or	731	initialising/running perl. Perl supports a lot of environment variables
336	maybe not. Argh.	732	that might alter execution in ways that might be undesirablre for
		733	standalone applications, and this option removes those known to cause
		734	trouble.
337		735
338	=item --eval "perl code" \| -e "perl code"	736	Specifically, these are removed:
339		737
340	Sometimes it is easier (or necessary) to specify dependencies using perl	738	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
341	code, or maybe one of the modules you use need a special use statement. In	739	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
342	that case, you can use C<eval> to execute some perl snippet or set some	740	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
343	variables or whatever you need. All files C<require>'d or C<use>'d in the	741	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
344	script are included in the final bundle.
345		742
346	Keep in mind that F<mkbundle> will only C<require> the modules named	743	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
347	by the C<--use> option, so do not expect the symbols from modules you	744	startup code used by F<staticperl> overrides C<@INC> in all cases.
348	C<--use>'d earlier on the command line to be available.
349		745
350	Example: force L<AnyEvent> to detect a backend and therefore include it	746	This option will not make your program more secure (unless you are
351	in the final bundle.	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.
352		750
353	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
354
355	# or like this
356	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
357
358	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.
360
361	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
362
363	=item --boot filename
364
365	Include the given file in the bundle and arrange for it to be executed
366	(using a C<require>) before anything else when the new perl is
367	initialised. This can be used to modify C<@INC> or anything else before
368	the perl interpreter executes scripts given on the command line (or via
369	C<-e>). This works even in an embedded interpreter.
370
371	=item --add "file" \| --add "file alias"
372
373	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.
375
376	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
377
378	staticperl mkperl --add "httpd httpd.pm"
379
380	It is also a great way to add any custom modules:
381
382	# specification file
383	add file1 myfiles/file1
384	add file2 myfiles/file2
385	add file3 myfiles/file3
386
387	=item --static	751	=item C<--static>
388		752
389	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
390	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
391	perl modules are linked statically, but all external libraries are still	759	modules are linked statically, but all external libraries are still
392	referenced dynamically).	760	referenced dynamically).
393		761
394	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
395	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
396	either. Try uClibc if you want to create fully statically linked	764	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	765	executables, or try the C<--staticlib> option to link only some libraries
398	statically.	766	statically.
399		767
400	=item any other argument	768	=item C<--staticlib> libname
401		769
402	Any other argument is interpreted as a bundle specification file, which	770	When not linking fully statically, this option allows you to link specific
403	supports most long options (without extra quoting), one option per line.	771	libraries statically. What it does is simply replace all occurrences of
		772	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		773	option.
404		774
405	=back	775	This will have no effect unless the library is actually linked against,
		776	specifically, C<--staticlib> will not link against the named library
		777	unless it would be linked against anyway.
406		778
		779	Example: link libcrypt statically into the final binary.
		780
		781	staticperl mkperl -MIO::AIO --staticlib crypt
		782
		783	# ldopts might now contain:
		784	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		785
		786	=back
		787
		788	=back
		789
		790	=head3 EXTENDED GLOB PATTERNS
		791
		792	Some options of F<staticperl mkbundle> expect an I<extended glob
		793	pattern>. This is neither a normal shell glob nor a regex, but something
		794	in between. The idea has been copied from rsync, and there are the current
		795	matching rules:
		796
		797	=over 4
		798
		799	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		800
		801	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		802	nothing inside, and neither any other file or directory called F<unicore>
		803	anywhere else in the hierarchy.
		804
		805	=item Patterns not starting with F</> will be anchored at the end of the path.
		806
		807	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		808	hierarchy, but not any directories of the same name.
		809
		810	=item A F<*> matches anything within a single path component.
		811
		812	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		813	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		814	will not match slashes.
		815
		816	=item A F<**> matches anything.
		817
		818	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		819	no matter how deeply nested they are inside subdirectories.
		820
		821	=item A F<?> matches a single character within a component.
		822
		823	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		824	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		825
		826	=back
		827
407	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	828	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
408		829
409	During (each) startup, F<staticperl> tries to source the following shell	830	During (each) startup, F<staticperl> tries to source some shell files to
		831	allow you to fine-tune/override configuration settings.
		832
		833	In them you can override shell variables, or define shell functions
		834	("hooks") to be called at specific phases during installation. For
		835	example, you could define a C<postinstall> hook to install additional
		836	modules from CPAN each time you start from scratch.
		837
		838	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		839	to source the file named with it only. Otherwise, it tries the following
410	files in order:	840	shell files in order:
411		841
412	/etc/staticperlrc	842	/etc/staticperlrc
413	~/.staticperlrc	843	~/.staticperlrc
414	$STATICPERL/rc	844	$STATICPERL/rc
415		845
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	846	Note that the last file is erased during F<staticperl distclean>, so
420	generally should not be used.	847	generally should not be used.
421		848
422	=head3 CONFIGURATION VARIABLES	849	=head3 CONFIGURATION VARIABLES
423		850
…		…
428	=item C<EMAIL>	855	=item C<EMAIL>
429		856
430	The e-mail address of the person who built this binary. Has no good	857	The e-mail address of the person who built this binary. Has no good
431	default, so should be specified by you.	858	default, so should be specified by you.
432		859
433	=back
434
435	=head4 Variables you might I<want> to override
436
437	=over 4
438
439	=item C<PERLVER>
440
441	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
443	about as big as 5.12.2).
444
445	=item C<CPAN>	860	=item C<CPAN>
446		861
447	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).	862	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
448		863
449	=item C<EXTRA_MODULES>	864	=item C<EXTRA_MODULES>
450		865
451	Additional modules installed during F<staticperl install>. Here you can	866	Additional modules installed during F<staticperl install>. Here you can
452	set which modules you want have to installed from CPAN.	867	set which modules you want have to installed from CPAN.
453		868
454	Example: I really really need EV, AnyEvent, Coro and IO::AIO.	869	Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO.
455		870
456	EXTRA_MODULES="EV AnyEvent Coro IO::AIO"	871	EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO"
457		872
458	Note that you can also use a C<postinstall> hook to achieve this, and	873	Note that you can also use a C<postinstall> hook to achieve this, and
459	more.	874	more.
		875
		876	=back
		877
		878	=head4 Variables you might I<want> to override
		879
		880	=over 4
		881
		882	=item C<STATICPERL>
		883
		884	The directory where staticperl stores all its files
		885	(default: F<~/.staticperl>).
		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).
460		898
461	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	899	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
462		900
463	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
464	installation, you can set any environment variable you want - some modules	902	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.	903	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
466		904
467	=item C<STATICPERL>
468
469	The directory where staticperl stores all its files
470	(default: F<~/.staticperl>).
471
472	=item C<PREFIX>	905	=item C<PERL_PREFIX>
473		906
474	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	907	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
475	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.
476		909
		910	=item C<PERL_CONFIGURE>
		911
		912	Additional Configure options - these are simply passed to the perl
		913	Configure script. For example, if you wanted to enable dynamic loading,
		914	you could pass C<-Dusedl>. To enable ithreads (Why would you want that
		915	insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads>
		916	and so on.
		917
		918	More commonly, you would either activate 64 bit integer support
		919	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
		920	reduce filesize further.
		921
477	=item 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>
478		923
479	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
480	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
481	contain subtle workarounds around various build issues, changing these	926	contain subtle workarounds around various build issues, changing these
482	usually requires understanding their default values - best look at the top	927	usually requires understanding their default values - best look at
483	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>.
484		938
485	=back	939	=back
486		940
487	=head4 Variables you probably I<do not want> to override	941	=head4 Variables you probably I<do not want> to override
488		942
489	=over 4	943	=over 4
		944
		945	=item C<MAKE>
		946
		947	The make command to use - default is C<make>.
490		948
491	=item C<MKBUNDLE>	949	=item C<MKBUNDLE>
492		950
493	Where F<staticperl> writes the C<mkbundle> command to	951	Where F<staticperl> writes the C<mkbundle> command to
494	(default: F<$STATICPERL/mkbundle>).	952	(default: F<$STATICPERL/mkbundle>).
…		…
503	=head3 OVERRIDABLE HOOKS	961	=head3 OVERRIDABLE HOOKS
504		962
505	In addition to environment variables, it is possible to provide some	963	In addition to environment variables, it is possible to provide some
506	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
507	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>.
508		970
509	Example: install extra modules from CPAN and from some directories	971	Example: install extra modules from CPAN and from some directories
510	at F<staticperl install> time.	972	at F<staticperl install> time.
511		973
512	postinstall() {	974	postinstall() {
…		…
517	instcpan Anyevent::AIO AnyEvent::HTTPD	979	instcpan Anyevent::AIO AnyEvent::HTTPD
518	}	980	}
519		981
520	=over 4	982	=over 4
521		983
		984	=item preconfigure
		985
		986	Called just before running F<./Configure> in the perl source
		987	directory. Current working directory is the perl source directory.
		988
		989	This can be used to set any C<PERL_xxx> variables, which might be costly
		990	to compute.
		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
522	=item postconfigure	1000	=item postconfigure
523		1001
524	Called after configuring, but before building perl. Current working	1002	Called after configuring, but before building perl. Current working
525	directory is the perl source directory.	1003	directory is the perl source directory.
526		1004
527	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or
528	do any other modifications.
529
530	=item postbuild	1005	=item postbuild
531		1006
532	Called after building, but before installing perl. Current working	1007	Called after building, but before installing perl. Current working
533	directory is the perl source directory.	1008	directory is the perl source directory.
534		1009
…		…
548	The script must return with a zero exit status, or the installation will	1023	The script must return with a zero exit status, or the installation will
549	fail.	1024	fail.
550		1025
551	=back	1026	=back
552		1027
		1028	=head1 ANATOMY OF A BUNDLE
		1029
		1030	When not building a new perl binary, C<mkbundle> will leave a number of
		1031	files in the current working directory, which can be used to embed a perl
		1032	interpreter in your program.
		1033
		1034	Intimate knowledge of L<perlembed> and preferably some experience with
		1035	embedding perl is highly recommended.
		1036
		1037	C<mkperl> (or the C<--perl> option) basically does this to link the new
		1038	interpreter (it also adds a main program to F<bundle.>):
		1039
		1040	$Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts)
		1041
		1042	=over 4
		1043
		1044	=item bundle.h
		1045
		1046	A header file that contains the prototypes of the few symbols "exported"
		1047	by bundle.c, and also exposes the perl headers to the application.
		1048
		1049	=over 4
		1050
		1051	=item staticperl_init (xs_init = 0)
		1052
		1053	Initialises the perl interpreter. You can use the normal perl functions
		1054	after calling this function, for example, to define extra functions or
		1055	to load a .pm file that contains some initialisation code, or the main
		1056	program function:
		1057
		1058	XS (xsfunction)
		1059	{
		1060	dXSARGS;
		1061
		1062	// now we have items, ST(i) etc.
		1063	}
		1064
		1065	static void
		1066	run_myapp(void)
		1067	{
		1068	staticperl_init (0);
		1069	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1070	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
		1071	}
		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
		1095	=item staticperl_xs_init (pTHX)
		1096
		1097	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
		1098	which case you do not want to use C<staticperl_init> but call them on your
		1099	own.
		1100
		1101	Then you need this function - either pass it directly as the C<xs_init>
		1102	function to C<perl_parse>, or call it as one of the first things from your
		1103	own C<xs_init> function.
		1104
		1105	=item PerlInterpreter *staticperl
		1106
		1107	The perl interpreter pointer used by staticperl. Not normally so useful,
		1108	but there it is.
		1109
		1110	=back
		1111
		1112	=item bundle.ccopts
		1113
		1114	Contains the compiler options required to compile at least F<bundle.c> and
		1115	any file that includes F<bundle.h> - you should probably use it in your
		1116	C<CFLAGS>.
		1117
		1118	=item bundle.ldopts
		1119
		1120	The linker options needed to link the final program.
		1121
		1122	=back
		1123
		1124	=head1 RUNTIME FUNCTIONALITY
		1125
		1126	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which
		1127	are required to access the bundled perl sources, but might be useful for
		1128	other purposes.
		1129
		1130	In addition, for the embedded loading of perl files to work, F<staticperl>
		1131	overrides the C<@INC> array.
		1132
		1133	=over 4
		1134
		1135	=item $file = staticperl::find $path
		1136
		1137	Returns the data associated with the given C<$path>
		1138	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
		1139	the UNIX path relative to the perl library directory.
		1140
		1141	Returns C<undef> if the file isn't embedded.
		1142
		1143	=item @paths = staticperl::list
		1144
		1145	Returns the list of all paths embedded in this binary.
		1146
		1147	=back
		1148
		1149	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
		1150
		1151	To make truly static (Linux-) libraries, you might want to have a look at
		1152	buildroot (L<http://buildroot.uclibc.org/>).
		1153
		1154	Buildroot is primarily meant to set up a cross-compile environment (which
		1155	is not so useful as perl doesn't quite like cross compiles), but it can also compile
		1156	a chroot environment where you can use F<staticperl>.
		1157
		1158	To do so, download buildroot, and enable "Build options => development
		1159	files in target filesystem" and optionally "Build options => gcc
		1160	optimization level (optimize for size)". At the time of writing, I had
		1161	good experiences with GCC 4.4.x but not GCC 4.5.
		1162
		1163	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
		1164	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
		1165	doesn't decrease codesize much, but it makes the file much more
		1166	compressible (and the execution a lot slower...).
		1167
		1168	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
		1169	no thread support). For Coro, it is highly recommended to switch to a
		1170	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
		1171	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
		1172	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
		1173	twice the address space needed for stacks).
		1174
		1175	If you use C<linuxthreads.old>, then you should also be aware that
		1176	uClibc shares C<errno> between all threads when statically linking. See
		1177	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
		1178	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
		1179
		1180	C<ccache> support is also recommended, especially if you want
		1181	to play around with buildroot options. Enabling the C<miniperl>
		1182	package will probably enable all options required for a successful
		1183	perl build. F<staticperl> itself additionally needs either C<wget>
		1184	(recommended, for CPAN) or C<curl>.
		1185
		1186	As for shells, busybox should provide all that is needed, but the default
		1187	busybox configuration doesn't include F<comm> which is needed by perl -
		1188	either make a custom busybox config, or compile coreutils.
		1189
		1190	For the latter route, you might find that bash has some bugs that keep
		1191	it from working properly in a chroot - either use dash (and link it to
		1192	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
		1193	built-in ash shell.
		1194
		1195	Finally, you need F</dev/null> inside the chroot for many scripts to work
		1196	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
		1197	will provide this.
		1198
		1199	After you have compiled and set up your buildroot target, you can copy
		1200	F<staticperl> from the C<App::Staticperl> distribution or from your
		1201	perl F<bin> directory (if you installed it) into the F<output/target>
		1202	filesystem, chroot inside and run it.
		1203
		1204	=head1 RECIPES / SPECIFIC MODULES
		1205
		1206	This section contains some common(?) recipes and information about
		1207	problems with some common modules or perl constructs that require extra
		1208	files to be included.
		1209
		1210	=head2 MODULES
		1211
		1212	=over 4
		1213
		1214	=item utf8
		1215
		1216	Some functionality in the utf8 module, such as swash handling (used
		1217	for unicode character ranges in regexes) is implemented in the
		1218	C<"utf8_heavy.pl"> library:
		1219
		1220	-Mutf8_heavy.pl
		1221
		1222	Many Unicode properties in turn are defined in separate modules,
		1223	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1224	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1225	are big (7MB uncompressed, although F<staticperl> contains special
		1226	handling for those files), so including them on demand by your application
		1227	only might pay off.
		1228
		1229	To simply include the whole unicode database, use:
		1230
		1231	--incglob '/unicore/**.pl'
		1232
		1233	=item AnyEvent
		1234
		1235	AnyEvent needs a backend implementation that it will load in a delayed
		1236	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1237	for AnyEvent if it can't find anything else, and is usually a safe
		1238	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1239	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1240	well.
		1241
		1242	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1243	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1244	C<"AnyEvent/Util/uts46data.pl">.
		1245
		1246	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1247	everything.
		1248
		1249	=item Cairo
		1250
		1251	See Glib, same problem, same solution.
		1252
		1253	=item Carp
		1254
		1255	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1256	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1257
		1258	=item Config
		1259
		1260	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1261	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1262	both.
		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
		1281	=item Term::ReadLine::Perl
		1282
		1283	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
		1284
		1285	=item URI
		1286
		1287	URI implements schemes as separate modules - the generic URL scheme is
		1288	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1289	you need to use any of these schemes, you should include these manually,
		1290	or use C<--usepacklists>.
		1291
		1292	=back
		1293
		1294	=head2 RECIPES
		1295
		1296	=over 4
		1297
		1298	=item Just link everything in
		1299
		1300	To link just about everything installed in the perl library into a new
		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):
		1303
		1304	staticperl mkperl -v --strip ppi --incglob '*'
		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
		1313	=item Getting rid of netdb functions
		1314
		1315	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1316	and so on) that few applications use. You can avoid compiling them in by
		1317	putting the following fragment into a C<preconfigure> hook:
		1318
		1319	preconfigure() {
		1320	for sym in \
		1321	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1322	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1323	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1324	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1325	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1326	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1327	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1328	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1329	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1330	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1331	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1332	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1333	d_getspnam_r d_getsbyname
		1334	# d_gethbyname
		1335	do
		1336	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1337	done
		1338	}
		1339
		1340	This mostly gains space when linking statically, as the functions will
		1341	likely not be linked in. The gain for dynamically-linked binaries is
		1342	smaller.
		1343
		1344	Also, this leaves C<gethostbyname> in - not only is it actually used
		1345	often, the L<Socket> module also exposes it, so leaving it out usually
		1346	gains little. Why Socket exposes a C function that is in the core already
		1347	is anybody's guess.
		1348
		1349	=back
		1350
553	=head1 AUTHOR	1351	=head1 AUTHOR
554		1352
555	Marc Lehmann <schmorp@schmorp.de>	1353	Marc Lehmann <schmorp@schmorp.de>
556	http://software.schmorp.de/pkg/staticperl.html	1354	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.7 by root, Mon Dec 6 21:21:44 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.7 by root, Mon Dec 6 21:21:44 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC