[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.19 by root, Fri Dec 10 15:25:24 2010 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 50 modules all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one 500kb file
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	staticperl help # print the embedded documentation	7	staticperl help # print the embedded documentation
8	staticperl fetch # fetch and unpack perl sources	8	staticperl fetch # fetch and unpack perl sources
14	staticperl cpan # invoke CPAN shell	14	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	15	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	16	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	17	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	18	staticperl mkperl <bundle-args...> # see documentation
		19	staticperl mkapp appname <bundle-args...> # see documentation
19		20
20	Typical Examples:	21	Typical Examples:
21		22
22	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
23	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
24	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V
25	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26	# build a perl with the above modules linked in	27	# build a perl with the above modules linked in
		28	staticperl mkapp myapp --boot mainprog mymodules
		29	# build a binary "myapp" from mainprog and mymodules
27		30
28	=head1 DESCRIPTION	31	=head1 DESCRIPTION
29		32
30	This script helps you creating single-file perl interpreters, or embedding	33	This script helps you to create single-file perl interpreters
31	a 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
41	The created files do not need write access to the filesystem (like PAR	45	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,	46	does). In fact, since this script is in many ways similar to PAR::Packer,
43	here are the differences:	47	here are the differences:
44		48
45	=over 4	49	=over 4
46		50
…		…
63	=item * The generated executables don't need a writable filesystem.	67	=item * The generated executables don't need a writable filesystem.
64		68
65	F<staticperl> loads all required files directly from memory. There is no	69	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	70	need to unpack files into a temporary directory.
67		71
68	=item * More control over included files.	72	=item * More control over included files, more burden.
69		73
70	PAR tries to be maintainance and hassle-free - it tries to include more files	74	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	75	files than necessary to make sure everything works out of the box. It
		76	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.	77	can take substantial amounts of memory and file size.
73		78
74	With F<staticperl>, the burden is mostly with the developer - only direct	79	With F<staticperl>, the burden is mostly with the developer - only direct
75	compile-time dependencies and L<AutoLoader> are handled automatically.	80	compile-time dependencies and L<AutoLoader> are handled automatically.
76	This means the modules to include often need to be tweaked manually.	81	This means the modules to include often need to be tweaked manually.
		82
		83	All this does not preclude more permissive modes to be implemented in
		84	the future, but right now, you have to resolve state hidden dependencies
		85	manually.
77		86
78	=item * PAR works out of the box, F<staticperl> does not.	87	=item * PAR works out of the box, F<staticperl> does not.
79		88
80	Maintaining your own custom perl build can be a pain in the ass, and while	89	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	90	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	91	build and possibly fiddling with some modules. PAR is likely to produce
83	results faster.	92	results faster.
84		93
		94	Ok, PAR never has worked for me out of the box, and for some people,
		95	F<staticperl> does work out of the box, as they don't count "fiddling with
		96	module use lists" against it, but nevertheless, F<staticperl> is certainly
		97	a bit more difficult to use.
		98
85	=back	99	=back
86		100
87	=head1 HOW DOES IT WORK?	101	=head1 HOW DOES IT WORK?
88		102
89	Simple: F<staticperl> downloads, compile and installs a perl version of	103	Simple: F<staticperl> downloads, compile and installs a perl version of
90	your choice in F<~/.staticperl>. You can add extra modules either by	104	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	105	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	106	and doing it interactively. This usually takes 5-10 minutes, depending on
93	the speed of your computer and your internet conenction.	107	the speed of your computer and your internet connection.
94		108
95	It is possible to do program development at this stage, too.	109	It is possible to do program development at this stage, too.
96		110
97	Afterwards, you create a list of files and modules you want to include,	111	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	112	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	113	except everything is compiled in), or you create bundle files (basically C
100	sources you can use to embed all files into your project).	114	sources you can use to embed all files into your project).
101		115
102	This step is very fast (a few seconds if PPI is not used for stripping,	116	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	117	the stripped files are in the cache), and can be tweaked and repeated as
104	repeated as often as necessary.	118	often as necessary.
105		119
106	=head1 THE F<STATICPERL> SCRIPT	120	=head1 THE F<STATICPERL> SCRIPT
107		121
108	This module installs a script called F<staticperl> into your perl	122	This module installs a script called F<staticperl> into your perl
109	binary directory. The script is fully self-contained, and can be used	123	binary directory. The script is fully self-contained, and can be used
…		…
134	perl interpreter if required.	148	perl interpreter if required.
135		149
136	Most of the following commands simply run one or more steps of this	150	Most of the following commands simply run one or more steps of this
137	sequence.	151	sequence.
138		152
139	To force recompilation or reinstalaltion, you need to run F<staticperl	153	To force recompilation or reinstallation, you need to run F<staticperl
140	distclean> first.	154	distclean> first.
141		155
142	=over 4	156	=over 4
143		157
144	=item F<staticperl fetch>	158	=item F<staticperl fetch>
…		…
154	Builds the configured perl sources, potentially after automatically	168	Builds the configured perl sources, potentially after automatically
155	configuring them.	169	configuring them.
156		170
157	=item F<staticperl install>	171	=item F<staticperl install>
158		172
159	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and installs	173	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
160	the perl distribution, potentially aftering building it first.	174	installs the perl distribution, potentially after building it first.
161		175
162	=item F<staticperl cpan> [args...]	176	=item F<staticperl cpan> [args...]
163		177
164	Starts an interactive CPAN shell that you cna use to install further	178	Starts an interactive CPAN shell that you can use to install further
165	modules. Installs the perl first if neccessary, but apart from that,	179	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	180	no magic is involved: you could just as well run it manually via
167	F<~/.staticperl/perl/bin/cpan>.	181	F<~/.staticperl/perl/bin/cpan>.
168		182
169	Any additional arguments are simply passed to the F<cpan> command.	183	Any additional arguments are simply passed to the F<cpan> command.
170		184
…		…
177	staticperl instcpan EV AnyEvent::HTTPD Coro	191	staticperl instcpan EV AnyEvent::HTTPD Coro
178		192
179	=item F<staticperl instsrc> directory...	193	=item F<staticperl instsrc> directory...
180		194
181	In the unlikely case that you have unpacked perl modules around and want	195	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	196	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	197	command by specifying all the directories with modules in them that you
184	want to have built.	198	want to have built.
185		199
186	=item F<staticperl clean>	200	=item F<staticperl clean>
187		201
188	Runs F<make distclean> in the perl source directory (and potentially	202	Deletes the perl source directory (and potentially cleans up other
189	cleans up other intermediate files). This can be used to clean up	203	intermediate files). This can be used to clean up files only needed for
190	intermediate files without removing the installed perl interpreter.	204	building perl, without removing the installed perl interpreter, or to
		205	force a re-build from scratch.
		206
		207	At the moment, it doesn't delete downloaded tarballs.
191		208
192	=item F<staticperl distclean>	209	=item F<staticperl distclean>
193		210
194	This wipes your complete F<~/.staticperl> directory. Be careful with this,	211	This wipes your complete F<~/.staticperl> directory. Be careful with this,
195	it nukes your perl download, perl sources, perl distribution and any	212	it nukes your perl download, perl sources, perl distribution and any
…		…
210	In the oh so unlikely case of something not working here, you	227	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	228	can run the script manually as well (by default it is written to
212	F<~/.staticperl/mkbundle>).	229	F<~/.staticperl/mkbundle>).
213		230
214	F<mkbundle> is a more conventional command and expect the argument	231	F<mkbundle> is a more conventional command and expect the argument
215	syntax commonly used on unix clones. For example, this command builds	232	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>),	233	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>	234	F<AnyEvent::HTTPD>, F<URI> and a custom F<httpd> script (from F<eg/httpd>
218	in this distribution):	235	in this distribution):
219		236
220	# first make sure we have perl and the required modules	237	# first make sure we have perl and the required modules
…		…
229	./perl -Mhttpd	246	./perl -Mhttpd
230		247
231	As you can see, things are not quite as trivial: the L<Config> module has	248	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>),	249	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	250	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	251	specify manually (here L<AnyEvent::Impl::Perl>), and the F<URI> module
235	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	252	(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	253	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
237	to include that module.	254	to include that module. I found out about these dependencies by carefully
		255	watching any error messages about missing modules...
		256
		257	Instead of building a new perl binary, you can also build a standalone
		258	application:
		259
		260	# build the app
		261	staticperl mkapp app --boot eg/httpd \
		262	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		263
		264	# run it
		265	./app
238		266
239	=head3 OPTION PROCESSING	267	=head3 OPTION PROCESSING
240		268
241	All options can be given as arguments on the commandline (typically using	269	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	270	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,	271	specifying a lot of modules can make the command line very cumbersome,
244	you can put all long options into a "bundle specification file" (with or	272	you can put all long options into a "bundle specification file" (with or
245	without C<--> prefix) and specify this bundle file instead.	273	without C<--> prefix) and specify this bundle file instead.
246		274
247	For example, the command given earlier could also look like this:	275	For example, the command given earlier could also look like this:
248		276
…		…
255	use AnyEvent::HTTPD	283	use AnyEvent::HTTPD
256	use URI::http	284	use URI::http
257	add eg/httpd httpd.pm	285	add eg/httpd httpd.pm
258		286
259	All options that specify modules or files to be added are processed in the	287	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>	288	order given on the command line (that affects the C<--use> and C<--eval>
261	options at the moment).	289	options at the moment).
		290
		291	=head3 PACKAGE SELECTION WORKFLOW
		292
		293	F<staticperl mkbundle> has a number of options to control package
		294	selection. This section describes how they interact with each other. Also,
		295	since I am still a newbie w.r.t. these issues, maybe future versions of
		296	F<staticperl> will change this, so watch out :)
		297
		298	The idiom "in order" means "in order that they are specified on the
		299	commandline". If you use a bundle specification file, then the options
		300	will be processed as if they were given in place of the bundle file name.
		301
		302	=over 4
		303
		304	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
		305	C<--incglob> options, in order.
		306
		307	In addition, C<--use> and C<--eval> dependencies will be added when the
		308	options are processed.
		309
		310	=item 2. apply all C<--include> and C<--exclude> options, in order.
		311
		312	All this step does is potentially reduce the number of files already
		313	selected or found in phase 1.
		314
		315	=item 3. find all modules (== F<.pm> files), gather their static archives
		316	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files) and find any
		317	extra libraries they need for linking (F<extralibs.ld>).
		318
		319	This step is required to link against XS extensions and also adds files
		320	required for L<AutoLoader> to do it's job.
		321
		322	=back
		323
		324	After this, all the files selected for bundling will be read and processed
		325	(stripped), the bundle files will be written, and optionally a new F<perl>
		326	or application binary will be linked.
262		327
263	=head3 MKBUNDLE OPTIONS	328	=head3 MKBUNDLE OPTIONS
264		329
265	=over 4	330	=over 4
266		331
…		…
276		341
277	Specify the stripping method applied to reduce the file of the perl	342	Specify the stripping method applied to reduce the file of the perl
278	sources included.	343	sources included.
279		344
280	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	345	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.	346	pod documentation, which is very fast and reduces file size a lot.
282		347
283	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	348	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	349	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.	350	but is also a lot slower (some files take almost a minute to strip -
		351	F<staticperl> maintains a cache of stripped files to speed up subsequent
		352	runs for this reason). Note that this method doesn't optimise for raw file
		353	size, but for best compression (that means that the uncompressed file size
		354	is a bit larger, but the files compress better, e.g. with F<upx>).
286		355
		356	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	357	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	358	mistreated, you can specify C<none> to not mangle included perl sources in
289	perl sources in any way.	359	any way.
290		360
291	=item --perl	361	=item --perl
292		362
293	After writing out the bundle files, try to link a new perl interpreter. It	363	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	364	will be called F<perl> and will be left in the current working
295	directory. The bundle files will be removed.	365	directory. The bundle files will be removed.
296		366
297	This switch is automatically ued when F<staticperl> is invoked with the	367	This switch is automatically used when F<staticperl> is invoked with the
298	C<mkperl> command (instead of C<mkbundle>):	368	C<mkperl> command (instead of C<mkbundle>):
299		369
300	# build a new ./perl with only common::sense in it - very small :)	370	# build a new ./perl with only common::sense in it - very small :)
301	staticperl mkperl -Mcommon::sense	371	staticperl mkperl -Mcommon::sense
		372
		373	=item --app name
		374
		375	After writing out the bundle files, try to link a new standalone
		376	program. It will be called C<name>, and the bundle files get removed after
		377	linking it.
		378
		379	The difference to the (mutually exclusive) C<--perl> option is that the
		380	binary created by this option will not try to act as a perl interpreter -
		381	instead it will simply initialise the perl interpreter, clean it up and
		382	exit.
		383
		384	This switch is automatically used when F<staticperl> is invoked with the
		385	C<mkapp> command (instead of C<mkbundle>):
		386
		387	To let it do something useful you I<must> add some boot code, e.g. with
		388	the C<--boot> option.
		389
		390	Example: create a standalone perl binary that will execute F<appfile> when
		391	it is started.
		392
		393	staticperl mkbundle --app myexe --boot appfile
302		394
303	=item --use module \| -Mmodule	395	=item --use module \| -Mmodule
304		396
305	Include the named module and all direct dependencies. This is done by	397	Include the named module and all direct dependencies. This is done by
306	C<require>'ing the module in a subprocess and tracing which other modules	398	C<require>'ing the module in a subprocess and tracing which other modules
…		…
311		403
312	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	404	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
313		405
314	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	406	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
315	maybe other weirdly named files. To do that, you need to quote the name in	407	maybe other weirdly named files. To do that, you need to quote the name in
316	single or double quoutes. When given on the commandline, you probably need	408	single or double quotes. When given on the command line, you probably need
317	to quote once more to avoid your shell interpreting it. Common cases that	409	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>.	410	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
319		411
320	Example: include the required files for F<perl -V> to work in all its	412	Example: include the required files for F<perl -V> to work in all its
321	glory (F<Config.pm> is included automatically by this).	413	glory (F<Config.pm> is included automatically by this).
…		…
338	variables or whatever you need. All files C<require>'d or C<use>'d in the	430	variables or whatever you need. All files C<require>'d or C<use>'d in the
339	script are included in the final bundle.	431	script are included in the final bundle.
340		432
341	Keep in mind that F<mkbundle> will only C<require> the modules named	433	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	434	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.	435	C<--use>'d earlier on the command line to be available.
344		436
345	Example: force L<AnyEvent> to detect a backend and therefore include it	437	Example: force L<AnyEvent> to detect a backend and therefore include it
346	in the final bundle.	438	in the final bundle.
347		439
348	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'	440	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
…		…
358	=item --boot filename	450	=item --boot filename
359		451
360	Include the given file in the bundle and arrange for it to be executed	452	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	453	(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	454	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	455	the perl interpreter executes scripts given on the command line (or via
364	C<-e>). This works even in an embedded interpreter.	456	C<-e>). This works even in an embedded interpreter.
365		457
366	=item --add "file" \| --add "file alias"	458	=item --incglob pattern
		459
		460	This goes through all library directories and tries to match any F<.pm>
		461	and F<.pl> files against the extended glob pattern (see below). If a file
		462	matches, it is added. This switch will automatically detect L<AutoLoader>
		463	files and the required link libraries for XS modules, but it will I<not>
		464	scan the file for dependencies (at the moment).
		465
		466	This is mainly useful to include "everything":
		467
		468	--incglob '*'
		469
		470	Or to include perl libraries, or trees of those, such as the unicode
		471	database files needed by many other modules:
		472
		473	--incglob '/unicore/**.pl'
		474
		475	=item --add file \| --add "file alias"
367		476
368	Adds the given (perl) file into the bundle (and optionally call it	477	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.	478	"alias"). This is useful to include any custom files into the bundle.
370		479
371	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	480	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
376		485
377	# specification file	486	# specification file
378	add file1 myfiles/file1	487	add file1 myfiles/file1
379	add file2 myfiles/file2	488	add file2 myfiles/file2
380	add file3 myfiles/file3	489	add file3 myfiles/file3
		490
		491	=item --binadd file \| --add "file alias"
		492
		493	Just like C<--add>, except that it treats the file as binary and adds it
		494	without any processing.
		495
		496	You should probably add a C</> prefix to avoid clashing with embedded
		497	perl files (whose paths do not start with C</>), and/or use a special
		498	directory, such as C</res/name>.
		499
		500	You can later get a copy of these files by calling C<staticperl::find
		501	"alias">.
		502
		503	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		504
		505	These two options define an include/exclude filter that is used after all
		506	files selected by the other options have been found. Each include/exclude
		507	is applied to all files found so far - an include makes sure that the
		508	given files will be part of the resulting file set, an exclude will
		509	exclude files. The patterns are "extended glob patterns" (see below).
		510
		511	For example, to include everything, except C<Devel> modules, but still
		512	include F<Devel::PPPort>, you could use this:
		513
		514	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
381		515
382	=item --static	516	=item --static
383		517
384	When C<--perl> is also given, link statically instead of dynamically. The	518	When C<--perl> is also given, link statically instead of dynamically. The
385	default is to link the new perl interpreter fully dynamic (that means all	519	default is to link the new perl interpreter fully dynamic (that means all
…		…
390	systems based on GNU libc don't really support it in a usable fashion	524	systems based on GNU libc don't really support it in a usable fashion
391	either. Try uClibc if you want to create fully statically linked	525	either. Try uClibc if you want to create fully statically linked
392	executables, or try the C<--staticlibs> option to link only some libraries	526	executables, or try the C<--staticlibs> option to link only some libraries
393	statically.	527	statically.
394		528
		529	=item --staticlib libname
		530
		531	When not linking fully statically, this option allows you to link specific
		532	libraries statically. What it does is simply replace all occurances of
		533	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		534	option.
		535
		536	This will have no effect unless the library is actually linked against,
		537	specifically, C<--staticlib> will not link against the named library
		538	unless it would be linked against anyway.
		539
		540	Example: link libcrypt statically into the binary.
		541
		542	staticperl mkperl -MIO::AIO --staticlib crypt
		543
		544	# ldopts might nwo contain:
		545	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		546
395	=item any other argument	547	=item any other argument
396		548
397	Any other argument is interpreted as a bundle specification file, which	549	Any other argument is interpreted as a bundle specification file, which
398	supports most long options (without extra quoting), one option per line.	550	supports most long options (without extra quoting), one option per line.
399		551
400	=back	552	=back
401		553
		554	=head3 EXTENDED GLOB PATTERNS
		555
		556	Some options of F<staticperl mkbundle> expect an I<extended glob
		557	pattern>. This is neither a normal shell glob nor a regex, but something
		558	in between. The idea has been copied from rsync, and there are the current
		559	matching rules:
		560
		561	=over 4
		562
		563	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		564
		565	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		566	nothing inside, and neither any other file or directory called F<unicore>
		567	anywhere else in the hierarchy.
		568
		569	=item Patterns not starting with F</> will be anchored at the end of the path.
		570
		571	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		572	hierarchy, but not any directories of the same name.
		573
		574	=item A F<*> matches any single component.
		575
		576	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		577	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		578	will not match slashes.
		579
		580	=item A F<**> matches anything.
		581
		582	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		583	no matter how deeply nested they are inside subdirectories.
		584
		585	=item A F<?> matches a single character within a component.
		586
		587	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		588	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		589
		590	=back
		591
402	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	592	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
403		593
404	During (each) startup, F<staticperl> tries to source the following shell	594	During (each) startup, F<staticperl> tries to source the following shell
405	files in order:	595	files in order:
406		596
407	/etc/staticperlrc	597	/etc/staticperlrc
…		…
423	=item C<EMAIL>	613	=item C<EMAIL>
424		614
425	The e-mail address of the person who built this binary. Has no good	615	The e-mail address of the person who built this binary. Has no good
426	default, so should be specified by you.	616	default, so should be specified by you.
427		617
428	=back	618	=item C<CPAN>
429		619
		620	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
		621
		622	=item C<EXTRA_MODULES>
		623
		624	Additional modules installed during F<staticperl install>. Here you can
		625	set which modules you want have to installed from CPAN.
		626
		627	Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO.
		628
		629	EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO"
		630
		631	Note that you can also use a C<postinstall> hook to achieve this, and
		632	more.
		633
		634	=back
		635
430	=head4 Variables you I<might want> to override	636	=head4 Variables you might I<want> to override
431		637
432	=over 4	638	=over 4
433		639
		640	=item C<STATICPERL>
		641
		642	The directory where staticperl stores all its files
		643	(default: F<~/.staticperl>).
		644
		645	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
		646
		647	Usually set to C<1> to make modules "less inquisitive" during their
		648	installation, you can set any environment variable you want - some modules
		649	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
		650
434	=item C<PERLVER>	651	=item C<PERL_VERSION>
435		652
436	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	653	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	654	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).	655	about as big as 5.12.2).
439		656
440	=item C<CPAN>	657	=item C<PERL_PREFIX>
441		658
442	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).	659	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
		660	i.e. where the F<bin> and F<lib> subdirectories will end up.
		661
		662	=item C<PERL_CONFIGURE>
		663
		664	Additional Configure options - these are simply passed to the perl
		665	Configure script. For example, if you wanted to enable dynamic loading,
		666	you could pass C<-Dusedl>. To enable ithreads (Why would you want that
		667	insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads>
		668	and so on.
		669
		670	More commonly, you would either activate 64 bit integer support
		671	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
		672	reduce filesize further.
443		673
444	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	674	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
445		675
446	These flags are passed to perl's F<Configure> script, and are generally	676	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	677	optimised for small size (at the cost of performance). Since they also
448	contain subtle workarounds around various build issues, changing these	678	contain subtle workarounds around various build issues, changing these
449	usually requires understanding their default values - best look at the top	679	usually requires understanding their default values - best look at the top
450	of the F<staticperl> script for more info on these.	680	of the F<staticperl> script for more info on these.
451		681
452	=item C<STATICPERL>
453
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	682	=back
481		683
482	=head4 Variables you I<probably do not want> to override	684	=head4 Variables you probably I<do not want> to override
483		685
484	=over 4	686	=over 4
485		687
486	=item C<MKBUNDLE>	688	=item C<MKBUNDLE>
487		689
…		…
497		699
498	=head3 OVERRIDABLE HOOKS	700	=head3 OVERRIDABLE HOOKS
499		701
500	In addition to environment variables, it is possible to provide some	702	In addition to environment variables, it is possible to provide some
501	shell functions that are called at specific times. To provide your own	703	shell functions that are called at specific times. To provide your own
502	commands, justd efine the corresponding function.	704	commands, just define the corresponding function.
503		705
504	Example: install extra modules from CPAN and from some directories	706	Example: install extra modules from CPAN and from some directories
505	at F<staticperl install> time.	707	at F<staticperl install> time.
506		708
507	postinstall() {	709	postinstall() {
508	rm -rf lib/threads.* # weg mit Schaden	710	rm -rf lib/threads* # weg mit Schaden
509	instcpan IO::AIO EV	711	instcpan IO::AIO EV
510	instsrc ~/src/AnyEvent	712	instsrc ~/src/AnyEvent
511	instsrc ~/src/XML-Sablotron-1.0100001	713	instsrc ~/src/XML-Sablotron-1.0100001
512	instcpan AnyEvent::HTTPD	714	instcpan Anyevent::AIO AnyEvent::HTTPD
513	}	715	}
514		716
515	=over 4	717	=over 4
		718
		719	=item preconfigure
		720
		721	Called just before running F<./Configur> in the perl source
		722	directory. Current working directory is the perl source directory.
		723
		724	This can be used to set any C<PERL_xxx> variables, which might be costly
		725	to compute.
516		726
517	=item postconfigure	727	=item postconfigure
518		728
519	Called after configuring, but before building perl. Current working	729	Called after configuring, but before building perl. Current working
520	directory is the perl source directory.	730	directory is the perl source directory.
521		731
522	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or	732	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
523	do any other modifications.	733	or do any other modifications.
524		734
525	=item postbuild	735	=item postbuild
526		736
527	Called after building, but before installing perl. Current working	737	Called after building, but before installing perl. Current working
528	directory is the perl source directory.	738	directory is the perl source directory.
…		…
543	The script must return with a zero exit status, or the installation will	753	The script must return with a zero exit status, or the installation will
544	fail.	754	fail.
545		755
546	=back	756	=back
547		757
		758	=head1 ANATOMY OF A BUNDLE
		759
		760	When not building a new perl binary, C<mkbundle> will leave a number of
		761	files in the current working directory, which can be used to embed a perl
		762	interpreter in your program.
		763
		764	Intimate knowledge of L<perlembed> and preferably some experience with
		765	embedding perl is highly recommended.
		766
		767	C<mkperl> (or the C<--perl> option) basically does this to link the new
		768	interpreter (it also adds a main program to F<bundle.>):
		769
		770	$Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts)
		771
		772	=over 4
		773
		774	=item bundle.h
		775
		776	A header file that contains the prototypes of the few symbols "exported"
		777	by bundle.c, and also exposes the perl headers to the application.
		778
		779	=over 4
		780
		781	=item staticperl_init ()
		782
		783	Initialises the perl interpreter. You can use the normal perl functions
		784	after calling this function, for example, to define extra functions or
		785	to load a .pm file that contains some initialisation code, or the main
		786	program function:
		787
		788	XS (xsfunction)
		789	{
		790	dXSARGS;
		791
		792	// now we have items, ST(i) etc.
		793	}
		794
		795	static void
		796	run_myapp(void)
		797	{
		798	staticperl_init ();
		799	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		800	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
		801	}
		802
		803	=item staticperl_xs_init (pTHX)
		804
		805	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
		806	which case you do not want to use C<staticperl_init> but call them on your
		807	own.
		808
		809	Then you need this function - either pass it directly as the C<xs_init>
		810	function to C<perl_parse>, or call it from your own C<xs_init> function.
		811
		812	=item staticperl_cleanup ()
		813
		814	In the unlikely case that you want to destroy the perl interpreter, here
		815	is the corresponding function.
		816
		817	=item PerlInterpreter *staticperl
		818
		819	The perl interpreter pointer used by staticperl. Not normally so useful,
		820	but there it is.
		821
		822	=back
		823
		824	=item bundle.ccopts
		825
		826	Contains the compiler options required to compile at least F<bundle.c> and
		827	any file that includes F<bundle.h> - you should probably use it in your
		828	C<CFLAGS>.
		829
		830	=item bundle.ldopts
		831
		832	The linker options needed to link the final program.
		833
		834	=back
		835
		836	=head1 RUNTIME FUNCTIONALITY
		837
		838	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which
		839	are required to access the bundled perl sources, but might be useful for
		840	other purposes.
		841
		842	In addition, for the embedded loading of perl files to work, F<staticperl>
		843	overrides the C<@INC> array.
		844
		845	=over 4
		846
		847	=item $file = staticperl::find $path
		848
		849	Returns the data associated with the given C<$path>
		850	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
		851	the UNIX path relative to the perl library directory.
		852
		853	Returns C<undef> if the file isn't embedded.
		854
		855	=item @paths = staticperl::list
		856
		857	Returns the list of all paths embedded in this binary.
		858
		859	=back
		860
		861	=head1 FULLY STATIC BINARIES - BUILDROOT
		862
		863	To make truly static (Linux-) libraries, you might want to have a look at
		864	buildroot (L<http://buildroot.uclibc.org/>).
		865
		866	Buildroot is primarily meant to set up a cross-compile environment (which
		867	is not so useful as perl doesn't quite like cross compiles), but it can also compile
		868	a chroot environment where you can use F<staticperl>.
		869
		870	To do so, download buildroot, and enable "Build options => development
		871	files in target filesystem" and optionally "Build options => gcc
		872	optimization level (optimize for size)". At the time of writing, I had
		873	good experiences with GCC 4.4.x but not GCC 4.5.
		874
		875	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
		876	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
		877	doesn't decrease codesize much, but it makes the file much more
		878	compressible.
		879
		880	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
		881	no thread support). For Coro, it is highly recommended to switch to a
		882	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
		883	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
		884	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
		885	twice the address space needed for stacks).
		886
		887	If you use C<linuxthreads.old>, then you should also be aware that
		888	uClibc shares C<errno> between all threads when statically linking. See
		889	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
		890	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
		891
		892	C<ccache> support is also recommended, especially if you want
		893	to play around with buildroot options. Enabling the C<miniperl>
		894	package will probably enable all options required for a successful
		895	perl build. F<staticperl> itself additionally needs either C<wget>
		896	(recommended, for CPAN) or C<curl>.
		897
		898	As for shells, busybox should provide all that is needed, but the default
		899	busybox configuration doesn't include F<comm> which is needed by perl -
		900	either make a custom busybox config, or compile coreutils.
		901
		902	For the latter route, you might find that bash has some bugs that keep
		903	it from working properly in a chroot - either use dash (and link it to
		904	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
		905	built-in ash shell.
		906
		907	Finally, you need F</dev/null> inside the chroot for many scripts to work
		908	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
		909	both provide this.
		910
		911	After you have compiled and set up your buildroot target, you can copy
		912	F<staticperl> from the C<App::Staticperl> distribution or from your
		913	perl f<bin> directory (if you installed it) into the F<output/target>
		914	filesystem, chroot inside and run it.
		915
		916	=head1 RECIPES / SPECIFIC MODULES
		917
		918	This section contains some common(?) recipes and information about
		919	problems with some common modules or perl constructs that require extra
		920	files to be included.
		921
		922	=head2 MODULES
		923
		924	=over 4
		925
		926	=item utf8
		927
		928	Some functionality in the utf8 module, such as swash handling (used
		929	for unicode character ranges in regexes) is implemented in the
		930	C<"utf8_heavy.pl"> library:
		931
		932	-M'"utf8_heavy.pl"'
		933
		934	Many Unicode properties in turn are defined in separate modules,
		935	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		936	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		937	are big (7MB uncompressed, although F<staticperl> contains special
		938	handling for those files), so including them on demand by your application
		939	only might pay off.
		940
		941	To simply include the whole unicode database, use:
		942
		943	--incglob '/unicore/*.pl'
		944
		945	=item AnyEvent
		946
		947	AnyEvent needs a backend implementation that it will load in a delayed
		948	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		949	for AnyEvent if it can't find anything else, and is usually a safe
		950	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		951	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		952	well.
		953
		954	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		955	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		956	C<"AnyEvent/Util/uts46data.pl">.
		957
		958	=item Carp
		959
		960	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		961	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		962
		963	=item Config
		964
		965	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		966	turn might need L<"Config_heavy.pl">. Including the latter gives you
		967	both.
		968
		969	=item Term::ReadLine::Perl
		970
		971	Also needs L<Term::ReadLine::readline>.
		972
		973	=item URI
		974
		975	URI implements schemes as separate modules - the generic URL scheme is
		976	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		977	you need to use any of these schemes, you should include these manually.
		978
		979	=back
		980
		981	=head2 RECIPES
		982
		983	=over 4
		984
		985	=item Linking everything in
		986
		987	To link just about everything installed in the perl library into a new
		988	perl, try this:
		989
		990	staticperl mkperl --strip ppi --incglob '*'
		991
		992	=item Getting rid of netdb function
		993
		994	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		995	and so on) that few applications use. You can avoid compiling them in by
		996	putting the following fragment into a C<preconfigure> hook:
		997
		998	preconfigure() {
		999	for sym in \
		1000	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1001	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1002	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1003	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1004	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1005	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1006	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1007	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1008	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1009	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1010	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1011	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1012	d_getspnam_r d_getsbyname
		1013	# d_gethbyname
		1014	do
		1015	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1016	done
		1017	}
		1018
		1019	This mostly gains space when linking staticaly, as the functions will
		1020	liekly not be linked in. The gain for dynamically-linked binaries is
		1021	smaller.
		1022
		1023	Also, this leaves C<gethostbyname> in - not only is it actually used
		1024	often, the L<Socket> module also exposes it, so leaving it out usually
		1025	gains little. Why Socket exposes a C function that is in the core already
		1026	is anybody's guess.
		1027
		1028	=back
		1029
548	=head1 AUTHOR	1030	=head1 AUTHOR
549		1031
550	Marc Lehmann <schmorp@schmorp.de>	1032	Marc Lehmann <schmorp@schmorp.de>
551	http://software.schmorp.de/pkg/staticperl.html	1033	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.19 by root, Fri Dec 10 15:25:24 2010 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.19 by root, Fri Dec 10 15:25:24 2010 UTC