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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.15 by root, Wed Dec 8 23:01:30 2010 UTC vs.
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC

…		…
28	staticperl mkapp myapp --boot mainprog mymodules	28	staticperl mkapp myapp --boot mainprog mymodules
29	# build a binary "myapp" from mainprog and mymodules	29	# build a binary "myapp" from mainprog and mymodules
30		30
31	=head1 DESCRIPTION	31	=head1 DESCRIPTION
32		32
33	This script helps you creating single-file perl interpreters, or embedding	33	This script helps you to create single-file perl interpreters
34	a perl interpreter in your applications. Single-file means that it is	34	or applications, or embedding a perl interpreter in your
35	fully self-contained - no separate shared objects, no autoload fragments,	35	applications. Single-file means that it is fully self-contained - no
36	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
37	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
38	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.
39		40
40	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
41	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,	42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
42	Coro and so 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/>.
43		48
44	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
45	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,
46	here are the differences:	51	here are the differences:
47		52
…		…
66	=item * The generated executables don't need a writable filesystem.	71	=item * The generated executables don't need a writable filesystem.
67		72
68	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
69	need to unpack files into a temporary directory.	74	need to unpack files into a temporary directory.
70		75
71	=item * More control over included files.	76	=item * More control over included files, more burden.
72		77
73	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
74	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
75	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)
76	memory and file size.	81	can take substantial amounts of memory and file size.
77		82
78	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
79	compile-time dependencies and L<AutoLoader> are handled automatically.	84	compile-time dependencies and L<AutoLoader> are handled automatically.
80	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.
81		90
82	=item * PAR works out of the box, F<staticperl> does not.	91	=item * PAR works out of the box, F<staticperl> does not.
83		92
84	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
85	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
…		…
106	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,
107	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
108	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
109	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
110		119
111	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
112	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
113	repeated as often as necessary.	122	often as necessary.
114		123
115	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
116		125
117	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
118	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be used
…		…
147		156
148	To force recompilation or reinstallation, you need to run F<staticperl	157	To force recompilation or reinstallation, you need to run F<staticperl
149	distclean> first.	158	distclean> first.
150		159
151	=over 4	160	=over 4
		161
		162	=item F<staticperl version>
		163
		164	Prints some info about the version of the F<staticperl> script you are using.
152		165
153	=item F<staticperl fetch>	166	=item F<staticperl fetch>
154		167
155	Runs only the download and unpack phase, unless this has already happened.	168	Runs only the download and unpack phase, unless this has already happened.
156		169
…		…
281		294
282	All options that specify modules or files to be added are processed in the	295	All options that specify modules or files to be added are processed in the
283	order given on the command line (that affects the C<--use> and C<--eval>	296	order given on the command line (that affects the C<--use> and C<--eval>
284	options at the moment).	297	options at the moment).
285		298
		299	=head3 PACKAGE SELECTION WORKFLOW
		300
		301	F<staticperl mkbundle> has a number of options to control package
		302	selection. This section describes how they interact with each other. Also,
		303	since I am still a newbie w.r.t. these issues, maybe future versions of
		304	F<staticperl> will change this, so watch out :)
		305
		306	The idiom "in order" means "in order that they are specified on the
		307	commandline". If you use a bundle specification file, then the options
		308	will be processed as if they were given in place of the bundle file name.
		309
		310	=over 4
		311
		312	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
		313	C<--incglob> options, in order.
		314
		315	In addition, C<--use> and C<--eval> dependencies will be added when the
		316	options are processed.
		317
		318	=item 2. apply all C<--include> and C<--exclude> options, in order.
		319
		320	All this step does is potentially reduce the number of files already
		321	selected or found in phase 1.
		322
		323	=item 3. find all modules (== F<.pm> files), gather their static archives
		324	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
		325	extra libraries they need for linking (F<extralibs.ld>) and optionally
		326	evaluate any F<.packlist> files.
		327
		328	This step is required to link against XS extensions and also adds files
		329	required for L<AutoLoader> to do it's job.
		330
		331	=back
		332
		333	After this, all the files selected for bundling will be read and processed
		334	(stripped), the bundle files will be written, and optionally a new F<perl>
		335	or application binary will be linked.
		336
286	=head3 MKBUNDLE OPTIONS	337	=head3 MKBUNDLE OPTIONS
287		338
288	=over 4	339	=over 4
289		340
290	=item --verbose \| -v	341	=item --verbose \| -v
…		…
302		353
303	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	354	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
304	pod documentation, which is very fast and reduces file size a lot.	355	pod documentation, which is very fast and reduces file size a lot.
305		356
306	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	357	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
307	saves a lot more than just L<Pod::Strip>, and is generally safer, but	358	saves a lot more than just L<Pod::Strip>, and is generally safer,
308	is also a lot slower, so is best used for production builds. Note that	359	but is also a lot slower (some files take almost a minute to strip -
309	this method doesn't optimise for raw file size, but for best compression	360	F<staticperl> maintains a cache of stripped files to speed up subsequent
310	(that means that the uncompressed file size is a bit larger, but the files	361	runs for this reason). Note that this method doesn't optimise for raw file
311	compress better, e.g. with F<upx>).	362	size, but for best compression (that means that the uncompressed file size
		363	is a bit larger, but the files compress better, e.g. with F<upx>).
312		364
313	Last not least, if you need accurate line numbers in error messages,	365	Last not least, if you need accurate line numbers in error messages,
314	or in the unlikely case where C<pod> is too slow, or some module gets	366	or in the unlikely case where C<pod> is too slow, or some module gets
315	mistreated, you can specify C<none> to not mangle included perl sources in	367	mistreated, you can specify C<none> to not mangle included perl sources in
316	any way.	368	any way.
…		…
410	(using a C<require>) before anything else when the new perl is	462	(using a C<require>) before anything else when the new perl is
411	initialised. This can be used to modify C<@INC> or anything else before	463	initialised. This can be used to modify C<@INC> or anything else before
412	the perl interpreter executes scripts given on the command line (or via	464	the perl interpreter executes scripts given on the command line (or via
413	C<-e>). This works even in an embedded interpreter.	465	C<-e>). This works even in an embedded interpreter.
414		466
415	=item --add "file" \| --add "file alias"	467	=item --usepacklist
		468
		469	Read F<.packlist> files for each distribution that happens to match a
		470	module name you specified. Sounds weird, and it is, so expect semantics to
		471	change somehow in the future.
		472
		473	The idea is that most CPAN distributions have a F<.pm> file that matches
		474	the name of the distribution (which is rather reasonable after all).
		475
		476	If this switch is enabled, then if any of the F<.pm> files that have been
		477	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		478	and F<.ix> files installed by this distribution are also included.
		479
		480	For example, using this switch, when the L<URI> module is specified, then
		481	all L<URI> submodules that have been installed via the CPAN distribution
		482	are included as well, so you don't have to manually specify them.
		483
		484	=item --incglob pattern
		485
		486	This goes through all library directories and tries to match any F<.pm>
		487	and F<.pl> files against the extended glob pattern (see below). If a file
		488	matches, it is added. This switch will automatically detect L<AutoLoader>
		489	files and the required link libraries for XS modules, but it will I<not>
		490	scan the file for dependencies (at the moment).
		491
		492	This is mainly useful to include "everything":
		493
		494	--incglob '*'
		495
		496	Or to include perl libraries, or trees of those, such as the unicode
		497	database files needed by many other modules:
		498
		499	--incglob '/unicore/**.pl'
		500
		501	=item --add file \| --add "file alias"
416		502
417	Adds the given (perl) file into the bundle (and optionally call it	503	Adds the given (perl) file into the bundle (and optionally call it
418	"alias"). This is useful to include any custom files into the bundle.	504	"alias"). This is useful to include any custom files into the bundle.
419		505
420	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	506	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
426	# specification file	512	# specification file
427	add file1 myfiles/file1	513	add file1 myfiles/file1
428	add file2 myfiles/file2	514	add file2 myfiles/file2
429	add file3 myfiles/file3	515	add file3 myfiles/file3
430		516
431	=item --binadd "file" \| --add "file alias"	517	=item --binadd file \| --add "file alias"
432		518
433	Just like C<--add>, except that it treats the file as binary and adds it	519	Just like C<--add>, except that it treats the file as binary and adds it
434	without any processing.	520	without any processing.
435		521
436	You should probably add a C</> prefix to avoid clashing with embedded	522	You should probably add a C</> prefix to avoid clashing with embedded
437	perl files (whose paths do not start with C</>), and/or use a special	523	perl files (whose paths do not start with C</>), and/or use a special
438	directory, such as C</res/name>.	524	directory, such as C</res/name>.
439		525
440	You can later get a copy of these files by calling C<staticperl::find	526	You can later get a copy of these files by calling C<staticperl::find
441	"alias">.	527	"alias">.
		528
		529	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		530
		531	These two options define an include/exclude filter that is used after all
		532	files selected by the other options have been found. Each include/exclude
		533	is applied to all files found so far - an include makes sure that the
		534	given files will be part of the resulting file set, an exclude will
		535	exclude files. The patterns are "extended glob patterns" (see below).
		536
		537	For example, to include everything, except C<Devel> modules, but still
		538	include F<Devel::PPPort>, you could use this:
		539
		540	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
442		541
443	=item --static	542	=item --static
444		543
445	When C<--perl> is also given, link statically instead of dynamically. The	544	When C<--perl> is also given, link statically instead of dynamically. The
446	default is to link the new perl interpreter fully dynamic (that means all	545	default is to link the new perl interpreter fully dynamic (that means all
…		…
451	systems based on GNU libc don't really support it in a usable fashion	550	systems based on GNU libc don't really support it in a usable fashion
452	either. Try uClibc if you want to create fully statically linked	551	either. Try uClibc if you want to create fully statically linked
453	executables, or try the C<--staticlibs> option to link only some libraries	552	executables, or try the C<--staticlibs> option to link only some libraries
454	statically.	553	statically.
455		554
		555	=item --staticlib libname
		556
		557	When not linking fully statically, this option allows you to link specific
		558	libraries statically. What it does is simply replace all occurances of
		559	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		560	option.
		561
		562	This will have no effect unless the library is actually linked against,
		563	specifically, C<--staticlib> will not link against the named library
		564	unless it would be linked against anyway.
		565
		566	Example: link libcrypt statically into the binary.
		567
		568	staticperl mkperl -MIO::AIO --staticlib crypt
		569
		570	# ldopts might nwo contain:
		571	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		572
456	=item any other argument	573	=item any other argument
457		574
458	Any other argument is interpreted as a bundle specification file, which	575	Any other argument is interpreted as a bundle specification file, which
459	supports most long options (without extra quoting), one option per line.	576	supports most long options (without extra quoting), one option per line.
460		577
461	=back	578	=back
462		579
		580	=head3 EXTENDED GLOB PATTERNS
		581
		582	Some options of F<staticperl mkbundle> expect an I<extended glob
		583	pattern>. This is neither a normal shell glob nor a regex, but something
		584	in between. The idea has been copied from rsync, and there are the current
		585	matching rules:
		586
		587	=over 4
		588
		589	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		590
		591	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		592	nothing inside, and neither any other file or directory called F<unicore>
		593	anywhere else in the hierarchy.
		594
		595	=item Patterns not starting with F</> will be anchored at the end of the path.
		596
		597	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		598	hierarchy, but not any directories of the same name.
		599
		600	=item A F<*> matches any single component.
		601
		602	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		603	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		604	will not match slashes.
		605
		606	=item A F<**> matches anything.
		607
		608	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		609	no matter how deeply nested they are inside subdirectories.
		610
		611	=item A F<?> matches a single character within a component.
		612
		613	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		614	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		615
		616	=back
		617
463	=head2 F<STATICPERL> CONFIGURATION AND HOOKS	618	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
464		619
465	During (each) startup, F<staticperl> tries to source the following shell	620	During (each) startup, F<staticperl> tries to source some shell files to
		621	allow you to fine-tune/override configuration settings.
		622
		623	In them you can override shell variables, or define shell functions
		624	("hooks") to be called at specific phases during installation. For
		625	example, you could define a C<postinstall> hook to install additional
		626	modules from CPAN each time you start from scratch.
		627
		628	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		629	to source the file named with it only. Otherwise, it tries the following
466	files in order:	630	shell files in order:
467		631
468	/etc/staticperlrc	632	/etc/staticperlrc
469	~/.staticperlrc	633	~/.staticperlrc
470	$STATICPERL/rc	634	$STATICPERL/rc
471
472	They can be used to override shell variables, or define functions to be
473	called at specific phases.
474		635
475	Note that the last file is erased during F<staticperl distclean>, so	636	Note that the last file is erased during F<staticperl distclean>, so
476	generally should not be used.	637	generally should not be used.
477		638
478	=head3 CONFIGURATION VARIABLES	639	=head3 CONFIGURATION VARIABLES
…		…
782	After you have compiled and set up your buildroot target, you can copy	943	After you have compiled and set up your buildroot target, you can copy
783	F<staticperl> from the C<App::Staticperl> distribution or from your	944	F<staticperl> from the C<App::Staticperl> distribution or from your
784	perl f<bin> directory (if you installed it) into the F<output/target>	945	perl f<bin> directory (if you installed it) into the F<output/target>
785	filesystem, chroot inside and run it.	946	filesystem, chroot inside and run it.
786		947
		948	=head1 RECIPES / SPECIFIC MODULES
		949
		950	This section contains some common(?) recipes and information about
		951	problems with some common modules or perl constructs that require extra
		952	files to be included.
		953
		954	=head2 MODULES
		955
		956	=over 4
		957
		958	=item utf8
		959
		960	Some functionality in the utf8 module, such as swash handling (used
		961	for unicode character ranges in regexes) is implemented in the
		962	C<"utf8_heavy.pl"> library:
		963
		964	-M'"utf8_heavy.pl"'
		965
		966	Many Unicode properties in turn are defined in separate modules,
		967	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		968	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		969	are big (7MB uncompressed, although F<staticperl> contains special
		970	handling for those files), so including them on demand by your application
		971	only might pay off.
		972
		973	To simply include the whole unicode database, use:
		974
		975	--incglob '/unicore/*.pl'
		976
		977	=item AnyEvent
		978
		979	AnyEvent needs a backend implementation that it will load in a delayed
		980	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		981	for AnyEvent if it can't find anything else, and is usually a safe
		982	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		983	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		984	well.
		985
		986	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		987	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		988	C<"AnyEvent/Util/uts46data.pl">.
		989
		990	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		991	everything.
		992
		993	=item Carp
		994
		995	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		996	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		997
		998	=item Config
		999
		1000	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1001	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1002	both.
		1003
		1004	=item Term::ReadLine::Perl
		1005
		1006	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1007
		1008	=item URI
		1009
		1010	URI implements schemes as separate modules - the generic URL scheme is
		1011	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1012	you need to use any of these schemes, you should include these manually,
		1013	or use C<--usepacklist>.
		1014
		1015	=back
		1016
		1017	=head2 RECIPES
		1018
		1019	=over 4
		1020
		1021	=item Linking everything in
		1022
		1023	To link just about everything installed in the perl library into a new
		1024	perl, try this:
		1025
		1026	staticperl mkperl --strip ppi --incglob '*'
		1027
		1028	=item Getting rid of netdb function
		1029
		1030	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1031	and so on) that few applications use. You can avoid compiling them in by
		1032	putting the following fragment into a C<preconfigure> hook:
		1033
		1034	preconfigure() {
		1035	for sym in \
		1036	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1037	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1038	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1039	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1040	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1041	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1042	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1043	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1044	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1045	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1046	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1047	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1048	d_getspnam_r d_getsbyname
		1049	# d_gethbyname
		1050	do
		1051	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1052	done
		1053	}
		1054
		1055	This mostly gains space when linking staticaly, as the functions will
		1056	liekly not be linked in. The gain for dynamically-linked binaries is
		1057	smaller.
		1058
		1059	Also, this leaves C<gethostbyname> in - not only is it actually used
		1060	often, the L<Socket> module also exposes it, so leaving it out usually
		1061	gains little. Why Socket exposes a C function that is in the core already
		1062	is anybody's guess.
		1063
		1064	=back
		1065
787	=head1 AUTHOR	1066	=head1 AUTHOR
788		1067
789	Marc Lehmann <schmorp@schmorp.de>	1068	Marc Lehmann <schmorp@schmorp.de>
790	http://software.schmorp.de/pkg/staticperl.html	1069	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.15 by root, Wed Dec 8 23:01:30 2010 UTC vs. Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.15 by root, Wed Dec 8 23:01:30 2010 UTC vs.
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC