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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.12 by root, Tue Dec 7 13:23:07 2010 UTC vs.
Revision 1.22 by root, Mon Dec 13 17:25:17 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
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
…		…
139		158
140	To force recompilation or reinstallation, you need to run F<staticperl	159	To force recompilation or reinstallation, you need to run F<staticperl
141	distclean> first.	160	distclean> first.
142		161
143	=over 4	162	=over 4
		163
		164	=item F<staticperl version>
		165
		166	Prints some info about the version of the F<staticperl> script you are using.
144		167
145	=item F<staticperl fetch>	168	=item F<staticperl fetch>
146		169
147	Runs only the download and unpack phase, unless this has already happened.	170	Runs only the download and unpack phase, unless this has already happened.
148		171
…		…
239	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	262	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
240	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
241	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
242	watching any error messages about missing modules...	265	watching any error messages about missing modules...
243		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
244	=head3 OPTION PROCESSING	277	=head3 OPTION PROCESSING
245		278
246	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
247	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
248	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,
…		…
263		296
264	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
265	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>
266	options at the moment).	299	options at the moment).
267		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
268	=head3 MKBUNDLE OPTIONS	339	=head3 MKBUNDLE OPTIONS
269		340
270	=over 4	341	=over 4
271		342
272	=item --verbose \| -v	343	=item --verbose \| -v
…		…
284		355
285	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
286	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.
287		358
288	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
289	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,
290	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 -
291	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
292	(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
293	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>).
294		366
295	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,
296	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
297	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
298	any way.	370	any way.
…		…
306	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
307	C<mkperl> command (instead of C<mkbundle>):	379	C<mkperl> command (instead of C<mkbundle>):
308		380
309	# 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 :)
310	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
311		405
312	=item --use module \| -Mmodule	406	=item --use module \| -Mmodule
313		407
314	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
315	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
…		…
370	(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
371	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
372	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
373	C<-e>). This works even in an embedded interpreter.	467	C<-e>). This works even in an embedded interpreter.
374		468
375	=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"
376		504
377	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
378	"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.
379		507
380	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.
…		…
386	# specification file	514	# specification file
387	add file1 myfiles/file1	515	add file1 myfiles/file1
388	add file2 myfiles/file2	516	add file2 myfiles/file2
389	add file3 myfiles/file3	517	add file3 myfiles/file3
390		518
391	=item --binadd "file" \| --add "file alias"	519	=item --binadd file \| --add "file alias"
392		520
393	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
394	without any processing.	522	without any processing.
395		523
396	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
397	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
398	directory, such as C</res/name>.	526	directory, such as C</res/name>.
399		527
400	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
401	"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/*'
402		543
403	=item --static	544	=item --static
404		545
405	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
406	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
…		…
411	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
412	either. Try uClibc if you want to create fully statically linked	553	either. Try uClibc if you want to create fully statically linked
413	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
414	statically.	555	statically.
415		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
416	=item any other argument	575	=item any other argument
417		576
418	Any other argument is interpreted as a bundle specification file, which	577	Any other argument is interpreted as a bundle specification file, which
419	supports most long options (without extra quoting), one option per line.	578	supports most long options (without extra quoting), one option per line.
420		579
421	=back	580	=back
422		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
423	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	620	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
424		621
425	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
426	files in order:	632	shell files in order:
427		633
428	/etc/staticperlrc	634	/etc/staticperlrc
429	~/.staticperlrc	635	~/.staticperlrc
430	$STATICPERL/rc	636	$STATICPERL/rc
431
432	They can be used to override shell variables, or define functions to be
433	called at specific phases.
434		637
435	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
436	generally should not be used.	639	generally should not be used.
437		640
438	=head3 CONFIGURATION VARIABLES	641	=head3 CONFIGURATION VARIABLES
…		…
500		703
501	More commonly, you would either activate 64 bit integer support	704	More commonly, you would either activate 64 bit integer support
502	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	705	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
503	reduce filesize further.	706	reduce filesize further.
504		707
505	=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>
506		709
507	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
508	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
509	contain subtle workarounds around various build issues, changing these	712	contain subtle workarounds around various build issues, changing these
510	usually requires understanding their default values - best look at the top	713	usually requires understanding their default values - best look at the top
…		…
742	After you have compiled and set up your buildroot target, you can copy	945	After you have compiled and set up your buildroot target, you can copy
743	F<staticperl> from the C<App::Staticperl> distribution or from your	946	F<staticperl> from the C<App::Staticperl> distribution or from your
744	perl f<bin> directory (if you installed it) into the F<output/target>	947	perl f<bin> directory (if you installed it) into the F<output/target>
745	filesystem, chroot inside and run it.	948	filesystem, chroot inside and run it.
746		949
		950	=head1 RECIPES / SPECIFIC MODULES
		951
		952	This section contains some common(?) recipes and information about
		953	problems with some common modules or perl constructs that require extra
		954	files to be included.
		955
		956	=head2 MODULES
		957
		958	=over 4
		959
		960	=item utf8
		961
		962	Some functionality in the utf8 module, such as swash handling (used
		963	for unicode character ranges in regexes) is implemented in the
		964	C<"utf8_heavy.pl"> library:
		965
		966	-M'"utf8_heavy.pl"'
		967
		968	Many Unicode properties in turn are defined in separate modules,
		969	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		970	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		971	are big (7MB uncompressed, although F<staticperl> contains special
		972	handling for those files), so including them on demand by your application
		973	only might pay off.
		974
		975	To simply include the whole unicode database, use:
		976
		977	--incglob '/unicore/*.pl'
		978
		979	=item AnyEvent
		980
		981	AnyEvent needs a backend implementation that it will load in a delayed
		982	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		983	for AnyEvent if it can't find anything else, and is usually a safe
		984	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		985	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		986	well.
		987
		988	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		989	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		990	C<"AnyEvent/Util/uts46data.pl">.
		991
		992	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		993	everything.
		994
		995	=item Carp
		996
		997	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		998	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		999
		1000	=item Config
		1001
		1002	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1003	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1004	both.
		1005
		1006	=item Term::ReadLine::Perl
		1007
		1008	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1009
		1010	=item URI
		1011
		1012	URI implements schemes as separate modules - the generic URL scheme is
		1013	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1014	you need to use any of these schemes, you should include these manually,
		1015	or use C<--usepacklist>.
		1016
		1017	=back
		1018
		1019	=head2 RECIPES
		1020
		1021	=over 4
		1022
		1023	=item Linking everything in
		1024
		1025	To link just about everything installed in the perl library into a new
		1026	perl, try this:
		1027
		1028	staticperl mkperl --strip ppi --incglob '*'
		1029
		1030	=item Getting rid of netdb function
		1031
		1032	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1033	and so on) that few applications use. You can avoid compiling them in by
		1034	putting the following fragment into a C<preconfigure> hook:
		1035
		1036	preconfigure() {
		1037	for sym in \
		1038	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1039	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1040	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1041	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1042	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1043	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1044	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1045	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1046	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1047	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1048	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1049	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1050	d_getspnam_r d_getsbyname
		1051	# d_gethbyname
		1052	do
		1053	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1054	done
		1055	}
		1056
		1057	This mostly gains space when linking staticaly, as the functions will
		1058	likely not be linked in. The gain for dynamically-linked binaries is
		1059	smaller.
		1060
		1061	Also, this leaves C<gethostbyname> in - not only is it actually used
		1062	often, the L<Socket> module also exposes it, so leaving it out usually
		1063	gains little. Why Socket exposes a C function that is in the core already
		1064	is anybody's guess.
		1065
		1066	=back
		1067
747	=head1 AUTHOR	1068	=head1 AUTHOR
748		1069
749	Marc Lehmann <schmorp@schmorp.de>	1070	Marc Lehmann <schmorp@schmorp.de>
750	http://software.schmorp.de/pkg/staticperl.html	1071	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.12 by root, Tue Dec 7 13:23:07 2010 UTC vs. Revision 1.22 by root, Mon Dec 13 17:25:17 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.12 by root, Tue Dec 7 13:23:07 2010 UTC vs.
Revision 1.22 by root, Mon Dec 13 17:25:17 2010 UTC