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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.2 by root, Mon Dec 6 20:53:44 2010 UTC vs.
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC

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

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.2 by root, Mon Dec 6 20:53:44 2010 UTC vs.
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC