[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.23 by root, Mon Dec 13 18:08:01 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.
		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
…		…
103	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,
104	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
105	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
106	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
107		119
108	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
109	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
110	repeated as often as necessary.	122	often as necessary.
111		123
112	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
113		125
114	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
115	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
116	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
117	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
118	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>.
119		133
120	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
121	optionally followed by any parameters.	135	optionally followed by any parameters.
122		136
123	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
…		…
144		158
145	To force recompilation or reinstallation, you need to run F<staticperl	159	To force recompilation or reinstallation, you need to run F<staticperl
146	distclean> first.	160	distclean> first.
147		161
148	=over 4	162	=over 4
		163
		164	=item F<staticperl version>
		165
		166	Prints some info about the version of the F<staticperl> script you are using.
149		167
150	=item F<staticperl fetch>	168	=item F<staticperl fetch>
151		169
152	Runs only the download and unpack phase, unless this has already happened.	170	Runs only the download and unpack phase, unless this has already happened.
153		171
…		…
244	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	262	(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	263	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	264	to include that module. I found out about these dependencies by carefully
247	watching any error messages about missing modules...	265	watching any error messages about missing modules...
248		266
		267	Instead of building a new perl binary, you can also build a standalone
		268	application:
		269
		270	# build the app
		271	staticperl mkapp app --boot eg/httpd \
		272	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		273
		274	# run it
		275	./app
		276
249	=head3 OPTION PROCESSING	277	=head3 OPTION PROCESSING
250		278
251	All options can be given as arguments on the command line (typically	279	All options can be given as arguments on the command line (typically
252	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	280	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
253	specifying a lot of modules can make the command line very cumbersome,	281	specifying a lot of modules can make the command line very cumbersome,
…		…
268		296
269	All options that specify modules or files to be added are processed in the	297	All options that specify modules or files to be added are processed in the
270	order given on the command line (that affects the C<--use> and C<--eval>	298	order given on the command line (that affects the C<--use> and C<--eval>
271	options at the moment).	299	options at the moment).
272		300
		301	=head3 PACKAGE SELECTION WORKFLOW
		302
		303	F<staticperl mkbundle> has a number of options to control package
		304	selection. This section describes how they interact with each other. Also,
		305	since I am still a newbie w.r.t. these issues, maybe future versions of
		306	F<staticperl> will change this, so watch out :)
		307
		308	The idiom "in order" means "in order that they are specified on the
		309	commandline". If you use a bundle specification file, then the options
		310	will be processed as if they were given in place of the bundle file name.
		311
		312	=over 4
		313
		314	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
		315	C<--incglob> options, in order.
		316
		317	In addition, C<--use> and C<--eval> dependencies will be added when the
		318	options are processed.
		319
		320	=item 2. apply all C<--include> and C<--exclude> options, in order.
		321
		322	All this step does is potentially reduce the number of files already
		323	selected or found in phase 1.
		324
		325	=item 3. find all modules (== F<.pm> files), gather their static archives
		326	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
		327	extra libraries they need for linking (F<extralibs.ld>) and optionally
		328	evaluate any F<.packlist> files.
		329
		330	This step is required to link against XS extensions and also adds files
		331	required for L<AutoLoader> to do it's job.
		332
		333	=back
		334
		335	After this, all the files selected for bundling will be read and processed
		336	(stripped), the bundle files will be written, and optionally a new F<perl>
		337	or application binary will be linked.
		338
273	=head3 MKBUNDLE OPTIONS	339	=head3 MKBUNDLE OPTIONS
274		340
275	=over 4	341	=over 4
276		342
277	=item --verbose \| -v	343	=item --verbose \| -v
…		…
289		355
290	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	356	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
291	pod documentation, which is very fast and reduces file size a lot.	357	pod documentation, which is very fast and reduces file size a lot.
292		358
293	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	359	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
294	saves a lot more than just L<Pod::Strip>, and is generally safer, but	360	saves a lot more than just L<Pod::Strip>, and is generally safer,
295	is also a lot slower, so is best used for production builds. Note that	361	but is also a lot slower (some files take almost a minute to strip -
296	this method doesn't optimise for raw file size, but for best compression	362	F<staticperl> maintains a cache of stripped files to speed up subsequent
297	(that means that the uncompressed file size is a bit larger, but the files	363	runs for this reason). Note that this method doesn't optimise for raw file
298	compress better, e.g. with F<upx>).	364	size, but for best compression (that means that the uncompressed file size
		365	is a bit larger, but the files compress better, e.g. with F<upx>).
299		366
300	Last not least, if you need accurate line numbers in error messages,	367	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	368	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	369	mistreated, you can specify C<none> to not mangle included perl sources in
303	any way.	370	any way.
…		…
311	This switch is automatically used when F<staticperl> is invoked with the	378	This switch is automatically used when F<staticperl> is invoked with the
312	C<mkperl> command (instead of C<mkbundle>):	379	C<mkperl> command (instead of C<mkbundle>):
313		380
314	# build a new ./perl with only common::sense in it - very small :)	381	# build a new ./perl with only common::sense in it - very small :)
315	staticperl mkperl -Mcommon::sense	382	staticperl mkperl -Mcommon::sense
		383
		384	=item --app name
		385
		386	After writing out the bundle files, try to link a new standalone
		387	program. It will be called C<name>, and the bundle files get removed after
		388	linking it.
		389
		390	The difference to the (mutually exclusive) C<--perl> option is that the
		391	binary created by this option will not try to act as a perl interpreter -
		392	instead it will simply initialise the perl interpreter, clean it up and
		393	exit.
		394
		395	This switch is automatically used when F<staticperl> is invoked with the
		396	C<mkapp> command (instead of C<mkbundle>):
		397
		398	To let it do something useful you I<must> add some boot code, e.g. with
		399	the C<--boot> option.
		400
		401	Example: create a standalone perl binary that will execute F<appfile> when
		402	it is started.
		403
		404	staticperl mkbundle --app myexe --boot appfile
316		405
317	=item --use module \| -Mmodule	406	=item --use module \| -Mmodule
318		407
319	Include the named module and all direct dependencies. This is done by	408	Include the named module and all direct dependencies. This is done by
320	C<require>'ing the module in a subprocess and tracing which other modules	409	C<require>'ing the module in a subprocess and tracing which other modules
…		…
375	(using a C<require>) before anything else when the new perl is	464	(using a C<require>) before anything else when the new perl is
376	initialised. This can be used to modify C<@INC> or anything else before	465	initialised. This can be used to modify C<@INC> or anything else before
377	the perl interpreter executes scripts given on the command line (or via	466	the perl interpreter executes scripts given on the command line (or via
378	C<-e>). This works even in an embedded interpreter.	467	C<-e>). This works even in an embedded interpreter.
379		468
380	=item --add "file" \| --add "file alias"	469	=item --usepacklist
		470
		471	Read F<.packlist> files for each distribution that happens to match a
		472	module name you specified. Sounds weird, and it is, so expect semantics to
		473	change somehow in the future.
		474
		475	The idea is that most CPAN distributions have a F<.pm> file that matches
		476	the name of the distribution (which is rather reasonable after all).
		477
		478	If this switch is enabled, then if any of the F<.pm> files that have been
		479	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		480	and F<.ix> files installed by this distribution are also included.
		481
		482	For example, using this switch, when the L<URI> module is specified, then
		483	all L<URI> submodules that have been installed via the CPAN distribution
		484	are included as well, so you don't have to manually specify them.
		485
		486	=item --incglob pattern
		487
		488	This goes through all library directories and tries to match any F<.pm>
		489	and F<.pl> files against the extended glob pattern (see below). If a file
		490	matches, it is added. This switch will automatically detect L<AutoLoader>
		491	files and the required link libraries for XS modules, but it will I<not>
		492	scan the file for dependencies (at the moment).
		493
		494	This is mainly useful to include "everything":
		495
		496	--incglob '*'
		497
		498	Or to include perl libraries, or trees of those, such as the unicode
		499	database files needed by many other modules:
		500
		501	--incglob '/unicore/**.pl'
		502
		503	=item --add file \| --add "file alias"
381		504
382	Adds the given (perl) file into the bundle (and optionally call it	505	Adds the given (perl) file into the bundle (and optionally call it
383	"alias"). This is useful to include any custom files into the bundle.	506	"alias"). This is useful to include any custom files into the bundle.
384		507
385	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	508	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
391	# specification file	514	# specification file
392	add file1 myfiles/file1	515	add file1 myfiles/file1
393	add file2 myfiles/file2	516	add file2 myfiles/file2
394	add file3 myfiles/file3	517	add file3 myfiles/file3
395		518
396	=item --binadd "file" \| --add "file alias"	519	=item --binadd file \| --add "file alias"
397		520
398	Just like C<--add>, except that it treats the file as binary and adds it	521	Just like C<--add>, except that it treats the file as binary and adds it
399	without any processing.	522	without any processing.
400		523
401	You should probably add a C</> prefix to avoid clashing with embedded	524	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	525	perl files (whose paths do not start with C</>), and/or use a special
403	directory, such as C</res/name>.	526	directory, such as C</res/name>.
404		527
405	You can later get a copy of these files by calling C<staticperl::find	528	You can later get a copy of these files by calling C<staticperl::find
406	"alias">.	529	"alias">.
		530
		531	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		532
		533	These two options define an include/exclude filter that is used after all
		534	files selected by the other options have been found. Each include/exclude
		535	is applied to all files found so far - an include makes sure that the
		536	given files will be part of the resulting file set, an exclude will
		537	exclude files. The patterns are "extended glob patterns" (see below).
		538
		539	For example, to include everything, except C<Devel> modules, but still
		540	include F<Devel::PPPort>, you could use this:
		541
		542	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
407		543
408	=item --static	544	=item --static
409		545
410	When C<--perl> is also given, link statically instead of dynamically. The	546	When C<--perl> is also given, link statically instead of dynamically. The
411	default is to link the new perl interpreter fully dynamic (that means all	547	default is to link the new perl interpreter fully dynamic (that means all
…		…
416	systems based on GNU libc don't really support it in a usable fashion	552	systems based on GNU libc don't really support it in a usable fashion
417	either. Try uClibc if you want to create fully statically linked	553	either. Try uClibc if you want to create fully statically linked
418	executables, or try the C<--staticlibs> option to link only some libraries	554	executables, or try the C<--staticlibs> option to link only some libraries
419	statically.	555	statically.
420		556
		557	=item --staticlib libname
		558
		559	When not linking fully statically, this option allows you to link specific
		560	libraries statically. What it does is simply replace all occurances of
		561	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		562	option.
		563
		564	This will have no effect unless the library is actually linked against,
		565	specifically, C<--staticlib> will not link against the named library
		566	unless it would be linked against anyway.
		567
		568	Example: link libcrypt statically into the binary.
		569
		570	staticperl mkperl -MIO::AIO --staticlib crypt
		571
		572	# ldopts might nwo contain:
		573	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		574
421	=item any other argument	575	=item any other argument
422		576
423	Any other argument is interpreted as a bundle specification file, which	577	Any other argument is interpreted as a bundle specification file, which
424	supports most long options (without extra quoting), one option per line.	578	supports most long options (without extra quoting), one option per line.
425		579
426	=back	580	=back
427		581
		582	=head3 EXTENDED GLOB PATTERNS
		583
		584	Some options of F<staticperl mkbundle> expect an I<extended glob
		585	pattern>. This is neither a normal shell glob nor a regex, but something
		586	in between. The idea has been copied from rsync, and there are the current
		587	matching rules:
		588
		589	=over 4
		590
		591	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		592
		593	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		594	nothing inside, and neither any other file or directory called F<unicore>
		595	anywhere else in the hierarchy.
		596
		597	=item Patterns not starting with F</> will be anchored at the end of the path.
		598
		599	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		600	hierarchy, but not any directories of the same name.
		601
		602	=item A F<*> matches any single component.
		603
		604	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		605	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		606	will not match slashes.
		607
		608	=item A F<**> matches anything.
		609
		610	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		611	no matter how deeply nested they are inside subdirectories.
		612
		613	=item A F<?> matches a single character within a component.
		614
		615	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		616	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		617
		618	=back
		619
428	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	620	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
429		621
430	During (each) startup, F<staticperl> tries to source the following shell	622	During (each) startup, F<staticperl> tries to source some shell files to
		623	allow you to fine-tune/override configuration settings.
		624
		625	In them you can override shell variables, or define shell functions
		626	("hooks") to be called at specific phases during installation. For
		627	example, you could define a C<postinstall> hook to install additional
		628	modules from CPAN each time you start from scratch.
		629
		630	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		631	to source the file named with it only. Otherwise, it tries the following
431	files in order:	632	shell files in order:
432		633
433	/etc/staticperlrc	634	/etc/staticperlrc
434	~/.staticperlrc	635	~/.staticperlrc
435	$STATICPERL/rc	636	$STATICPERL/rc
436
437	They can be used to override shell variables, or define functions to be
438	called at specific phases.
439		637
440	Note that the last file is erased during F<staticperl distclean>, so	638	Note that the last file is erased during F<staticperl distclean>, so
441	generally should not be used.	639	generally should not be used.
442		640
443	=head3 CONFIGURATION VARIABLES	641	=head3 CONFIGURATION VARIABLES
…		…
505		703
506	More commonly, you would either activate 64 bit integer support	704	More commonly, you would either activate 64 bit integer support
507	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	705	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
508	reduce filesize further.	706	reduce filesize further.
509		707
510	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	708	=item C<PERL_CC>, C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
511		709
512	These flags are passed to perl's F<Configure> script, and are generally	710	These flags are passed to perl's F<Configure> script, and are generally
513	optimised for small size (at the cost of performance). Since they also	711	optimised for small size (at the cost of performance). Since they also
514	contain subtle workarounds around various build issues, changing these	712	contain subtle workarounds around various build issues, changing these
515	usually requires understanding their default values - best look at the top	713	usually requires understanding their default values - best look at the top
…		…
518	=back	716	=back
519		717
520	=head4 Variables you probably I<do not want> to override	718	=head4 Variables you probably I<do not want> to override
521		719
522	=over 4	720	=over 4
		721
		722	=item C<MAKE>
		723
		724	The make command to use - default is C<make>.
523		725
524	=item C<MKBUNDLE>	726	=item C<MKBUNDLE>
525		727
526	Where F<staticperl> writes the C<mkbundle> command to	728	Where F<staticperl> writes the C<mkbundle> command to
527	(default: F<$STATICPERL/mkbundle>).	729	(default: F<$STATICPERL/mkbundle>).
…		…
747	After you have compiled and set up your buildroot target, you can copy	949	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	950	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>	951	perl f<bin> directory (if you installed it) into the F<output/target>
750	filesystem, chroot inside and run it.	952	filesystem, chroot inside and run it.
751		953
		954	=head1 RECIPES / SPECIFIC MODULES
		955
		956	This section contains some common(?) recipes and information about
		957	problems with some common modules or perl constructs that require extra
		958	files to be included.
		959
		960	=head2 MODULES
		961
		962	=over 4
		963
		964	=item utf8
		965
		966	Some functionality in the utf8 module, such as swash handling (used
		967	for unicode character ranges in regexes) is implemented in the
		968	C<"utf8_heavy.pl"> library:
		969
		970	-M'"utf8_heavy.pl"'
		971
		972	Many Unicode properties in turn are defined in separate modules,
		973	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		974	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		975	are big (7MB uncompressed, although F<staticperl> contains special
		976	handling for those files), so including them on demand by your application
		977	only might pay off.
		978
		979	To simply include the whole unicode database, use:
		980
		981	--incglob '/unicore/*.pl'
		982
		983	=item AnyEvent
		984
		985	AnyEvent needs a backend implementation that it will load in a delayed
		986	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		987	for AnyEvent if it can't find anything else, and is usually a safe
		988	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		989	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		990	well.
		991
		992	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		993	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		994	C<"AnyEvent/Util/uts46data.pl">.
		995
		996	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		997	everything.
		998
		999	=item Carp
		1000
		1001	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1002	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1003
		1004	=item Config
		1005
		1006	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1007	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1008	both.
		1009
		1010	=item Term::ReadLine::Perl
		1011
		1012	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1013
		1014	=item URI
		1015
		1016	URI implements schemes as separate modules - the generic URL scheme is
		1017	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1018	you need to use any of these schemes, you should include these manually,
		1019	or use C<--usepacklist>.
		1020
		1021	=back
		1022
		1023	=head2 RECIPES
		1024
		1025	=over 4
		1026
		1027	=item Linking everything in
		1028
		1029	To link just about everything installed in the perl library into a new
		1030	perl, try this:
		1031
		1032	staticperl mkperl --strip ppi --incglob '*'
		1033
		1034	=item Getting rid of netdb function
		1035
		1036	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1037	and so on) that few applications use. You can avoid compiling them in by
		1038	putting the following fragment into a C<preconfigure> hook:
		1039
		1040	preconfigure() {
		1041	for sym in \
		1042	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1043	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1044	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1045	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1046	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1047	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1048	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1049	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1050	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1051	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1052	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1053	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1054	d_getspnam_r d_getsbyname
		1055	# d_gethbyname
		1056	do
		1057	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1058	done
		1059	}
		1060
		1061	This mostly gains space when linking staticaly, as the functions will
		1062	likely not be linked in. The gain for dynamically-linked binaries is
		1063	smaller.
		1064
		1065	Also, this leaves C<gethostbyname> in - not only is it actually used
		1066	often, the L<Socket> module also exposes it, so leaving it out usually
		1067	gains little. Why Socket exposes a C function that is in the core already
		1068	is anybody's guess.
		1069
		1070	=back
		1071
752	=head1 AUTHOR	1072	=head1 AUTHOR
753		1073
754	Marc Lehmann <schmorp@schmorp.de>	1074	Marc Lehmann <schmorp@schmorp.de>
755	http://software.schmorp.de/pkg/staticperl.html	1075	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs. Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC