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

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

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.4 by root, Mon Dec 6 21:12:21 2010 UTC vs.
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC