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

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

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.7 by root, Mon Dec 6 21:21:44 2010 UTC vs.
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC