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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.58 by root, Sun Jun 16 04:38:38 2013 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 100 modules, all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one standalone 500kb file
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	staticperl help # print the embedded documentation	7	staticperl help # print the embedded documentation
8	staticperl fetch # fetch and unpack perl sources	8	staticperl fetch # fetch and unpack perl sources
9	staticperl configure # fetch and then configure perl	9	staticperl configure # fetch and then configure perl
10	staticperl build # configure and then build perl	10	staticperl build # configure and then build perl
11	staticperl install # build and then install perl	11	staticperl install # build and then install perl
12	staticperl clean # clean most intermediate files (restart at configure)	12	staticperl clean # clean most intermediate files (restart at configure)
13	staticperl distclean # delete everything installed by this script	13	staticperl distclean # delete everything installed by this script
		14	staticperl perl ... # invoke the perlinterpreter
14	staticperl cpan # invoke CPAN shell	15	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	16	staticperl instsrc path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	17	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	18	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	19	staticperl mkperl <bundle-args...> # see documentation
		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	42	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,	43	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39	Coro and so on. Or any other choice of modules.	44	Coro and so on. Or any other choice of modules (and some other size :).
		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 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
…		…
103	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,
104	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
105	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
106	sources you can use to embed all files into your project).	119	sources you can use to embed all files into your project).
107		120
108	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
109	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
110	repeated as often as necessary.	123	often as necessary.
111		124
112	=head1 THE F<STATICPERL> SCRIPT	125	=head1 THE F<STATICPERL> SCRIPT
113		126
114	This module installs a script called F<staticperl> into your perl	127	This module installs a script called F<staticperl> into your perl
115	binary directory. The script is fully self-contained, and can be used	128	binary directory. The script is fully self-contained, and can be
116	without perl (for example, in an uClibc chroot environment). In fact,	129	used without perl (for example, in an uClibc chroot environment). In
117	it can be extracted from the C<App::Staticperl> distribution tarball as	130	fact, it can be extracted from the C<App::Staticperl> distribution
118	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>.
119		134
120	F<staticperl> interprets the first argument as a command to execute,	135	F<staticperl> interprets the first argument as a command to execute,
121	optionally followed by any parameters.	136	optionally followed by any parameters.
122		137
123	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
…		…
125	with creating binaries and bundle files.	140	with creating binaries and bundle files.
126		141
127	=head2 PHASE 1 COMMANDS: INSTALLING PERL	142	=head2 PHASE 1 COMMANDS: INSTALLING PERL
128		143
129	The most important command is F<install>, which does basically	144	The most important command is F<install>, which does basically
130	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
131	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
132	changed - see L<CONFIGURATION>, below.	147	changed - see L<CONFIGURATION>, below.
133		148
134	The command	149	The command
135		150
136	staticperl install	151	staticperl install
137		152
138	Is normally all you need: It installs the perl interpreter in	153	is normally all you need: It installs the perl interpreter in
139	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	154	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
140	perl interpreter if required.	155	perl interpreter if required.
141		156
142	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
143	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.
144		164
145	To force recompilation or reinstallation, you need to run F<staticperl	165	To force recompilation or reinstallation, you need to run F<staticperl
146	distclean> first.	166	distclean> first.
147		167
148	=over 4	168	=over 4
149		169
		170	=item F<staticperl version>
		171
		172	Prints some info about the version of the F<staticperl> script you are using.
		173
150	=item F<staticperl fetch>	174	=item F<staticperl fetch>
151		175
152	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.
153		177
154	=item F<staticperl configure>	178	=item F<staticperl configure>
…		…
162		186
163	=item F<staticperl install>	187	=item F<staticperl install>
164		188
165	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
166	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
167		201
168	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
169		203
170	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
171	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
172	no magic is involved: you could just as well run it manually via	206	no magic is involved: you could just as well run it manually via
173	F<~/.staticperl/perl/bin/cpan>.	207	F<~/.staticperl/perl/bin/cpan>, except that F<staticperl> additionally
		208	sets the environment variable C<$PERL> to the path of the perl
		209	interpreter, which is handy in subshells.
174		210
175	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
176		212
177	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
178		214
…		…
191		227
192	=item F<staticperl clean>	228	=item F<staticperl clean>
193		229
194	Deletes the perl source directory (and potentially cleans up other	230	Deletes the perl source directory (and potentially cleans up other
195	intermediate files). This can be used to clean up files only needed for	231	intermediate files). This can be used to clean up files only needed for
196	building perl, without removing the installed perl interpreter, or to	232	building perl, without removing the installed perl interpreter.
197	force a re-build from scratch.
198		233
199	At the moment, it doesn't delete downloaded tarballs.	234	At the moment, it doesn't delete downloaded tarballs.
		235
		236	The exact semantics of this command will probably change.
200		237
201	=item F<staticperl distclean>	238	=item F<staticperl distclean>
202		239
203	This wipes your complete F<~/.staticperl> directory. Be careful with this,	240	This wipes your complete F<~/.staticperl> directory. Be careful with this,
204	it nukes your perl download, perl sources, perl distribution and any	241	it nukes your perl download, perl sources, perl distribution and any
…		…
228		265
229	# first make sure we have perl and the required modules	266	# first make sure we have perl and the required modules
230	staticperl instcpan AnyEvent::HTTPD	267	staticperl instcpan AnyEvent::HTTPD
231		268
232	# now build the perl	269	# now build the perl
233	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	270	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
234	-MAnyEvent::HTTPD -MURI::http \	271	-MAnyEvent::HTTPD -MURI::http \
235	--add 'eg/httpd httpd.pm'	272	--add 'eg/httpd httpd.pm'
236		273
237	# finally, invoke it	274	# finally, invoke it
238	./perl -Mhttpd	275	./perl -Mhttpd
…		…
244	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	281	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
245	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	282	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
246	to include that module. I found out about these dependencies by carefully	283	to include that module. I found out about these dependencies by carefully
247	watching any error messages about missing modules...	284	watching any error messages about missing modules...
248		285
		286	Instead of building a new perl binary, you can also build a standalone
		287	application:
		288
		289	# build the app
		290	staticperl mkapp app --boot eg/httpd \
		291	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		292
		293	# run it
		294	./app
		295
		296	Here are the three phase 2 commands:
		297
		298	=over 4
		299
		300	=item F<staticperl mkbundle> args...
		301
		302	The "default" bundle command - it interprets the given bundle options and
		303	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		304	files, useful for embedding.
		305
		306	=item F<staticperl mkperl> args...
		307
		308	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		309	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		310	links a new perl interpreter that embeds the created bundle, then deletes
		311	all intermediate files.
		312
		313	=item F<staticperl mkapp> filename args...
		314
		315	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		316	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		317	and links a new standalone application that simply initialises the perl
		318	interpreter.
		319
		320	The difference to F<staticperl mkperl> is that the standalone application
		321	does not act like a perl interpreter would - in fact, by default it would
		322	just do nothing and exit immediately, so you should specify some code to
		323	be executed via the F<--boot> option.
		324
		325	=back
		326
249	=head3 OPTION PROCESSING	327	=head3 OPTION PROCESSING
250		328
251	All options can be given as arguments on the command line (typically	329	All options can be given as arguments on the command line (typically
252	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	330	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
253	specifying a lot of modules can make the command line very cumbersome,	331	specifying a lot of options can make the command line very long and
254	you can put all long options into a "bundle specification file" (with or	332	unwieldy, you can put all long options into a "bundle specification file"
255	without C<--> prefix) and specify this bundle file instead.	333	(one option per line, with or without C<--> prefix) and specify this
		334	bundle file instead.
256		335
257	For example, the command given earlier could also look like this:	336	For example, the command given earlier to link a new F<perl> could also
		337	look like this:
258		338
259	staticperl mkperl httpd.bundle	339	staticperl mkperl httpd.bundle
260		340
261	And all options could be in F<httpd.bundle>:	341	With all options stored in the F<httpd.bundle> file (one option per line,
262		342	everything after the option is an argument):
		343
263	use "Config_heavy.pl"	344	use "Config_heavy.pl"
264	use AnyEvent::Impl::Perl	345	use AnyEvent::Impl::Perl
265	use AnyEvent::HTTPD	346	use AnyEvent::HTTPD
266	use URI::http	347	use URI::http
267	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
268		349
269	All options that specify modules or files to be added are processed in the	350	All options that specify modules or files to be added are processed in the
270	order given on the command line (that affects the C<--use> and C<--eval>	351	order given on the command line.
271	options at the moment).
272		352
273	=head3 MKBUNDLE OPTIONS	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
274		354
275	=over 4	355	F<staticperl mkbundle> works by first assembling a list of candidate
		356	files and modules to include, then filtering them by include/exclude
		357	patterns. The remaining modules (together with their direct dependencies,
		358	such as link libraries and L<AutoLoader> files) are then converted into
		359	bundle files suitable for embedding. F<staticperl mkbundle> can then
		360	optionally build a new perl interpreter or a standalone application.
276		361
		362	=over 4
		363
		364	=item Step 0: Generic argument processing.
		365
		366	The following options influence F<staticperl mkbundle> itself.
		367
		368	=over 4
		369
277	=item --verbose \| -v	370	=item C<--verbose> \| C<-v>
278		371
279	Increases the verbosity level by one (the default is C<1>).	372	Increases the verbosity level by one (the default is C<1>).
280		373
281	=item --quiet \| -q	374	=item C<--quiet> \| C<-q>
282		375
283	Decreases the verbosity level by one.	376	Decreases the verbosity level by one.
284		377
		378	=item any other argument
		379
		380	Any other argument is interpreted as a bundle specification file, which
		381	supports all options (without extra quoting), one option per line, in the
		382	format C<option> or C<option argument>. They will effectively be expanded
		383	and processed as if they were directly written on the command line, in
		384	place of the file name.
		385
		386	=back
		387
		388	=item Step 1: gather candidate files and modules
		389
		390	In this step, modules, perl libraries (F<.pl> files) and other files are
		391	selected for inclusion in the bundle. The relevant options are executed
		392	in order (this makes a difference mostly for C<--eval>, which can rely on
		393	earlier C<--use> options to have been executed).
		394
		395	=over 4
		396
		397	=item C<--use> F<module> \| C<-M>F<module>
		398
		399	Include the named module or perl library and trace direct
		400	dependencies. This is done by loading the module in a subprocess and
		401	tracing which other modules and files it actually loads.
		402
		403	Example: include AnyEvent and AnyEvent::Impl::Perl.
		404
		405	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		406
		407	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
		408	maybe other weirdly named files. To support this, the C<--use> option
		409	actually tries to do what you mean, depending on the string you specify:
		410
		411	=over 4
		412
		413	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		414	F<Coro::Mysql>.
		415
		416	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		417	assumes that it is a normal module name. It will create a new package and
		418	evaluate a C<use module> in it, i.e. it will load the package and do a
		419	default import.
		420
		421	The import step is done because many modules trigger more dependencies
		422	when something is imported than without.
		423
		424	=item anything that contains F</> or F<.> characters,
		425	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		426
		427	The string will be quoted and passed to require, as if you used C<require
		428	$module>. Nothing will be imported.
		429
		430	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		431
		432	If you enclose the name into single or double quotes, then the quotes will
		433	be removed and the resulting string will be passed to require. This syntax
		434	is form compatibility with older versions of staticperl and should not be
		435	used anymore.
		436
		437	=back
		438
		439	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		440	symbols), and once via C<require>, not importing any symbols. The first
		441	form is preferred as many modules load some extra dependencies when asked
		442	to export symbols.
		443
		444	staticperl mkbundle -MAnyEvent::Socket # use + import
		445	staticperl mkbundle -MAnyEvent/Socket.pm # require only
		446
		447	Example: include the required files for F<perl -V> to work in all its
		448	glory (F<Config.pm> is included automatically by the dependency tracker).
		449
		450	# shell command
		451	staticperl mkbundle -MConfig_heavy.pl
		452
		453	# bundle specification file
		454	use Config_heavy.pl
		455
		456	The C<-M>module syntax is included as a convenience that might be easier
		457	to remember than C<--use> - it's the same switch as perl itself uses
		458	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		459	not. Sigh.
		460
		461	=item C<--eval> "perl code" \| C<-e> "perl code"
		462
		463	Sometimes it is easier (or necessary) to specify dependencies using perl
		464	code, or maybe one of the modules you use need a special use statement. In
		465	that case, you can use C<--eval> to execute some perl snippet or set some
		466	variables or whatever you need. All files C<require>'d or C<use>'d while
		467	executing the snippet are included in the final bundle.
		468
		469	Keep in mind that F<mkbundle> will not import any symbols from the modules
		470	named by the C<--use> option, so do not expect the symbols from modules
		471	you C<--use>'d earlier on the command line to be available.
		472
		473	Example: force L<AnyEvent> to detect a backend and therefore include it
		474	in the final bundle.
		475
		476	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		477
		478	# or like this
		479	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		480
		481	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		482	and also include this in the final bundle, to be executed automatically
		483	when the interpreter is initialised.
		484
		485	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		486
		487	=item C<--boot> F<filename>
		488
		489	Include the given file in the bundle and arrange for it to be
		490	executed (using C<require>) before the main program when the new perl
		491	is initialised. This can be used to modify C<@INC> or do similar
		492	modifications before the perl interpreter executes scripts given on the
		493	command line (or via C<-e>). This works even in an embedded interpreter -
		494	the file will be executed during interpreter initialisation in that case.
		495
		496	=item C<--incglob> pattern
		497
		498	This goes through all standard library directories and tries to match any
		499	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		500	a file matches, it is added. The pattern is matched against the full path
		501	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		502
		503	This is very useful to include "everything":
		504
		505	--incglob '*'
		506
		507	It is also useful for including perl libraries, or trees of those, such as
		508	the unicode database files needed by some perl built-ins, the regex engine
		509	and other modules.
		510
		511	--incglob '/unicore/**.pl'
		512
		513	=item C<--add> F<file> \| C<--add> "F<file> alias"
		514
		515	Adds the given (perl) file into the bundle (and optionally call it
		516	"alias"). The F<file> is either an absolute path or a path relative to the
		517	current directory. If an alias is specified, then this is the name it will
		518	use for C<@INC> searches, otherwise the path F<file> will be used as the
		519	internal name.
		520
		521	This switch is used to include extra files into the bundle.
		522
		523	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		524	when creating the bundle.
		525
		526	staticperl mkperl --add "httpd httpd.pm"
		527
		528	# can be accessed via "use httpd"
		529
		530	Example: add a file F<initcode> from the current directory.
		531
		532	staticperl mkperl --add 'initcode &initcode'
		533
		534	# can be accessed via "do '&initcode'"
		535
		536	Example: add local files as extra modules in the bundle.
		537
		538	# specification file
		539	add file1 myfiles/file1.pm
		540	add file2 myfiles/file2.pm
		541	add file3 myfiles/file3.pl
		542
		543	# then later, in perl, use
		544	use myfiles::file1;
		545	require myfiles::file2;
		546	my $res = do "myfiles/file3.pl";
		547
		548	=item C<--addbin> F<file> \| C<--addbin> "F<file> alias"
		549
		550	Just like C<--add>, except that it treats the file as binary and adds it
		551	without any postprocessing (perl files might get stripped to reduce their
		552	size).
		553
		554	If you specify an alias you should probably add a C</> prefix to avoid
		555	clashing with embedded perl files (whose paths never start with C</>),
		556	and/or use a special directory prefix, such as C</res/name>.
		557
		558	You can later get a copy of these files by calling C<static::find
		559	"alias">.
		560
		561	An alternative way to embed binary files is to convert them to perl and
		562	use C<do> to get the contents - this method is a bit cumbersome, but works
		563	both inside and outside of a staticperl bundle, without extra ado:
		564
		565	# a "binary" file, call it "bindata.pl"
		566	<<'SOME_MARKER'
		567	binary data NOT containing SOME_MARKER
		568	SOME_MARKER
		569
		570	# load the binary
		571	chomp (my $data = do "bindata.pl");
		572
		573	=item C<--allow-dynamic>
		574
		575	By default, when F<mkbundle> hits a dynamic perl extension (e.g. a F<.so>
		576	or F<.dll> file), it will stop with a fatal error.
		577
		578	When this option is enabled, F<mkbundle> packages the shared
		579	object into the bundle instead, with a prefix of F<!>
		580	(e.g. F<!auto/List/Util/Util.so>). What you do with that is currently up
		581	to you, F<staticperl> has no special support for this at the moment, apart
		582	from working around the lack of availability of F<PerlIO::scalar> while
		583	bootstrapping, at a speed cost.
		584
		585	One way to deal with this is to write all files starting with F<!> into
		586	some directory and then C<unshift> that path onto C<@INC>.
		587
		588	#TODO: example
		589
		590	=back
		591
		592	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		593
		594	After all candidate files and modules are added, they are I<filtered>
		595	by a combination of C<--include> and C<--exclude> patterns (there is an
		596	implicit C<--include *> at the end, so if no filters are specified, all
		597	files are included).
		598
		599	All that this step does is potentially reduce the number of files that are
		600	to be included - no new files are added during this step.
		601
		602	=over 4
		603
		604	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		605
		606	These specify an include or exclude pattern to be applied to the candidate
		607	file list. An include makes sure that the given files will be part of the
		608	resulting file set, an exclude will exclude remaining files. The patterns
		609	are "extended glob patterns" (see below).
		610
		611	The patterns are applied "in order" - files included via earlier
		612	C<--include> specifications cannot be removed by any following
		613	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		614	cannot be added by any following C<--include>.
		615
		616	For example, to include everything except C<Devel> modules, but still
		617	include F<Devel::PPPort>, you could use this:
		618
		619	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		620
		621	=back
		622
		623	=item Step 3: add any extra or "hidden" dependencies.
		624
		625	F<staticperl> currently knows about three extra types of depdendencies
		626	that are added automatically. Only one (F<.packlist> files) is currently
		627	optional and can be influenced, the others are always included:
		628
		629	=over 4
		630
		631	=item C<--usepacklists>
		632
		633	Read F<.packlist> files for each distribution that happens to match a
		634	module name you specified. Sounds weird, and it is, so expect semantics to
		635	change somehow in the future.
		636
		637	The idea is that most CPAN distributions have a F<.pm> file that matches
		638	the name of the distribution (which is rather reasonable after all).
		639
		640	If this switch is enabled, then if any of the F<.pm> files that have been
		641	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		642	and F<.ix> files installed by this distribution are also included.
		643
		644	For example, using this switch, when the L<URI> module is specified, then
		645	all L<URI> submodules that have been installed via the CPAN distribution
		646	are included as well, so you don't have to manually specify them.
		647
		648	=item L<AutoLoader> splitfiles
		649
		650	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		651	are split into separate F<.al> files, and an index (F<.ix>) file contains
		652	the prototypes.
		653
		654	Both F<.ix> and F<.al> files will be detected automatically and added to
		655	the bundle.
		656
		657	=item link libraries (F<.a> files)
		658
		659	Modules using XS (or any other non-perl language extension compiled at
		660	installation time) will have a static archive (typically F<.a>). These
		661	will automatically be added to the linker options in F<bundle.ldopts>.
		662
		663	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		664	will warn about it - obviously this shouldn't happen unless you use
		665	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		666	use dynamic loading.
		667
		668	=item extra libraries (F<extralibs.ld>)
		669
		670	Some modules need linking against external libraries - these are found in
		671	F<extralibs.ld> and added to F<bundle.ldopts>.
		672
		673	=back
		674
		675	=item Step 4: write bundle files and optionally link a program
		676
		677	At this point, the select files will be read, processed (stripped) and
		678	finally the bundle files get written to disk, and F<staticperl mkbundle>
		679	is normally finished. Optionally, it can go a step further and either link
		680	a new F<perl> binary with all selected modules and files inside, or build
		681	a standalone application.
		682
		683	Both the contents of the bundle files and any extra linking is controlled
		684	by these options:
		685
		686	=over 4
		687
285	=item --strip none\|pod\|ppi	688	=item C<--strip> C<none>\|C<pod>\|C<ppi>
286		689
287	Specify the stripping method applied to reduce the file of the perl	690	Specify the stripping method applied to reduce the file of the perl
288	sources included.	691	sources included.
289		692
290	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	693	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
291	pod documentation, which is very fast and reduces file size a lot.	694	pod documentation, which is very fast and reduces file size a lot.
292		695
293	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	696	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
294	saves a lot more than just L<Pod::Strip>, and is generally safer, but	697	saves a lot more than just L<Pod::Strip>, and is generally safer,
295	is also a lot slower, so is best used for production builds. Note that	698	but is also a lot slower (some files take almost a minute to strip -
296	this method doesn't optimise for raw file size, but for best compression	699	F<staticperl> maintains a cache of stripped files to speed up subsequent
297	(that means that the uncompressed file size is a bit larger, but the files	700	runs for this reason). Note that this method doesn't optimise for raw file
298	compress better, e.g. with F<upx>).	701	size, but for best compression (that means that the uncompressed file size
		702	is a bit larger, but the files compress better, e.g. with F<upx>).
299		703
300	Last not least, if you need accurate line numbers in error messages,	704	Last not least, if you need accurate line numbers in error messages,
301	or in the unlikely case where C<pod> is too slow, or some module gets	705	or in the unlikely case where C<pod> is too slow, or some module gets
302	mistreated, you can specify C<none> to not mangle included perl sources in	706	mistreated, you can specify C<none> to not mangle included perl sources in
303	any way.	707	any way.
304		708
305	=item --perl	709	=item C<--perl>
306		710
307	After writing out the bundle files, try to link a new perl interpreter. It	711	After writing out the bundle files, try to link a new perl interpreter. It
308	will be called F<perl> and will be left in the current working	712	will be called F<perl> and will be left in the current working
309	directory. The bundle files will be removed.	713	directory. The bundle files will be removed.
310		714
311	This switch is automatically used when F<staticperl> is invoked with the	715	This switch is automatically used when F<staticperl> is invoked with the
312	C<mkperl> command (instead of C<mkbundle>):	716	C<mkperl> command instead of C<mkbundle>.
313		717
314	# build a new ./perl with only common::sense in it - very small :)	718	Example: build a new F<./perl> binary with only L<common::sense> inside -
		719	it will be even smaller than the standard perl interpreter as none of the
		720	modules of the base distribution (such as L<Fcntl>) will be included.
		721
315	staticperl mkperl -Mcommon::sense	722	staticperl mkperl -Mcommon::sense
316		723
317	=item --use module \| -Mmodule	724	=item C<--app> F<name>
318		725
319	Include the named module and all direct dependencies. This is done by	726	After writing out the bundle files, try to link a new standalone
320	C<require>'ing the module in a subprocess and tracing which other modules	727	program. It will be called C<name>, and the bundle files get removed after
321	and files it actually loads. If the module uses L<AutoLoader>, then all	728	linking it.
322	splitfiles will be included as well.
323		729
324	Example: include AnyEvent and AnyEvent::Impl::Perl.	730	This switch is automatically used when F<staticperl> is invoked with the
		731	C<mkapp> command instead of C<mkbundle>.
325		732
326	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	733	The difference to the (mutually exclusive) C<--perl> option is that the
		734	binary created by this option will not try to act as a perl interpreter -
		735	instead it will simply initialise the perl interpreter, clean it up and
		736	exit.
327		737
328	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	738	This means that, by default, it will do nothing but burn a few CPU cycles
329	maybe other weirdly named files. To do that, you need to quote the name in	739	- for it to do something useful you I<must> add some boot code, e.g. with
330	single or double quotes. When given on the command line, you probably need	740	the C<--boot> option.
331	to quote once more to avoid your shell interpreting it. Common cases that
332	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
333		741
334	Example: include the required files for F<perl -V> to work in all its	742	Example: create a standalone perl binary called F<./myexe> that will
335	glory (F<Config.pm> is included automatically by this).	743	execute F<appfile> when it is started.
336		744
337	# bourne shell	745	staticperl mkbundle --app myexe --boot appfile
338	staticperl mkbundle --use '"Config_heavy.pl"'
339		746
340	# bundle specification file	747	=item C<--ignore-env>
341	use "Config_heavy.pl"
342		748
343	The C<-Mmodule> syntax is included as an alias that might be easier to	749	Generates extra code to unset some environment variables before
344	remember than C<use>. Or maybe it confuses people. Time will tell. Or	750	initialising/running perl. Perl supports a lot of environment variables
345	maybe not. Argh.	751	that might alter execution in ways that might be undesirablre for
		752	standalone applications, and this option removes those known to cause
		753	trouble.
346		754
347	=item --eval "perl code" \| -e "perl code"	755	Specifically, these are removed:
348		756
349	Sometimes it is easier (or necessary) to specify dependencies using perl	757	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause undesirable
350	code, or maybe one of the modules you use need a special use statement. In	758	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
351	that case, you can use C<eval> to execute some perl snippet or set some	759	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
352	variables or whatever you need. All files C<require>'d or C<use>'d in the	760	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
353	script are included in the final bundle.
354		761
355	Keep in mind that F<mkbundle> will only C<require> the modules named	762	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
356	by the C<--use> option, so do not expect the symbols from modules you	763	startup code used by F<staticperl> overrides C<@INC> in all cases.
357	C<--use>'d earlier on the command line to be available.
358		764
359	Example: force L<AnyEvent> to detect a backend and therefore include it	765	This option will not make your program more secure (unless you are
360	in the final bundle.	766	running with elevated privileges), but it will reduce the surprise effect
		767	when a user has these environment variables set and doesn't expect your
		768	standalone program to act like a perl interpreter.
361		769
362	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
363
364	# or like this
365	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
366
367	Example: use a separate "bootstrap" script that C<use>'s lots of modules
368	and include this in the final bundle, to be executed automatically.
369
370	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
371
372	=item --boot filename
373
374	Include the given file in the bundle and arrange for it to be executed
375	(using a C<require>) before anything else when the new perl is
376	initialised. This can be used to modify C<@INC> or anything else before
377	the perl interpreter executes scripts given on the command line (or via
378	C<-e>). This works even in an embedded interpreter.
379
380	=item --add "file" \| --add "file alias"
381
382	Adds the given (perl) file into the bundle (and optionally call it
383	"alias"). This is useful to include any custom files into the bundle.
384
385	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
386
387	staticperl mkperl --add "httpd httpd.pm"
388
389	It is also a great way to add any custom modules:
390
391	# specification file
392	add file1 myfiles/file1
393	add file2 myfiles/file2
394	add file3 myfiles/file3
395
396	=item --binadd "file" \| --add "file alias"
397
398	Just like C<--add>, except that it treats the file as binary and adds it
399	without any processing.
400
401	You should probably add a C</> prefix to avoid clashing with embedded
402	perl files (whose paths do not start with C</>), and/or use a special
403	directory, such as C</res/name>.
404
405	You can later get a copy of these files by calling C<staticperl::find
406	"alias">.
407
408	=item --static	770	=item C<--static>
409		771
410	When C<--perl> is also given, link statically instead of dynamically. The	772	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		773	supported by the OS) executable will be created. This is not immensely
		774	useful when just creating the bundle files, but is most useful when
		775	linking a binary with the C<--perl> or C<--app> options.
		776
411	default is to link the new perl interpreter fully dynamic (that means all	777	The default is to link the new binary dynamically (that means all perl
412	perl modules are linked statically, but all external libraries are still	778	modules are linked statically, but all external libraries are still
413	referenced dynamically).	779	referenced dynamically).
414		780
415	Keep in mind that Solaris doesn't support static linking at all, and	781	Keep in mind that Solaris doesn't support static linking at all, and
416	systems based on GNU libc don't really support it in a usable fashion	782	systems based on GNU libc don't really support it in a very usable
417	either. Try uClibc if you want to create fully statically linked	783	fashion either. Try uClibc if you want to create fully statically linked
418	executables, or try the C<--staticlibs> option to link only some libraries	784	executables, or try the C<--staticlib> option to link only some libraries
419	statically.	785	statically.
420		786
421	=item any other argument	787	=item C<--staticlib> libname
422		788
423	Any other argument is interpreted as a bundle specification file, which	789	When not linking fully statically, this option allows you to link specific
424	supports most long options (without extra quoting), one option per line.	790	libraries statically. What it does is simply replace all occurrences of
		791	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		792	option.
425		793
426	=back	794	This will have no effect unless the library is actually linked against,
		795	specifically, C<--staticlib> will not link against the named library
		796	unless it would be linked against anyway.
427		797
		798	Example: link libcrypt statically into the final binary.
		799
		800	staticperl mkperl -MIO::AIO --staticlib crypt
		801
		802	# ldopts might now contain:
		803	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		804
		805	=back
		806
		807	=back
		808
		809	=head3 EXTENDED GLOB PATTERNS
		810
		811	Some options of F<staticperl mkbundle> expect an I<extended glob
		812	pattern>. This is neither a normal shell glob nor a regex, but something
		813	in between. The idea has been copied from rsync, and there are the current
		814	matching rules:
		815
		816	=over 4
		817
		818	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		819
		820	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		821	nothing inside, and neither any other file or directory called F<unicore>
		822	anywhere else in the hierarchy.
		823
		824	=item Patterns not starting with F</> will be anchored at the end of the path.
		825
		826	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		827	hierarchy, but not any directories of the same name.
		828
		829	=item A F<*> matches anything within a single path component.
		830
		831	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		832	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		833	will not match slashes.
		834
		835	=item A F<**> matches anything.
		836
		837	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		838	no matter how deeply nested they are inside subdirectories.
		839
		840	=item A F<?> matches a single character within a component.
		841
		842	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		843	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		844
		845	=back
		846
428	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	847	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
429		848
430	During (each) startup, F<staticperl> tries to source the following shell	849	During (each) startup, F<staticperl> tries to source some shell files to
		850	allow you to fine-tune/override configuration settings.
		851
		852	In them you can override shell variables, or define shell functions
		853	("hooks") to be called at specific phases during installation. For
		854	example, you could define a C<postinstall> hook to install additional
		855	modules from CPAN each time you start from scratch.
		856
		857	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		858	to source the file named with it only. Otherwise, it tries the following
431	files in order:	859	shell files in order:
432		860
433	/etc/staticperlrc	861	/etc/staticperlrc
434	~/.staticperlrc	862	~/.staticperlrc
435	$STATICPERL/rc	863	$STATICPERL/rc
436		864
437	They can be used to override shell variables, or define functions to be
438	called at specific phases.
439
440	Note that the last file is erased during F<staticperl distclean>, so	865	Note that the last file is erased during F<staticperl distclean>, so
441	generally should not be used.	866	generally should not be used.
442		867
443	=head3 CONFIGURATION VARIABLES	868	=head3 CONFIGURATION VARIABLES
444		869
…		…
476	=item C<STATICPERL>	901	=item C<STATICPERL>
477		902
478	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
479	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
480		905
		906	=item C<DLCACHE>
		907
		908	The path to a directory (will be created if it doesn't exist) where
		909	downloaded perl sources are being cached, to avoid downloading them
		910	again. The default is empty, which means there is no cache.
		911
		912	=item C<PERL_VERSION>
		913
		914	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
		915	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
		916	about as big as 5.12.3).
		917
481	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	918	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
482		919
483	Usually set to C<1> to make modules "less inquisitive" during their	920	Usually set to C<1> to make modules "less inquisitive" during their
484	installation, you can set any environment variable you want - some modules	921	installation. You can set (and export!) any environment variable you want
485	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	922	- some modules (such as L<Coro> or L<EV>) use environment variables for
486		923	further tweaking.
487	=item C<PERL_VERSION>
488
489	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
490	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
491	about as big as 5.12.2).
492		924
493	=item C<PERL_PREFIX>	925	=item C<PERL_PREFIX>
494		926
495	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	927	The directory where perl gets installed (default: F<$STATICPERL/perl>),
496	i.e. where the F<bin> and F<lib> subdirectories will end up.	928	i.e. where the F<bin> and F<lib> subdirectories will end up. Previous
		929	contents will be removed on installation.
497		930
498	=item C<PERL_CONFIGURE>	931	=item C<PERL_CONFIGURE>
499		932
500	Additional Configure options - these are simply passed to the perl	933	Additional Configure options - these are simply passed to the perl
501	Configure script. For example, if you wanted to enable dynamic loading,	934	Configure script. For example, if you wanted to enable dynamic loading,
…		…
505		938
506	More commonly, you would either activate 64 bit integer support	939	More commonly, you would either activate 64 bit integer support
507	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	940	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
508	reduce filesize further.	941	reduce filesize further.
509		942
510	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	943	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
511		944
512	These flags are passed to perl's F<Configure> script, and are generally	945	These flags are passed to perl's F<Configure> script, and are generally
513	optimised for small size (at the cost of performance). Since they also	946	optimised for small size (at the cost of performance). Since they also
514	contain subtle workarounds around various build issues, changing these	947	contain subtle workarounds around various build issues, changing these
515	usually requires understanding their default values - best look at the top	948	usually requires understanding their default values - best look at
516	of the F<staticperl> script for more info on these.	949	the top of the F<staticperl> script for more info on these, and use a
		950	F<~/.staticperlrc> to override them.
		951
		952	Most of the variables override (or modify) the corresponding F<Configure>
		953	variable, except C<PERL_CCFLAGS>, which gets appended.
		954
		955	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		956	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		957	all) systems.
		958
		959	For other compilers or more customised optimisation settings, you need to
		960	adjust these, e.g. in your F<~/.staticperlrc>.
		961
		962	With gcc on x86 and amd64, you can get more space-savings by using:
		963
		964	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		965	-mno-inline-stringops-dynamically -mno-align-stringops
		966
		967	And on x86 and pentium3 and newer (basically everything you might ever
		968	want to run on), adding these is even better for space-savings (use
		969	-mtune=core2 or something newer for much faster code, too):
		970
		971	-fomit-frame-pointer -march=pentium3 -mtune=i386
517		972
518	=back	973	=back
519		974
520	=head4 Variables you probably I<do not want> to override	975	=head4 Variables you probably I<do not want> to override
521		976
522	=over 4	977	=over 4
		978
		979	=item C<MAKE>
		980
		981	The make command to use - default is C<make>.
523		982
524	=item C<MKBUNDLE>	983	=item C<MKBUNDLE>
525		984
526	Where F<staticperl> writes the C<mkbundle> command to	985	Where F<staticperl> writes the C<mkbundle> command to
527	(default: F<$STATICPERL/mkbundle>).	986	(default: F<$STATICPERL/mkbundle>).
…		…
536	=head3 OVERRIDABLE HOOKS	995	=head3 OVERRIDABLE HOOKS
537		996
538	In addition to environment variables, it is possible to provide some	997	In addition to environment variables, it is possible to provide some
539	shell functions that are called at specific times. To provide your own	998	shell functions that are called at specific times. To provide your own
540	commands, just define the corresponding function.	999	commands, just define the corresponding function.
		1000
		1001	The actual order in which hooks are invoked during a full install
		1002	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1003	C<postbuild>, C<postinstall>.
541		1004
542	Example: install extra modules from CPAN and from some directories	1005	Example: install extra modules from CPAN and from some directories
543	at F<staticperl install> time.	1006	at F<staticperl install> time.
544		1007
545	postinstall() {	1008	postinstall() {
…		…
552		1015
553	=over 4	1016	=over 4
554		1017
555	=item preconfigure	1018	=item preconfigure
556		1019
557	Called just before running F<./Configur> in the perl source	1020	Called just before running F<./Configure> in the perl source
558	directory. Current working directory is the perl source directory.	1021	directory. Current working directory is the perl source directory.
559		1022
560	This can be used to set any C<PERL_xxx> variables, which might be costly	1023	This can be used to set any C<PERL_xxx> variables, which might be costly
561	to compute.	1024	to compute.
562		1025
		1026	=item patchconfig
		1027
		1028	Called after running F<./Configure> in the perl source directory to create
		1029	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1030	config. Current working directory is the perl source directory.
		1031
		1032	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1033
563	=item postconfigure	1034	=item postconfigure
564		1035
565	Called after configuring, but before building perl. Current working	1036	Called after configuring, but before building perl. Current working
566	directory is the perl source directory.	1037	directory is the perl source directory.
567
568	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
569	or do any other modifications.
570		1038
571	=item postbuild	1039	=item postbuild
572		1040
573	Called after building, but before installing perl. Current working	1041	Called after building, but before installing perl. Current working
574	directory is the perl source directory.	1042	directory is the perl source directory.
…		…
612	A header file that contains the prototypes of the few symbols "exported"	1080	A header file that contains the prototypes of the few symbols "exported"
613	by bundle.c, and also exposes the perl headers to the application.	1081	by bundle.c, and also exposes the perl headers to the application.
614		1082
615	=over 4	1083	=over 4
616		1084
617	=item staticperl_init ()	1085	=item staticperl_init (xs_init = 0)
618		1086
619	Initialises the perl interpreter. You can use the normal perl functions	1087	Initialises the perl interpreter. You can use the normal perl functions
620	after calling this function, for example, to define extra functions or	1088	after calling this function, for example, to define extra functions or
621	to load a .pm file that contains some initialisation code, or the main	1089	to load a .pm file that contains some initialisation code, or the main
622	program function:	1090	program function:
…		…
629	}	1097	}
630		1098
631	static void	1099	static void
632	run_myapp(void)	1100	run_myapp(void)
633	{	1101	{
634	staticperl_init ();	1102	staticperl_init (0);
635	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1103	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
636	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1104	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
637	}	1105	}
638		1106
		1107	When your bootcode already wants to access some XS functions at
		1108	compiletime, then you need to supply an C<xs_init> function pointer that
		1109	is called as soon as perl is initialised enough to define XS functions,
		1110	but before the preamble code is executed:
		1111
		1112	static void
		1113	xs_init (pTHX)
		1114	{
		1115	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1116	}
		1117
		1118	static void
		1119	run_myapp(void)
		1120	{
		1121	staticperl_init (xs_init);
		1122	}
		1123
		1124	=item staticperl_cleanup ()
		1125
		1126	In the unlikely case that you want to destroy the perl interpreter, here
		1127	is the corresponding function.
		1128
639	=item staticperl_xs_init (pTHX)	1129	=item staticperl_xs_init (pTHX)
640		1130
641	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1131	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
642	which case you do not want to use C<staticperl_init> but call them on your	1132	which case you do not want to use C<staticperl_init> but call them on your
643	own.	1133	own.
644		1134
645	Then you need this function - either pass it directly as the C<xs_init>	1135	Then you need this function - either pass it directly as the C<xs_init>
646	function to C<perl_parse>, or call it from your own C<xs_init> function.	1136	function to C<perl_parse>, or call it as one of the first things from your
647		1137	own C<xs_init> function.
648	=item staticperl_cleanup ()
649
650	In the unlikely case that you want to destroy the perl interpreter, here
651	is the corresponding function.
652		1138
653	=item PerlInterpreter *staticperl	1139	=item PerlInterpreter *staticperl
654		1140
655	The perl interpreter pointer used by staticperl. Not normally so useful,	1141	The perl interpreter pointer used by staticperl. Not normally so useful,
656	but there it is.	1142	but there it is.
…		…
669		1155
670	=back	1156	=back
671		1157
672	=head1 RUNTIME FUNCTIONALITY	1158	=head1 RUNTIME FUNCTIONALITY
673		1159
674	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1160	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
675	are required to access the bundled perl sources, but might be useful for	1161	mostly related to the extra files bundled in the binary (the virtual
676	other purposes.	1162	filesystem). All of this data is statically compiled into the binary, and
		1163	accessing means copying it from a read-only section of your binary. Data
		1164	pages in this way is usually freed by the operating system, as it isn't
		1165	use more the onace.
		1166
		1167	=head2 VIRTUAL FILESYSTEM
		1168
		1169	Every bundle has a virtual filesystem. The only information stored in it
		1170	is the path and contents of each file that was bundled.
		1171
		1172	=head3 LAYOUT
		1173
		1174	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1175	reserved by F<staticperl>. They must only be used as described in this
		1176	section.
		1177
		1178	=over 4
		1179
		1180	=item !
		1181
		1182	All files that typically cannot be loaded from memory (such as dynamic
		1183	objects or shared libraries), but have to reside in the filesystem, are
		1184	prefixed with F<!>. Typically these files get written out to some
		1185	(semi-)temporary directory shortly after program startup, or before being
		1186	used.
		1187
		1188	=item !boot
		1189
		1190	The bootstrap file, if specified during bundling.
		1191
		1192	=item !auto/
		1193
		1194	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1195	are stored with an F<!auto/> prefix.
		1196
		1197	=item !lib/
		1198
		1199	External shared libraries are stored in this directory.
		1200
		1201	=item any letter
		1202
		1203	Any path starting with a letter is a perl library file. For example,
		1204	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1205	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1206
		1207	Obviously, module names shouldn't start with any other characters than
		1208	letters :)
		1209
		1210	=back
		1211
		1212	=head3 FUNCTIONS
		1213
		1214	=over 4
		1215
		1216	=item $file = static::find $path
		1217
		1218	Returns the data associated with the given C<$path>
		1219	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1220
		1221	Returns C<undef> if the file isn't embedded.
		1222
		1223	=item @paths = static::list
		1224
		1225	Returns the list of all paths embedded in this binary.
		1226
		1227	=back
		1228
		1229	=head2 EXTRA FEATURES
677		1230
678	In addition, for the embedded loading of perl files to work, F<staticperl>	1231	In addition, for the embedded loading of perl files to work, F<staticperl>
679	overrides the C<@INC> array.	1232	overrides the C<@INC> array.
680		1233
681	=over 4
682
683	=item $file = staticperl::find $path
684
685	Returns the data associated with the given C<$path>
686	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
687	the UNIX path relative to the perl library directory.
688
689	Returns C<undef> if the file isn't embedded.
690
691	=item @paths = staticperl::list
692
693	Returns the list of all paths embedded in this binary.
694
695	=back
696
697	=head1 FULLY STATIC BINARIES - BUILDROOT	1234	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
698		1235
699	To make truly static (Linux-) libraries, you might want to have a look at	1236	To make truly static (Linux-) libraries, you might want to have a look at
700	buildroot (L<http://buildroot.uclibc.org/>).	1237	buildroot (L<http://buildroot.uclibc.org/>).
701		1238
702	Buildroot is primarily meant to set up a cross-compile environment (which	1239	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
709	good experiences with GCC 4.4.x but not GCC 4.5.	1246	good experiences with GCC 4.4.x but not GCC 4.5.
710		1247
711	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1248	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
712	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>	1249	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
713	doesn't decrease codesize much, but it makes the file much more	1250	doesn't decrease codesize much, but it makes the file much more
714	compressible.	1251	compressible (and the execution a lot slower...).
715		1252
716	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1253	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
717	no thread support). For Coro, it is highly recommended to switch to a	1254	no thread support). For Coro, it is highly recommended to switch to a
718	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201	1255	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
719	snapshot) and enable NPTL, otherwise Coro needs to be configured with the	1256	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
721	twice the address space needed for stacks).	1258	twice the address space needed for stacks).
722		1259
723	If you use C<linuxthreads.old>, then you should also be aware that	1260	If you use C<linuxthreads.old>, then you should also be aware that
724	uClibc shares C<errno> between all threads when statically linking. See	1261	uClibc shares C<errno> between all threads when statically linking. See
725	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a	1262	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
726	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1263	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
727		1264
728	C<ccache> support is also recommended, especially if you want	1265	C<ccache> support is also recommended, especially if you want
729	to play around with buildroot options. Enabling the C<miniperl>	1266	to play around with buildroot options. Enabling the C<miniperl>
730	package will probably enable all options required for a successful	1267	package will probably enable all options required for a successful
731	perl build. F<staticperl> itself additionally needs either C<wget>	1268	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
739	it from working properly in a chroot - either use dash (and link it to	1276	it from working properly in a chroot - either use dash (and link it to
740	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's	1277	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
741	built-in ash shell.	1278	built-in ash shell.
742		1279
743	Finally, you need F</dev/null> inside the chroot for many scripts to work	1280	Finally, you need F</dev/null> inside the chroot for many scripts to work
744	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will	1281	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
745	both provide this.	1282	will provide this.
746		1283
747	After you have compiled and set up your buildroot target, you can copy	1284	After you have compiled and set up your buildroot target, you can copy
748	F<staticperl> from the C<App::Staticperl> distribution or from your	1285	F<staticperl> from the C<App::Staticperl> distribution or from your
749	perl f<bin> directory (if you installed it) into the F<output/target>	1286	perl F<bin> directory (if you installed it) into the F<output/target>
750	filesystem, chroot inside and run it.	1287	filesystem, chroot inside and run it.
		1288
		1289	=head1 RECIPES / SPECIFIC MODULES
		1290
		1291	This section contains some common(?) recipes and information about
		1292	problems with some common modules or perl constructs that require extra
		1293	files to be included.
		1294
		1295	=head2 MODULES
		1296
		1297	=over 4
		1298
		1299	=item utf8
		1300
		1301	Some functionality in the utf8 module, such as swash handling (used
		1302	for unicode character ranges in regexes) is implemented in the
		1303	C<"utf8_heavy.pl"> library:
		1304
		1305	-Mutf8_heavy.pl
		1306
		1307	Many Unicode properties in turn are defined in separate modules,
		1308	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1309	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1310	are big (7MB uncompressed, although F<staticperl> contains special
		1311	handling for those files), so including them on demand by your application
		1312	only might pay off.
		1313
		1314	To simply include the whole unicode database, use:
		1315
		1316	--incglob '/unicore/**.pl'
		1317
		1318	=item AnyEvent
		1319
		1320	AnyEvent needs a backend implementation that it will load in a delayed
		1321	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1322	for AnyEvent if it can't find anything else, and is usually a safe
		1323	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1324	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1325	well.
		1326
		1327	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1328	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1329	C<"AnyEvent/Util/uts46data.pl">.
		1330
		1331	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1332	everything.
		1333
		1334	=item Cairo
		1335
		1336	See Glib, same problem, same solution.
		1337
		1338	=item Carp
		1339
		1340	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1341	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1342
		1343	=item Config
		1344
		1345	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1346	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1347	both.
		1348
		1349	=item Glib
		1350
		1351	Glib literally requires Glib to be installed already to build - it tries
		1352	to fake this by running Glib out of the build directory before being
		1353	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1354	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1355
		1356	=item Gtk2
		1357
		1358	See Pango, same problems, same solution.
		1359
		1360	=item Net::SSLeay
		1361
		1362	This module hasn't been significantly updated since OpenSSL is called
		1363	OpenSSL, and fails to properly link against dependent libraries, most
		1364	commonly, it forgets to specify -ldl when linking.
		1365
		1366	On GNU/Linux systems this usually goes undetected, as perl usually links
		1367	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1368	chance.
		1369
		1370	For static builds, you either have to configure -ldl manually, or you
		1371	cna use the following snippet in your C<postinstall> hook which patches
		1372	Net::SSLeay after installation, which happens to work most of the time:
		1373
		1374	postinstall() {
		1375	# first install it
		1376	instcpan Net::SSLeay
		1377	# then add -ldl for future linking
		1378	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1379	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1380	}
		1381
		1382	=item Pango
		1383
		1384	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1385	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1386	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1387
		1388	=item Term::ReadLine::Perl
		1389
		1390	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
		1391
		1392	=item URI
		1393
		1394	URI implements schemes as separate modules - the generic URL scheme is
		1395	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1396	you need to use any of these schemes, you should include these manually,
		1397	or use C<--usepacklists>.
		1398
		1399	=back
		1400
		1401	=head2 RECIPES
		1402
		1403	=over 4
		1404
		1405	=item Just link everything in
		1406
		1407	To link just about everything installed in the perl library into a new
		1408	perl, try this (the first time this runs it will take a long time, as a
		1409	lot of files need to be parsed):
		1410
		1411	staticperl mkperl -v --strip ppi --incglob '*'
		1412
		1413	If you don't mind the extra megabytes, this can be a very effective way of
		1414	creating bundles without having to worry about forgetting any modules.
		1415
		1416	You get even more useful variants of this method by first selecting
		1417	everything, and then excluding stuff you are reasonable sure not to need -
		1418	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1419
		1420	=item Getting rid of netdb functions
		1421
		1422	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1423	and so on) that few applications use. You can avoid compiling them in by
		1424	putting the following fragment into a C<preconfigure> hook:
		1425
		1426	preconfigure() {
		1427	for sym in \
		1428	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1429	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1430	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1431	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1432	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1433	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1434	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1435	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1436	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1437	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1438	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1439	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1440	d_getspnam_r d_getsbyname
		1441	# d_gethbyname
		1442	do
		1443	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1444	done
		1445	}
		1446
		1447	This mostly gains space when linking statically, as the functions will
		1448	likely not be linked in. The gain for dynamically-linked binaries is
		1449	smaller.
		1450
		1451	Also, this leaves C<gethostbyname> in - not only is it actually used
		1452	often, the L<Socket> module also exposes it, so leaving it out usually
		1453	gains little. Why Socket exposes a C function that is in the core already
		1454	is anybody's guess.
		1455
		1456	=back
751		1457
752	=head1 AUTHOR	1458	=head1 AUTHOR
753		1459
754	Marc Lehmann <schmorp@schmorp.de>	1460	Marc Lehmann <schmorp@schmorp.de>
755	http://software.schmorp.de/pkg/staticperl.html	1461	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.13 by root, Tue Dec 7 19:55:56 2010 UTC vs. Revision 1.58 by root, Sun Jun 16 04:38:38 2013 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.58 by root, Sun Jun 16 04:38:38 2013 UTC