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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC

…		…
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	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38	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,
39	Coro and so on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
40		44
…		…
63	=item * The generated executables don't need a writable filesystem.	67	=item * The generated executables don't need a writable filesystem.
64		68
65	F<staticperl> loads all required files directly from memory. There is no	69	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	70	need to unpack files into a temporary directory.
67		71
68	=item * More control over included files.	72	=item * More control over included files, more burden.
69		73
70	PAR tries to be maintenance and hassle-free - it tries to include more	74	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	75	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	76	mostly succeeds at this, but he extra files (such as the unicode database)
73	memory and file size.	77	can take substantial amounts of memory and file size.
74		78
75	With F<staticperl>, the burden is mostly with the developer - only direct	79	With F<staticperl>, the burden is mostly with the developer - only direct
76	compile-time dependencies and L<AutoLoader> are handled automatically.	80	compile-time dependencies and L<AutoLoader> are handled automatically.
77	This means the modules to include often need to be tweaked manually.	81	This means the modules to include often need to be tweaked manually.
		82
		83	All this does not preclude more permissive modes to be implemented in
		84	the future, but right now, you have to resolve state hidden dependencies
		85	manually.
78		86
79	=item * PAR works out of the box, F<staticperl> does not.	87	=item * PAR works out of the box, F<staticperl> does not.
80		88
81	Maintaining your own custom perl build can be a pain in the ass, and while	89	Maintaining your own custom perl build can be a pain in the ass, and while
82	F<staticperl> tries to make this easy, it still requires a custom perl	90	F<staticperl> tries to make this easy, it still requires a custom perl
…		…
103	Afterwards, you create a list of files and modules you want to include,	111	Afterwards, you create a list of files and modules you want to include,
104	and then either build a new perl binary (that acts just like a normal perl	112	and then either build a new perl binary (that acts just like a normal perl
105	except everything is compiled in), or you create bundle files (basically C	113	except everything is compiled in), or you create bundle files (basically C
106	sources you can use to embed all files into your project).	114	sources you can use to embed all files into your project).
107		115
108	This step is very fast (a few seconds if PPI is not used for stripping,	116	This step is very fast (a few seconds if PPI is not used for stripping, or
109	more seconds otherwise, as PPI is very slow), and can be tweaked and	117	the stripped files are in the cache), and can be tweaked and repeated as
110	repeated as often as necessary.	118	often as necessary.
111		119
112	=head1 THE F<STATICPERL> SCRIPT	120	=head1 THE F<STATICPERL> SCRIPT
113		121
114	This module installs a script called F<staticperl> into your perl	122	This module installs a script called F<staticperl> into your perl
115	binary directory. The script is fully self-contained, and can be used	123	binary directory. The script is fully self-contained, and can be used
…		…
244	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	252	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
245	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	253	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
246	to include that module. I found out about these dependencies by carefully	254	to include that module. I found out about these dependencies by carefully
247	watching any error messages about missing modules...	255	watching any error messages about missing modules...
248		256
		257	Instead of building a new perl binary, you can also build a standalone
		258	application:
		259
		260	# build the app
		261	staticperl mkapp app --boot eg/httpd \
		262	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		263
		264	# run it
		265	./app
		266
249	=head3 OPTION PROCESSING	267	=head3 OPTION PROCESSING
250		268
251	All options can be given as arguments on the command line (typically	269	All options can be given as arguments on the command line (typically
252	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	270	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
253	specifying a lot of modules can make the command line very cumbersome,	271	specifying a lot of modules can make the command line very cumbersome,
…		…
289		307
290	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	308	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
291	pod documentation, which is very fast and reduces file size a lot.	309	pod documentation, which is very fast and reduces file size a lot.
292		310
293	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	311	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
294	saves a lot more than just L<Pod::Strip>, and is generally safer, but	312	saves a lot more than just L<Pod::Strip>, and is generally safer,
295	is also a lot slower, so is best used for production builds. Note that	313	but is also a lot slower (some files take almost a minute to strip -
296	this method doesn't optimise for raw file size, but for best compression	314	F<staticperl> maintains a cache of stripped files to speed up subsequent
297	(that means that the uncompressed file size is a bit larger, but the files	315	runs for this reason). Note that this method doesn't optimise for raw file
298	compress better, e.g. with F<upx>).	316	size, but for best compression (that means that the uncompressed file size
		317	is a bit larger, but the files compress better, e.g. with F<upx>).
299		318
300	Last not least, if you need accurate line numbers in error messages,	319	Last not least, if you need accurate line numbers in error messages,
301	or in the unlikely case where C<pod> is too slow, or some module gets	320	or in the unlikely case where C<pod> is too slow, or some module gets
302	mistreated, you can specify C<none> to not mangle included perl sources in	321	mistreated, you can specify C<none> to not mangle included perl sources in
303	any way.	322	any way.
…		…
311	This switch is automatically used when F<staticperl> is invoked with the	330	This switch is automatically used when F<staticperl> is invoked with the
312	C<mkperl> command (instead of C<mkbundle>):	331	C<mkperl> command (instead of C<mkbundle>):
313		332
314	# build a new ./perl with only common::sense in it - very small :)	333	# build a new ./perl with only common::sense in it - very small :)
315	staticperl mkperl -Mcommon::sense	334	staticperl mkperl -Mcommon::sense
		335
		336	=item --app name
		337
		338	After writing out the bundle files, try to link a new standalone
		339	program. It will be called C<name>, and the bundle files get removed after
		340	linking it.
		341
		342	The difference to the (mutually exclusive) C<--perl> option is that the
		343	binary created by this option will not try to act as a perl interpreter -
		344	instead it will simply initialise the perl interpreter, clean it up and
		345	exit.
		346
		347	This switch is automatically used when F<staticperl> is invoked with the
		348	C<mkapp> command (instead of C<mkbundle>):
		349
		350	To let it do something useful you I<must> add some boot code, e.g. with
		351	the C<--boot> option.
		352
		353	Example: create a standalone perl binary that will execute F<appfile> when
		354	it is started.
		355
		356	staticperl mkbundle --app myexe --boot appfile
316		357
317	=item --use module \| -Mmodule	358	=item --use module \| -Mmodule
318		359
319	Include the named module and all direct dependencies. This is done by	360	Include the named module and all direct dependencies. This is done by
320	C<require>'ing the module in a subprocess and tracing which other modules	361	C<require>'ing the module in a subprocess and tracing which other modules
…		…
375	(using a C<require>) before anything else when the new perl is	416	(using a C<require>) before anything else when the new perl is
376	initialised. This can be used to modify C<@INC> or anything else before	417	initialised. This can be used to modify C<@INC> or anything else before
377	the perl interpreter executes scripts given on the command line (or via	418	the perl interpreter executes scripts given on the command line (or via
378	C<-e>). This works even in an embedded interpreter.	419	C<-e>). This works even in an embedded interpreter.
379		420
380	=item --add "file" \| --add "file alias"	421	=item --incglob pattern
		422
		423	This goes through all library directories and tries to match any F<.pm>
		424	and F<.pl> files against the extended glob pattern (see below). If a file
		425	matches, it is added. This switch will automatically detect L<AutoLoader>
		426	files and the required link libraries for XS modules, but it will I<not>
		427	scan the file for dependencies (at the moment).
		428
		429	This is mainly useful to include "everything":
		430
		431	--incglob '*'
		432
		433	Or to include perl libraries, or trees of those, such as the unicode
		434	database files needed by many other modules:
		435
		436	--incglob '/unicore/**.pl'
		437
		438	=item --add file \| --add "file alias"
381		439
382	Adds the given (perl) file into the bundle (and optionally call it	440	Adds the given (perl) file into the bundle (and optionally call it
383	"alias"). This is useful to include any custom files into the bundle.	441	"alias"). This is useful to include any custom files into the bundle.
384		442
385	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	443	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
391	# specification file	449	# specification file
392	add file1 myfiles/file1	450	add file1 myfiles/file1
393	add file2 myfiles/file2	451	add file2 myfiles/file2
394	add file3 myfiles/file3	452	add file3 myfiles/file3
395		453
396	=item --binadd "file" \| --add "file alias"	454	=item --binadd file \| --add "file alias"
397		455
398	Just like C<--add>, except that it treats the file as binary and adds it	456	Just like C<--add>, except that it treats the file as binary and adds it
399	without any processing.	457	without any processing.
400		458
401	You should probably add a C</> prefix to avoid clashing with embedded	459	You should probably add a C</> prefix to avoid clashing with embedded
402	perl files (whose paths do not start with C</>), and/or use a special	460	perl files (whose paths do not start with C</>), and/or use a special
403	directory, such as C</res/name>.	461	directory, such as C</res/name>.
404		462
405	You can later get a copy of these files by calling C<staticperl::find	463	You can later get a copy of these files by calling C<staticperl::find
406	"alias">.	464	"alias">.
		465
		466	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		467
		468	These two options define an include/exclude filter that is used after all
		469	files selected by the other options have been found. Each include/exclude
		470	is applied to all files found so far - an include makes sure that the
		471	given files will be part of the resulting file set, an exclude will
		472	exclude files. The patterns are "extended glob patterns" (see below).
		473
		474	For example, to include everything, except C<Devel> modules, but still
		475	include F<Devel::PPPort>, you could use this:
		476
		477	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
407		478
408	=item --static	479	=item --static
409		480
410	When C<--perl> is also given, link statically instead of dynamically. The	481	When C<--perl> is also given, link statically instead of dynamically. The
411	default is to link the new perl interpreter fully dynamic (that means all	482	default is to link the new perl interpreter fully dynamic (that means all
…		…
416	systems based on GNU libc don't really support it in a usable fashion	487	systems based on GNU libc don't really support it in a usable fashion
417	either. Try uClibc if you want to create fully statically linked	488	either. Try uClibc if you want to create fully statically linked
418	executables, or try the C<--staticlibs> option to link only some libraries	489	executables, or try the C<--staticlibs> option to link only some libraries
419	statically.	490	statically.
420		491
		492	=item --staticlib libname
		493
		494	When not linking fully statically, this option allows you to link specific
		495	libraries statically. What it does is simply replace all occurances of
		496	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		497	option.
		498
		499	This will have no effect unless the library is actually linked against,
		500	specifically, C<--staticlib> will not link against the named library
		501	unless it would be linked against anyway.
		502
		503	Example: link libcrypt statically into the binary.
		504
		505	staticperl mkperl -MIO::AIO --staticlib crypt
		506
		507	# ldopts might nwo contain:
		508	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		509
421	=item any other argument	510	=item any other argument
422		511
423	Any other argument is interpreted as a bundle specification file, which	512	Any other argument is interpreted as a bundle specification file, which
424	supports most long options (without extra quoting), one option per line.	513	supports most long options (without extra quoting), one option per line.
425		514
426	=back	515	=back
427		516
		517	=head3 EXTENDED GLOB PATTERNS
		518
		519	Some options of F<staticperl mkbundle> expect an I<extended glob
		520	pattern>. This is neither a normal shell glob nor a regex, but something
		521	in between. The idea has been copied from rsync, and there are the current
		522	matching rules:
		523
		524	=over 4
		525
		526	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		527
		528	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		529	nothing inside, and neither any other file or directory called F<unicore>
		530	anywhere else in the hierarchy.
		531
		532	=item Patterns not starting with F</> will be anchored at the end of the path.
		533
		534	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		535	hierarchy, but not any directories of the same name.
		536
		537	=item A F<*> matches any single component.
		538
		539	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		540	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		541	will not match slashes.
		542
		543	=item A F<**> matches anything.
		544
		545	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		546	no matter how deeply nested they are inside subdirectories.
		547
		548	=item A F<?> matches a single character within a component.
		549
		550	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		551	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		552
		553	=back
		554
428	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	555	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
429		556
430	During (each) startup, F<staticperl> tries to source the following shell	557	During (each) startup, F<staticperl> tries to source the following shell
431	files in order:	558	files in order:
432		559
433	/etc/staticperlrc	560	/etc/staticperlrc
…		…
747	After you have compiled and set up your buildroot target, you can copy	874	After you have compiled and set up your buildroot target, you can copy
748	F<staticperl> from the C<App::Staticperl> distribution or from your	875	F<staticperl> from the C<App::Staticperl> distribution or from your
749	perl f<bin> directory (if you installed it) into the F<output/target>	876	perl f<bin> directory (if you installed it) into the F<output/target>
750	filesystem, chroot inside and run it.	877	filesystem, chroot inside and run it.
751		878
		879	=head1 RECIPES / SPECIFIC MODULES
		880
		881	This section contains some common(?) recipes and information about
		882	problems with some common modules or perl constructs that require extra
		883	files to be included.
		884
		885	=head2 MODULES
		886
		887	=over 4
		888
		889	=item utf8
		890
		891	Some functionality in the utf8 module, such as swash handling (used
		892	for unicode character ranges in regexes) is implemented in the
		893	C<"utf8_heavy.pl"> library:
		894
		895	-M'"utf8_heavy.pl"'
		896
		897	Many Unicode properties in turn are defined in separate modules,
		898	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		899	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		900	are big (7MB uncompressed, although F<staticperl> contains special
		901	handling for those files), so including them on demand by your application
		902	only might pay off.
		903
		904	To simply include the whole unicode database, use:
		905
		906	--incglob '/unicore/*.pl'
		907
		908	=item AnyEvent
		909
		910	AnyEvent needs a backend implementation that it will load in a delayed
		911	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		912	for AnyEvent if it can't find anything else, and is usually a safe
		913	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		914	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		915	well.
		916
		917	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		918	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		919	C<"AnyEvent/Util/uts46data.pl">.
		920
		921	=item Carp
		922
		923	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		924	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		925
		926	=item Config
		927
		928	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		929	turn might need L<"Config_heavy.pl">. Including the latter gives you
		930	both.
		931
		932	=item Term::ReadLine::Perl
		933
		934	Also needs L<Term::ReadLine::readline>.
		935
		936	=item URI
		937
		938	URI implements schemes as separate modules - the generic URL scheme is
		939	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		940	you need to use any of these schemes, you should include these manually.
		941
		942	=back
		943
		944	=head2 RECIPES
		945
		946	=over 4
		947
		948	=item Linking everything in
		949
		950	To link just about everything installed in the perl library into a new
		951	perl, try this:
		952
		953	staticperl mkperl --strip ppi --incglob '*'
		954
		955	=item Getting rid of netdb function
		956
		957	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		958	and so on) that few applications use. You can avoid compiling them in by
		959	putting the following fragment into a C<preconfigure> hook:
		960
		961	preconfigure() {
		962	for sym in \
		963	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		964	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		965	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		966	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		967	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		968	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		969	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		970	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		971	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		972	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		973	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		974	d_getservbyname_r d_getservbyport_r d_getservent_r \
		975	d_getspnam_r d_getsbyname
		976	# d_gethbyname
		977	do
		978	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		979	done
		980	}
		981
		982	This mostly gains space when linking staticaly, as the functions will
		983	liekly not be linked in. The gain for dynamically-linked binaries is
		984	smaller.
		985
		986	Also, this leaves C<gethostbyname> in - not only is it actually used
		987	often, the L<Socket> module also exposes it, so leaving it out usually
		988	gains little. Why Socket exposes a C function that is in the core already
		989	is anybody's guess.
		990
		991	=back
		992
752	=head1 AUTHOR	993	=head1 AUTHOR
753		994
754	Marc Lehmann <schmorp@schmorp.de>	995	Marc Lehmann <schmorp@schmorp.de>
755	http://software.schmorp.de/pkg/staticperl.html	996	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.13 by root, Tue Dec 7 19:55:56 2010 UTC vs. Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC