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