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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.11 by root, Tue Dec 7 10:40:39 2010 UTC vs.
Revision 1.48 by root, Sun Jul 10 01:37:56 2011 UTC

…		…
9	staticperl configure # fetch and then configure perl	9	staticperl configure # fetch and then configure perl
10	staticperl build # configure and then build perl	10	staticperl build # configure and then build perl
11	staticperl install # build and then install perl	11	staticperl install # build and then install perl
12	staticperl clean # clean most intermediate files (restart at configure)	12	staticperl clean # clean most intermediate files (restart at configure)
13	staticperl distclean # delete everything installed by this script	13	staticperl distclean # delete everything installed by this script
		14	staticperl perl ... # invoke the perlinterpreter
14	staticperl cpan # invoke CPAN shell	15	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	16	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	17	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	18	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	19	staticperl mkperl <bundle-args...> # see documentation
		20	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
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,
167	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
168	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.
169		210
170	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
171		212
172	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
173		214
…		…
184	command by specifying all the directories with modules in them that you	225	command by specifying all the directories with modules in them that you
185	want to have built.	226	want to have built.
186		227
187	=item F<staticperl clean>	228	=item F<staticperl clean>
188		229
189	Runs F<make distclean> in the perl source directory (and potentially	230	Deletes the perl source directory (and potentially cleans up other
190	cleans up other intermediate files). This can be used to clean up	231	intermediate files). This can be used to clean up files only needed for
191	intermediate files without removing the installed perl interpreter.	232	building perl, without removing the installed perl interpreter.
		233
		234	At the moment, it doesn't delete downloaded tarballs.
		235
		236	The exact semantics of this command will probably change.
192		237
193	=item F<staticperl distclean>	238	=item F<staticperl distclean>
194		239
195	This wipes your complete F<~/.staticperl> directory. Be careful with this,	240	This wipes your complete F<~/.staticperl> directory. Be careful with this,
196	it nukes your perl download, perl sources, perl distribution and any	241	it nukes your perl download, perl sources, perl distribution and any
…		…
220		265
221	# first make sure we have perl and the required modules	266	# first make sure we have perl and the required modules
222	staticperl instcpan AnyEvent::HTTPD	267	staticperl instcpan AnyEvent::HTTPD
223		268
224	# now build the perl	269	# now build the perl
225	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	270	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
226	-MAnyEvent::HTTPD -MURI::http \	271	-MAnyEvent::HTTPD -MURI::http \
227	--add 'eg/httpd httpd.pm'	272	--add 'eg/httpd httpd.pm'
228		273
229	# finally, invoke it	274	# finally, invoke it
230	./perl -Mhttpd	275	./perl -Mhttpd
…		…
236	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	281	(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	282	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	283	to include that module. I found out about these dependencies by carefully
239	watching any error messages about missing modules...	284	watching any error messages about missing modules...
240		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
241	=head3 OPTION PROCESSING	327	=head3 OPTION PROCESSING
242		328
243	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
244	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
245	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
246	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"
247	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.
248		335
249	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:
250		338
251	staticperl mkperl httpd.bundle	339	staticperl mkperl httpd.bundle
252		340
253	And all options could be in F<httpd.bundle>:	341	With all options stored in the F<httpd.bundle> file (one option per line,
254		342	everything after the option is an argument):
		343
255	use "Config_heavy.pl"	344	use "Config_heavy.pl"
256	use AnyEvent::Impl::Perl	345	use AnyEvent::Impl::Perl
257	use AnyEvent::HTTPD	346	use AnyEvent::HTTPD
258	use URI::http	347	use URI::http
259	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
260		349
261	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
262	order given on the command line (that affects the C<--use> and C<--eval>	351	order given on the command line.
263	options at the moment).
264		352
265	=head3 MKBUNDLE OPTIONS	353	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
266		354
267	=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.
268		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
269	=item --verbose \| -v	370	=item C<--verbose> \| C<-v>
270		371
271	Increases the verbosity level by one (the default is C<1>).	372	Increases the verbosity level by one (the default is C<1>).
272		373
273	=item --quiet \| -q	374	=item C<--quiet> \| C<-q>
274		375
275	Decreases the verbosity level by one.	376	Decreases the verbosity level by one.
276		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<--binadd> F<file> \| C<--add> "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<staticperl::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
277	=item --strip none\|pod\|ppi	688	=item C<--strip> C<none>\|C<pod>\|C<ppi>
278		689
279	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
280	sources included.	691	sources included.
281		692
282	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
283	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.
284		695
285	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
286	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,
287	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 -
288	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
289	(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
290	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>).
291		703
292	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,
293	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
294	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
295	any way.	707	any way.
296		708
297	=item --perl	709	=item C<--perl>
298		710
299	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
300	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
301	directory. The bundle files will be removed.	713	directory. The bundle files will be removed.
302		714
303	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
304	C<mkperl> command (instead of C<mkbundle>):	716	C<mkperl> command instead of C<mkbundle>.
305		717
306	# 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
307	staticperl mkperl -Mcommon::sense	722	staticperl mkperl -Mcommon::sense
308		723
309	=item --use module \| -Mmodule	724	=item C<--app> F<name>
310		725
311	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
312	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
313	and files it actually loads. If the module uses L<AutoLoader>, then all	728	linking it.
314	splitfiles will be included as well.
315		729
316	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>.
317		732
318	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.
319		737
320	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
321	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
322	single or double quotes. When given on the command line, you probably need	740	the C<--boot> option.
323	to quote once more to avoid your shell interpreting it. Common cases that
324	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
325		741
326	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
327	glory (F<Config.pm> is included automatically by this).	743	execute F<appfile> when it is started.
328		744
329	# bourne shell	745	staticperl mkbundle --app myexe --boot appfile
330	staticperl mkbundle --use '"Config_heavy.pl"'
331		746
332	# bundle specification file	747	=item C<--ignore-env>
333	use "Config_heavy.pl"
334		748
335	The C<-Mmodule> syntax is included as an alias that might be easier to	749	Generates extra code to unset some environment variables before
336	remember than C<use>. Or maybe it confuses people. Time will tell. Or	750	initialising/running perl. Perl supports a lot of environment variables
337	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.
338		754
339	=item --eval "perl code" \| -e "perl code"	755	Specifically, these are removed:
340		756
341	Sometimes it is easier (or necessary) to specify dependencies using perl	757	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
342	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
343	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>,
344	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.
345	script are included in the final bundle.
346		761
347	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
348	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.
349	C<--use>'d earlier on the command line to be available.
350		764
351	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
352	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.
353		769
354	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
355
356	# or like this
357	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
358
359	Example: use a separate "bootstrap" script that C<use>'s lots of modules
360	and include this in the final bundle, to be executed automatically.
361
362	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
363
364	=item --boot filename
365
366	Include the given file in the bundle and arrange for it to be executed
367	(using a C<require>) before anything else when the new perl is
368	initialised. This can be used to modify C<@INC> or anything else before
369	the perl interpreter executes scripts given on the command line (or via
370	C<-e>). This works even in an embedded interpreter.
371
372	=item --add "file" \| --add "file alias"
373
374	Adds the given (perl) file into the bundle (and optionally call it
375	"alias"). This is useful to include any custom files into the bundle.
376
377	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
378
379	staticperl mkperl --add "httpd httpd.pm"
380
381	It is also a great way to add any custom modules:
382
383	# specification file
384	add file1 myfiles/file1
385	add file2 myfiles/file2
386	add file3 myfiles/file3
387
388	=item --binadd "file" \| --add "file alias"
389
390	Just like C<--add>, except that it treats the file as binary and adds it
391	without any processing.
392
393	You should probably add a C</> prefix to avoid clashing with embedded
394	perl files (whose paths do not start with C</>), and/or use a special
395	directory, such as C</res/name>.
396
397	You can later get a copy of these files by calling C<staticperl::find
398	"alias">.
399
400	=item --static	770	=item C<--static>
401		771
402	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
403	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
404	perl modules are linked statically, but all external libraries are still	778	modules are linked statically, but all external libraries are still
405	referenced dynamically).	779	referenced dynamically).
406		780
407	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
408	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
409	either. Try uClibc if you want to create fully statically linked	783	fashion either. Try uClibc if you want to create fully statically linked
410	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
411	statically.	785	statically.
412		786
413	=item any other argument	787	=item C<--staticlib> libname
414		788
415	Any other argument is interpreted as a bundle specification file, which	789	When not linking fully statically, this option allows you to link specific
416	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.
417		793
418	=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.
419		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
420	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	847	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
421		848
422	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
423	files in order:	859	shell files in order:
424		860
425	/etc/staticperlrc	861	/etc/staticperlrc
426	~/.staticperlrc	862	~/.staticperlrc
427	$STATICPERL/rc	863	$STATICPERL/rc
428		864
429	They can be used to override shell variables, or define functions to be
430	called at specific phases.
431
432	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
433	generally should not be used.	866	generally should not be used.
434		867
435	=head3 CONFIGURATION VARIABLES	868	=head3 CONFIGURATION VARIABLES
436		869
…		…
468	=item C<STATICPERL>	901	=item C<STATICPERL>
469		902
470	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
471	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
472		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
473	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	918	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
474		919
475	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
476	installation, you can set any environment variable you want - some modules	921	installation. You can set (and export!) any environment variable you want
477	(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
478		923	further tweaking.
479	=item C<PERL_VERSION>
480
481	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
482	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
483	about as big as 5.12.2).
484		924
485	=item C<PERL_PREFIX>	925	=item C<PERL_PREFIX>
486		926
487	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	927	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
488	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.
…		…
497		937
498	More commonly, you would either activate 64 bit integer support	938	More commonly, you would either activate 64 bit integer support
499	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	939	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
500	reduce filesize further.	940	reduce filesize further.
501		941
502	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	942	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
503		943
504	These flags are passed to perl's F<Configure> script, and are generally	944	These flags are passed to perl's F<Configure> script, and are generally
505	optimised for small size (at the cost of performance). Since they also	945	optimised for small size (at the cost of performance). Since they also
506	contain subtle workarounds around various build issues, changing these	946	contain subtle workarounds around various build issues, changing these
507	usually requires understanding their default values - best look at the top	947	usually requires understanding their default values - best look at
508	of the F<staticperl> script for more info on these.	948	the top of the F<staticperl> script for more info on these, and use a
		949	F<~/.staticperlrc> to override them.
		950
		951	Most of the variables override (or modify) the corresponding F<Configure>
		952	variable, except C<PERL_CCFLAGS>, which gets appended.
		953
		954	You should have a look near the beginning of the F<staticperl> script -
		955	staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
		956	suitable for newer gcc versions. For other compilers or older versions you
		957	need to adjust these, for example, in your F<~/.staticperlrc>.
509		958
510	=back	959	=back
511		960
512	=head4 Variables you probably I<do not want> to override	961	=head4 Variables you probably I<do not want> to override
513		962
514	=over 4	963	=over 4
		964
		965	=item C<MAKE>
		966
		967	The make command to use - default is C<make>.
515		968
516	=item C<MKBUNDLE>	969	=item C<MKBUNDLE>
517		970
518	Where F<staticperl> writes the C<mkbundle> command to	971	Where F<staticperl> writes the C<mkbundle> command to
519	(default: F<$STATICPERL/mkbundle>).	972	(default: F<$STATICPERL/mkbundle>).
…		…
528	=head3 OVERRIDABLE HOOKS	981	=head3 OVERRIDABLE HOOKS
529		982
530	In addition to environment variables, it is possible to provide some	983	In addition to environment variables, it is possible to provide some
531	shell functions that are called at specific times. To provide your own	984	shell functions that are called at specific times. To provide your own
532	commands, just define the corresponding function.	985	commands, just define the corresponding function.
		986
		987	The actual order in which hooks are invoked during a full install
		988	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		989	C<postbuild>, C<postinstall>.
533		990
534	Example: install extra modules from CPAN and from some directories	991	Example: install extra modules from CPAN and from some directories
535	at F<staticperl install> time.	992	at F<staticperl install> time.
536		993
537	postinstall() {	994	postinstall() {
…		…
542	instcpan Anyevent::AIO AnyEvent::HTTPD	999	instcpan Anyevent::AIO AnyEvent::HTTPD
543	}	1000	}
544		1001
545	=over 4	1002	=over 4
546		1003
		1004	=item preconfigure
		1005
		1006	Called just before running F<./Configure> in the perl source
		1007	directory. Current working directory is the perl source directory.
		1008
		1009	This can be used to set any C<PERL_xxx> variables, which might be costly
		1010	to compute.
		1011
		1012	=item patchconfig
		1013
		1014	Called after running F<./Configure> in the perl source directory to create
		1015	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1016	config. Current working directory is the perl source directory.
		1017
		1018	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1019
547	=item postconfigure	1020	=item postconfigure
548		1021
549	Called after configuring, but before building perl. Current working	1022	Called after configuring, but before building perl. Current working
550	directory is the perl source directory.	1023	directory is the perl source directory.
551
552	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or
553	do any other modifications.
554		1024
555	=item postbuild	1025	=item postbuild
556		1026
557	Called after building, but before installing perl. Current working	1027	Called after building, but before installing perl. Current working
558	directory is the perl source directory.	1028	directory is the perl source directory.
…		…
596	A header file that contains the prototypes of the few symbols "exported"	1066	A header file that contains the prototypes of the few symbols "exported"
597	by bundle.c, and also exposes the perl headers to the application.	1067	by bundle.c, and also exposes the perl headers to the application.
598		1068
599	=over 4	1069	=over 4
600		1070
601	=item staticperl_init ()	1071	=item staticperl_init (xs_init = 0)
602		1072
603	Initialises the perl interpreter. You can use the normal perl functions	1073	Initialises the perl interpreter. You can use the normal perl functions
604	after calling this function, for example, to define extra functions or	1074	after calling this function, for example, to define extra functions or
605	to load a .pm file that contains some initialisation code, or the main	1075	to load a .pm file that contains some initialisation code, or the main
606	program function:	1076	program function:
…		…
613	}	1083	}
614		1084
615	static void	1085	static void
616	run_myapp(void)	1086	run_myapp(void)
617	{	1087	{
618	staticperl_init ();	1088	staticperl_init (0);
619	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1089	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
620	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1090	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
621	}	1091	}
622		1092
		1093	When your bootcode already wants to access some XS functions at
		1094	compiletime, then you need to supply an C<xs_init> function pointer that
		1095	is called as soon as perl is initialised enough to define XS functions,
		1096	but before the preamble code is executed:
		1097
		1098	static void
		1099	xs_init (pTHX)
		1100	{
		1101	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1102	}
		1103
		1104	static void
		1105	run_myapp(void)
		1106	{
		1107	staticperl_init (xs_init);
		1108	}
		1109
		1110	=item staticperl_cleanup ()
		1111
		1112	In the unlikely case that you want to destroy the perl interpreter, here
		1113	is the corresponding function.
		1114
623	=item staticperl_xs_init (pTHX)	1115	=item staticperl_xs_init (pTHX)
624		1116
625	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1117	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
626	which case you do not want to use C<staticperl_init> but call them on your	1118	which case you do not want to use C<staticperl_init> but call them on your
627	own.	1119	own.
628		1120
629	Then you need this function - either pass it directly as the C<xs_init>	1121	Then you need this function - either pass it directly as the C<xs_init>
630	function to C<perl_parse>, or call it from your own C<xs_init> function.	1122	function to C<perl_parse>, or call it as one of the first things from your
631		1123	own C<xs_init> function.
632	=item staticperl_cleanup ()
633
634	In the unlikely case that you want to destroy the perl interpreter, here
635	is the corresponding function.
636		1124
637	=item PerlInterpreter *staticperl	1125	=item PerlInterpreter *staticperl
638		1126
639	The perl interpreter pointer used by staticperl. Not normally so useful,	1127	The perl interpreter pointer used by staticperl. Not normally so useful,
640	but there it is.	1128	but there it is.
…		…
653		1141
654	=back	1142	=back
655		1143
656	=head1 RUNTIME FUNCTIONALITY	1144	=head1 RUNTIME FUNCTIONALITY
657		1145
658	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1146	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
659	are required to access the bundled perl sources, but might be useful for	1147	mostly related to the extra files bundled in the binary (the virtual
660	other purposes.	1148	filesystem). All of this data is statically compiled into the binary, and
		1149	accessing means copying it from a read-only section of your binary. Data
		1150	pages in this way is usually freed by the operating system, as it isn't
		1151	use more the onace.
		1152
		1153	=head2 VIRTUAL FILESYSTEM
		1154
		1155	Every bundle has a virtual filesystem. The only information stored in it
		1156	is the path and contents of each file that was bundled.
		1157
		1158	=head3 LAYOUT
		1159
		1160	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1161	reserved by F<staticperl>. They must only be used as described in this
		1162	section.
		1163
		1164	=over 4
		1165
		1166	=item !
		1167
		1168	All files that typically cannot be loaded from memory (such as dynamic
		1169	objects or shared libraries), but have to reside in the filesystem, are
		1170	prefixed with F<!>. Typically these files get written out to some
		1171	(semi-)temporary directory shortly after program startup, or before being
		1172	used.
		1173
		1174	=item !boot
		1175
		1176	The bootstrap file, if specified during bundling.
		1177
		1178	=item !auto/
		1179
		1180	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1181	are stored with an F<!auto/> prefix.
		1182
		1183	=item !lib/
		1184
		1185	External shared libraries are stored in this directory.
		1186
		1187	=item any letter
		1188
		1189	Any path starting with a letter is a perl library file. For example,
		1190	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1191	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1192
		1193	Obviously, module names shouldn't start with any other characters than
		1194	letters :)
		1195
		1196	=back
		1197
		1198	=head3 FUNCTIONS
		1199
		1200	=over 4
		1201
		1202	=item $file = staticperl::find $path
		1203
		1204	Returns the data associated with the given C<$path>
		1205	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1206
		1207	Returns C<undef> if the file isn't embedded.
		1208
		1209	=item @paths = staticperl::list
		1210
		1211	Returns the list of all paths embedded in this binary.
		1212
		1213	=back
		1214
		1215	=head2 EXTRA FEATURES
661		1216
662	In addition, for the embedded loading of perl files to work, F<staticperl>	1217	In addition, for the embedded loading of perl files to work, F<staticperl>
663	overrides the C<@INC> array.	1218	overrides the C<@INC> array.
664		1219
665	=over 4
666
667	=item $file = staticperl::find $path
668
669	Returns the data associated with the given C<$path>
670	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
671	the UNIX path relative to the perl library directory.
672
673	Returns C<undef> if the file isn't embedded.
674
675	=item @paths = staticperl::list
676
677	Returns the list of all paths embedded in this binary.
678
679	=back
680
681	=head1 FULLY STATIC BINARIES - BUILDROOT	1220	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
682		1221
683	To make truly static (Linux-) libraries, you might want to have a look at	1222	To make truly static (Linux-) libraries, you might want to have a look at
684	buildroot (L<http://buildroot.uclibc.org/>).	1223	buildroot (L<http://buildroot.uclibc.org/>).
685		1224
686	Buildroot is primarily meant to set up a cross-compile environment (which	1225	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
693	good experiences with GCC 4.4.x but not GCC 4.5.	1232	good experiences with GCC 4.4.x but not GCC 4.5.
694		1233
695	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1234	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
696	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>	1235	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
697	doesn't decrease codesize much, but it makes the file much more	1236	doesn't decrease codesize much, but it makes the file much more
698	compressible.	1237	compressible (and the execution a lot slower...).
699		1238
700	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1239	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
701	no thread support). For Coro, it is highly recommended to switch to a	1240	no thread support). For Coro, it is highly recommended to switch to a
702	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201	1241	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
703	snapshot) and enable NPTL, otherwise Coro needs to be configured with the	1242	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
705	twice the address space needed for stacks).	1244	twice the address space needed for stacks).
706		1245
707	If you use C<linuxthreads.old>, then you should also be aware that	1246	If you use C<linuxthreads.old>, then you should also be aware that
708	uClibc shares C<errno> between all threads when statically linking. See	1247	uClibc shares C<errno> between all threads when statically linking. See
709	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a	1248	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
710	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1249	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
711		1250
712	C<ccache> support is also recommended, especially if you want	1251	C<ccache> support is also recommended, especially if you want
713	to play around with buildroot options. Enabling the C<miniperl>	1252	to play around with buildroot options. Enabling the C<miniperl>
714	package will probably enable all options required for a successful	1253	package will probably enable all options required for a successful
715	perl build. F<staticperl> itself additionally needs either C<wget>	1254	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
723	it from working properly in a chroot - either use dash (and link it to	1262	it from working properly in a chroot - either use dash (and link it to
724	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's	1263	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
725	built-in ash shell.	1264	built-in ash shell.
726		1265
727	Finally, you need F</dev/null> inside the chroot for many scripts to work	1266	Finally, you need F</dev/null> inside the chroot for many scripts to work
728	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will	1267	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
729	both provide this.	1268	will provide this.
730		1269
731	After you have compiled and set up your buildroot target, you can copy	1270	After you have compiled and set up your buildroot target, you can copy
732	F<staticperl> from the C<App::Staticperl> distribution or from your	1271	F<staticperl> from the C<App::Staticperl> distribution or from your
733	perl f<bin> directory (if you installed it) into the F<output/target>	1272	perl F<bin> directory (if you installed it) into the F<output/target>
734	filesystem, chroot inside and run it.	1273	filesystem, chroot inside and run it.
		1274
		1275	=head1 RECIPES / SPECIFIC MODULES
		1276
		1277	This section contains some common(?) recipes and information about
		1278	problems with some common modules or perl constructs that require extra
		1279	files to be included.
		1280
		1281	=head2 MODULES
		1282
		1283	=over 4
		1284
		1285	=item utf8
		1286
		1287	Some functionality in the utf8 module, such as swash handling (used
		1288	for unicode character ranges in regexes) is implemented in the
		1289	C<"utf8_heavy.pl"> library:
		1290
		1291	-Mutf8_heavy.pl
		1292
		1293	Many Unicode properties in turn are defined in separate modules,
		1294	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1295	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1296	are big (7MB uncompressed, although F<staticperl> contains special
		1297	handling for those files), so including them on demand by your application
		1298	only might pay off.
		1299
		1300	To simply include the whole unicode database, use:
		1301
		1302	--incglob '/unicore/**.pl'
		1303
		1304	=item AnyEvent
		1305
		1306	AnyEvent needs a backend implementation that it will load in a delayed
		1307	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1308	for AnyEvent if it can't find anything else, and is usually a safe
		1309	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1310	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1311	well.
		1312
		1313	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1314	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1315	C<"AnyEvent/Util/uts46data.pl">.
		1316
		1317	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1318	everything.
		1319
		1320	=item Cairo
		1321
		1322	See Glib, same problem, same solution.
		1323
		1324	=item Carp
		1325
		1326	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1327	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1328
		1329	=item Config
		1330
		1331	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1332	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1333	both.
		1334
		1335	=item Glib
		1336
		1337	Glib literally requires Glib to be installed already to build - it tries
		1338	to fake this by running Glib out of the build directory before being
		1339	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1340	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1341
		1342	=item Gtk2
		1343
		1344	See Pango, same problems, same solution.
		1345
		1346	=item Pango
		1347
		1348	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1349	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1350	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1351
		1352	=item Term::ReadLine::Perl
		1353
		1354	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
		1355
		1356	=item URI
		1357
		1358	URI implements schemes as separate modules - the generic URL scheme is
		1359	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1360	you need to use any of these schemes, you should include these manually,
		1361	or use C<--usepacklists>.
		1362
		1363	=back
		1364
		1365	=head2 RECIPES
		1366
		1367	=over 4
		1368
		1369	=item Just link everything in
		1370
		1371	To link just about everything installed in the perl library into a new
		1372	perl, try this (the first time this runs it will take a long time, as a
		1373	lot of files need to be parsed):
		1374
		1375	staticperl mkperl -v --strip ppi --incglob '*'
		1376
		1377	If you don't mind the extra megabytes, this can be a very effective way of
		1378	creating bundles without having to worry about forgetting any modules.
		1379
		1380	You get even more useful variants of this method by first selecting
		1381	everything, and then excluding stuff you are reasonable sure not to need -
		1382	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1383
		1384	=item Getting rid of netdb functions
		1385
		1386	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1387	and so on) that few applications use. You can avoid compiling them in by
		1388	putting the following fragment into a C<preconfigure> hook:
		1389
		1390	preconfigure() {
		1391	for sym in \
		1392	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1393	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1394	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1395	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1396	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1397	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1398	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1399	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1400	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1401	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1402	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1403	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1404	d_getspnam_r d_getsbyname
		1405	# d_gethbyname
		1406	do
		1407	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1408	done
		1409	}
		1410
		1411	This mostly gains space when linking statically, as the functions will
		1412	likely not be linked in. The gain for dynamically-linked binaries is
		1413	smaller.
		1414
		1415	Also, this leaves C<gethostbyname> in - not only is it actually used
		1416	often, the L<Socket> module also exposes it, so leaving it out usually
		1417	gains little. Why Socket exposes a C function that is in the core already
		1418	is anybody's guess.
		1419
		1420	=back
735		1421
736	=head1 AUTHOR	1422	=head1 AUTHOR
737		1423
738	Marc Lehmann <schmorp@schmorp.de>	1424	Marc Lehmann <schmorp@schmorp.de>
739	http://software.schmorp.de/pkg/staticperl.html	1425	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.11 by root, Tue Dec 7 10:40:39 2010 UTC vs. Revision 1.48 by root, Sun Jul 10 01:37:56 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.11 by root, Tue Dec 7 10:40:39 2010 UTC vs.
Revision 1.48 by root, Sun Jul 10 01:37:56 2011 UTC