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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.11 by root, Tue Dec 7 10:40:39 2010 UTC vs.
Revision 1.25 by root, Tue Dec 21 12:59:29 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
…		…
128		147
129	The command	148	The command
130		149
131	staticperl install	150	staticperl install
132		151
133	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
134	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
135	perl interpreter if required.	154	perl interpreter if required.
136		155
137	Most of the following commands simply run one or more steps of this	156	Most of the following F<staticperl> subcommands simply run one or more
138	sequence.	157	steps of this sequence.
		158
		159	If it fails, then most commonly because the compiler options I selected
		160	are not supported by your compiler - either edit the F<staticperl> script
		161	yourself or create F<~/.staticperl> shell script where your set working
		162	C<PERL_CCFLAGS> etc. variables.
139		163
140	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
141	distclean> first.	165	distclean> first.
142		166
143	=over 4	167	=over 4
		168
		169	=item F<staticperl version>
		170
		171	Prints some info about the version of the F<staticperl> script you are using.
144		172
145	=item F<staticperl fetch>	173	=item F<staticperl fetch>
146		174
147	Runs only the download and unpack phase, unless this has already happened.	175	Runs only the download and unpack phase, unless this has already happened.
148		176
…		…
184	command by specifying all the directories with modules in them that you	212	command by specifying all the directories with modules in them that you
185	want to have built.	213	want to have built.
186		214
187	=item F<staticperl clean>	215	=item F<staticperl clean>
188		216
189	Runs F<make distclean> in the perl source directory (and potentially	217	Deletes the perl source directory (and potentially cleans up other
190	cleans up other intermediate files). This can be used to clean up	218	intermediate files). This can be used to clean up files only needed for
191	intermediate files without removing the installed perl interpreter.	219	building perl, without removing the installed perl interpreter.
		220
		221	At the moment, it doesn't delete downloaded tarballs.
		222
		223	The exact semantics of this command will probably change.
192		224
193	=item F<staticperl distclean>	225	=item F<staticperl distclean>
194		226
195	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
196	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
236	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	268	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
237	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	269	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
238	to include that module. I found out about these dependencies by carefully	270	to include that module. I found out about these dependencies by carefully
239	watching any error messages about missing modules...	271	watching any error messages about missing modules...
240		272
		273	Instead of building a new perl binary, you can also build a standalone
		274	application:
		275
		276	# build the app
		277	staticperl mkapp app --boot eg/httpd \
		278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		279
		280	# run it
		281	./app
		282
		283	Here are the three phase 2 commands:
		284
		285	=over 4
		286
		287	=item F<staticperl mkbundle> args...
		288
		289	The "default" bundle command - it interprets the given bundle options and
		290	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		291	files, useful for embedding.
		292
		293	=item F<staticperl mkperl> args...
		294
		295	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		296	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		297	links a new perl interpreter that embeds the created bundle, then deletes
		298	all intermediate files.
		299
		300	=item F<staticperl mkapp> filename args...
		301
		302	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		303	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		304	and links a new standalone application that simply initialises the perl
		305	interpreter.
		306
		307	The difference to F<staticperl mkperl> is that the standalone application
		308	does not act like a perl interpreter would - in fact, by default it would
		309	just do nothing and exit immediately, so you should specify some code to
		310	be executed via the F<--boot> option.
		311
		312	=back
		313
241	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
242		315
243	All options can be given as arguments on the command line (typically	316	All options can be given as arguments on the command line (typically
244	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	317	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
245	specifying a lot of modules can make the command line very cumbersome,	318	specifying a lot of modules can make the command line very cumbersome, you
246	you can put all long options into a "bundle specification file" (with or	319	can put all long options into a "bundle specification file" (one option
247	without C<--> prefix) and specify this bundle file instead.	320	per line, with or without C<--> prefix) and specify this bundle file
		321	instead.
248		322
249	For example, the command given earlier could also look like this:	323	For example, the command given earlier could also look like this:
250		324
251	staticperl mkperl httpd.bundle	325	staticperl mkperl httpd.bundle
252		326
…		…
257	use AnyEvent::HTTPD	331	use AnyEvent::HTTPD
258	use URI::http	332	use URI::http
259	add eg/httpd httpd.pm	333	add eg/httpd httpd.pm
260		334
261	All options that specify modules or files to be added are processed in the	335	All options that specify modules or files to be added are processed in the
262	order given on the command line (that affects the C<--use> and C<--eval>	336	order given on the command line.
263	options at the moment).	337
		338	=head3 PACKAGE SELECTION WORKFLOW
		339
		340	F<staticperl mkbundle> has a number of options to control package
		341	selection. This section describes how they interact with each other. Also,
		342	since I am still a newbie w.r.t. these issues, maybe future versions of
		343	F<staticperl> will change this, so watch out :)
		344
		345	The idiom "in order" means "in order that they are specified on the
		346	commandline". If you use a bundle specification file, then the options
		347	will be processed as if they were given in place of the bundle file name.
		348
		349	=over 4
		350
		351	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
		352	C<--incglob> options, in order.
		353
		354	In addition, C<--use> and C<--eval> dependencies will be added when the
		355	options are processed.
		356
		357	=item 2. apply all C<--include> and C<--exclude> options, in order.
		358
		359	All this step does is potentially reduce the number of files already
		360	selected or found in phase 1.
		361
		362	=item 3. find all modules (== F<.pm> files), gather their static archives
		363	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
		364	extra libraries they need for linking (F<extralibs.ld>) and optionally
		365	evaluate any F<.packlist> files.
		366
		367	This step is required to link against XS extensions and also adds files
		368	required for L<AutoLoader> to do it's job.
		369
		370	=back
		371
		372	After this, all the files selected for bundling will be read and processed
		373	(stripped), the bundle files will be written, and optionally a new F<perl>
		374	or application binary will be linked.
264		375
265	=head3 MKBUNDLE OPTIONS	376	=head3 MKBUNDLE OPTIONS
266		377
267	=over 4	378	=over 4
268		379
…		…
281		392
282	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	393	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
283	pod documentation, which is very fast and reduces file size a lot.	394	pod documentation, which is very fast and reduces file size a lot.
284		395
285	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	396	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
286	saves a lot more than just L<Pod::Strip>, and is generally safer, but	397	saves a lot more than just L<Pod::Strip>, and is generally safer,
287	is also a lot slower, so is best used for production builds. Note that	398	but is also a lot slower (some files take almost a minute to strip -
288	this method doesn't optimise for raw file size, but for best compression	399	F<staticperl> maintains a cache of stripped files to speed up subsequent
289	(that means that the uncompressed file size is a bit larger, but the files	400	runs for this reason). Note that this method doesn't optimise for raw file
290	compress better, e.g. with F<upx>).	401	size, but for best compression (that means that the uncompressed file size
		402	is a bit larger, but the files compress better, e.g. with F<upx>).
291		403
292	Last not least, if you need accurate line numbers in error messages,	404	Last not least, if you need accurate line numbers in error messages,
293	or in the unlikely case where C<pod> is too slow, or some module gets	405	or in the unlikely case where C<pod> is too slow, or some module gets
294	mistreated, you can specify C<none> to not mangle included perl sources in	406	mistreated, you can specify C<none> to not mangle included perl sources in
295	any way.	407	any way.
…		…
303	This switch is automatically used when F<staticperl> is invoked with the	415	This switch is automatically used when F<staticperl> is invoked with the
304	C<mkperl> command (instead of C<mkbundle>):	416	C<mkperl> command (instead of C<mkbundle>):
305		417
306	# build a new ./perl with only common::sense in it - very small :)	418	# build a new ./perl with only common::sense in it - very small :)
307	staticperl mkperl -Mcommon::sense	419	staticperl mkperl -Mcommon::sense
		420
		421	=item --app name
		422
		423	After writing out the bundle files, try to link a new standalone
		424	program. It will be called C<name>, and the bundle files get removed after
		425	linking it.
		426
		427	The difference to the (mutually exclusive) C<--perl> option is that the
		428	binary created by this option will not try to act as a perl interpreter -
		429	instead it will simply initialise the perl interpreter, clean it up and
		430	exit.
		431
		432	This switch is automatically used when F<staticperl> is invoked with the
		433	C<mkapp> command (instead of C<mkbundle>):
		434
		435	To let it do something useful you I<must> add some boot code, e.g. with
		436	the C<--boot> option.
		437
		438	Example: create a standalone perl binary that will execute F<appfile> when
		439	it is started.
		440
		441	staticperl mkbundle --app myexe --boot appfile
308		442
309	=item --use module \| -Mmodule	443	=item --use module \| -Mmodule
310		444
311	Include the named module and all direct dependencies. This is done by	445	Include the named module and all direct dependencies. This is done by
312	C<require>'ing the module in a subprocess and tracing which other modules	446	C<require>'ing the module in a subprocess and tracing which other modules
…		…
367	(using a C<require>) before anything else when the new perl is	501	(using a C<require>) before anything else when the new perl is
368	initialised. This can be used to modify C<@INC> or anything else before	502	initialised. This can be used to modify C<@INC> or anything else before
369	the perl interpreter executes scripts given on the command line (or via	503	the perl interpreter executes scripts given on the command line (or via
370	C<-e>). This works even in an embedded interpreter.	504	C<-e>). This works even in an embedded interpreter.
371		505
372	=item --add "file" \| --add "file alias"	506	=item --usepacklist
		507
		508	Read F<.packlist> files for each distribution that happens to match a
		509	module name you specified. Sounds weird, and it is, so expect semantics to
		510	change somehow in the future.
		511
		512	The idea is that most CPAN distributions have a F<.pm> file that matches
		513	the name of the distribution (which is rather reasonable after all).
		514
		515	If this switch is enabled, then if any of the F<.pm> files that have been
		516	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		517	and F<.ix> files installed by this distribution are also included.
		518
		519	For example, using this switch, when the L<URI> module is specified, then
		520	all L<URI> submodules that have been installed via the CPAN distribution
		521	are included as well, so you don't have to manually specify them.
		522
		523	=item --incglob pattern
		524
		525	This goes through all library directories and tries to match any F<.pm>
		526	and F<.pl> files against the extended glob pattern (see below). If a file
		527	matches, it is added. This switch will automatically detect L<AutoLoader>
		528	files and the required link libraries for XS modules, but it will I<not>
		529	scan the file for dependencies (at the moment).
		530
		531	This is mainly useful to include "everything":
		532
		533	--incglob '*'
		534
		535	Or to include perl libraries, or trees of those, such as the unicode
		536	database files needed by many other modules:
		537
		538	--incglob '/unicore/**.pl'
		539
		540	=item --add file \| --add "file alias"
373		541
374	Adds the given (perl) file into the bundle (and optionally call it	542	Adds the given (perl) file into the bundle (and optionally call it
375	"alias"). This is useful to include any custom files into the bundle.	543	"alias"). This is useful to include any custom files into the bundle.
376		544
377	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	545	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
383	# specification file	551	# specification file
384	add file1 myfiles/file1	552	add file1 myfiles/file1
385	add file2 myfiles/file2	553	add file2 myfiles/file2
386	add file3 myfiles/file3	554	add file3 myfiles/file3
387		555
388	=item --binadd "file" \| --add "file alias"	556	=item --binadd file \| --add "file alias"
389		557
390	Just like C<--add>, except that it treats the file as binary and adds it	558	Just like C<--add>, except that it treats the file as binary and adds it
391	without any processing.	559	without any processing.
392		560
393	You should probably add a C</> prefix to avoid clashing with embedded	561	You should probably add a C</> prefix to avoid clashing with embedded
394	perl files (whose paths do not start with C</>), and/or use a special	562	perl files (whose paths do not start with C</>), and/or use a special
395	directory, such as C</res/name>.	563	directory, such as C</res/name>.
396		564
397	You can later get a copy of these files by calling C<staticperl::find	565	You can later get a copy of these files by calling C<staticperl::find
398	"alias">.	566	"alias">.
		567
		568	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		569
		570	These two options define an include/exclude filter that is used after all
		571	files selected by the other options have been found. Each include/exclude
		572	is applied to all files found so far - an include makes sure that the
		573	given files will be part of the resulting file set, an exclude will
		574	exclude files. The patterns are "extended glob patterns" (see below).
		575
		576	For example, to include everything, except C<Devel> modules, but still
		577	include F<Devel::PPPort>, you could use this:
		578
		579	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
399		580
400	=item --static	581	=item --static
401		582
402	When C<--perl> is also given, link statically instead of dynamically. The	583	When C<--perl> is also given, link statically instead of dynamically. The
403	default is to link the new perl interpreter fully dynamic (that means all	584	default is to link the new perl interpreter fully dynamic (that means all
…		…
408	systems based on GNU libc don't really support it in a usable fashion	589	systems based on GNU libc don't really support it in a usable fashion
409	either. Try uClibc if you want to create fully statically linked	590	either. Try uClibc if you want to create fully statically linked
410	executables, or try the C<--staticlibs> option to link only some libraries	591	executables, or try the C<--staticlibs> option to link only some libraries
411	statically.	592	statically.
412		593
		594	=item --staticlib libname
		595
		596	When not linking fully statically, this option allows you to link specific
		597	libraries statically. What it does is simply replace all occurances of
		598	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		599	option.
		600
		601	This will have no effect unless the library is actually linked against,
		602	specifically, C<--staticlib> will not link against the named library
		603	unless it would be linked against anyway.
		604
		605	Example: link libcrypt statically into the binary.
		606
		607	staticperl mkperl -MIO::AIO --staticlib crypt
		608
		609	# ldopts might nwo contain:
		610	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		611
413	=item any other argument	612	=item any other argument
414		613
415	Any other argument is interpreted as a bundle specification file, which	614	Any other argument is interpreted as a bundle specification file, which
416	supports most long options (without extra quoting), one option per line.	615	supports most long options (without extra quoting), one option per line.
417		616
418	=back	617	=back
419		618
		619	=head3 EXTENDED GLOB PATTERNS
		620
		621	Some options of F<staticperl mkbundle> expect an I<extended glob
		622	pattern>. This is neither a normal shell glob nor a regex, but something
		623	in between. The idea has been copied from rsync, and there are the current
		624	matching rules:
		625
		626	=over 4
		627
		628	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		629
		630	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		631	nothing inside, and neither any other file or directory called F<unicore>
		632	anywhere else in the hierarchy.
		633
		634	=item Patterns not starting with F</> will be anchored at the end of the path.
		635
		636	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		637	hierarchy, but not any directories of the same name.
		638
		639	=item A F<*> matches any single component.
		640
		641	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		642	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		643	will not match slashes.
		644
		645	=item A F<**> matches anything.
		646
		647	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		648	no matter how deeply nested they are inside subdirectories.
		649
		650	=item A F<?> matches a single character within a component.
		651
		652	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		653	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		654
		655	=back
		656
420	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	657	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
421		658
422	During (each) startup, F<staticperl> tries to source the following shell	659	During (each) startup, F<staticperl> tries to source some shell files to
		660	allow you to fine-tune/override configuration settings.
		661
		662	In them you can override shell variables, or define shell functions
		663	("hooks") to be called at specific phases during installation. For
		664	example, you could define a C<postinstall> hook to install additional
		665	modules from CPAN each time you start from scratch.
		666
		667	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		668	to source the file named with it only. Otherwise, it tries the following
423	files in order:	669	shell files in order:
424		670
425	/etc/staticperlrc	671	/etc/staticperlrc
426	~/.staticperlrc	672	~/.staticperlrc
427	$STATICPERL/rc	673	$STATICPERL/rc
428
429	They can be used to override shell variables, or define functions to be
430	called at specific phases.
431		674
432	Note that the last file is erased during F<staticperl distclean>, so	675	Note that the last file is erased during F<staticperl distclean>, so
433	generally should not be used.	676	generally should not be used.
434		677
435	=head3 CONFIGURATION VARIABLES	678	=head3 CONFIGURATION VARIABLES
…		…
497		740
498	More commonly, you would either activate 64 bit integer support	741	More commonly, you would either activate 64 bit integer support
499	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	742	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
500	reduce filesize further.	743	reduce filesize further.
501		744
502	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	745	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
503		746
504	These flags are passed to perl's F<Configure> script, and are generally	747	These flags are passed to perl's F<Configure> script, and are generally
505	optimised for small size (at the cost of performance). Since they also	748	optimised for small size (at the cost of performance). Since they also
506	contain subtle workarounds around various build issues, changing these	749	contain subtle workarounds around various build issues, changing these
507	usually requires understanding their default values - best look at the top	750	usually requires understanding their default values - best look at
508	of the F<staticperl> script for more info on these.	751	the top of the F<staticperl> script for more info on these, and use a
		752	F<~/.staticperlrc> to override them.
		753
		754	Most of the variables override (or modify) the corresponding F<Configure>
		755	variable, except C<PERL_CCFLAGS>, which gets appended.
509		756
510	=back	757	=back
511		758
512	=head4 Variables you probably I<do not want> to override	759	=head4 Variables you probably I<do not want> to override
513		760
514	=over 4	761	=over 4
		762
		763	=item C<MAKE>
		764
		765	The make command to use - default is C<make>.
515		766
516	=item C<MKBUNDLE>	767	=item C<MKBUNDLE>
517		768
518	Where F<staticperl> writes the C<mkbundle> command to	769	Where F<staticperl> writes the C<mkbundle> command to
519	(default: F<$STATICPERL/mkbundle>).	770	(default: F<$STATICPERL/mkbundle>).
…		…
542	instcpan Anyevent::AIO AnyEvent::HTTPD	793	instcpan Anyevent::AIO AnyEvent::HTTPD
543	}	794	}
544		795
545	=over 4	796	=over 4
546		797
		798	=item preconfigure
		799
		800	Called just before running F<./Configur> in the perl source
		801	directory. Current working directory is the perl source directory.
		802
		803	This can be used to set any C<PERL_xxx> variables, which might be costly
		804	to compute.
		805
547	=item postconfigure	806	=item postconfigure
548		807
549	Called after configuring, but before building perl. Current working	808	Called after configuring, but before building perl. Current working
550	directory is the perl source directory.	809	directory is the perl source directory.
551		810
552	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or	811	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
553	do any other modifications.	812	or do any other modifications.
554		813
555	=item postbuild	814	=item postbuild
556		815
557	Called after building, but before installing perl. Current working	816	Called after building, but before installing perl. Current working
558	directory is the perl source directory.	817	directory is the perl source directory.
…		…
731	After you have compiled and set up your buildroot target, you can copy	990	After you have compiled and set up your buildroot target, you can copy
732	F<staticperl> from the C<App::Staticperl> distribution or from your	991	F<staticperl> from the C<App::Staticperl> distribution or from your
733	perl f<bin> directory (if you installed it) into the F<output/target>	992	perl f<bin> directory (if you installed it) into the F<output/target>
734	filesystem, chroot inside and run it.	993	filesystem, chroot inside and run it.
735		994
		995	=head1 RECIPES / SPECIFIC MODULES
		996
		997	This section contains some common(?) recipes and information about
		998	problems with some common modules or perl constructs that require extra
		999	files to be included.
		1000
		1001	=head2 MODULES
		1002
		1003	=over 4
		1004
		1005	=item utf8
		1006
		1007	Some functionality in the utf8 module, such as swash handling (used
		1008	for unicode character ranges in regexes) is implemented in the
		1009	C<"utf8_heavy.pl"> library:
		1010
		1011	-M'"utf8_heavy.pl"'
		1012
		1013	Many Unicode properties in turn are defined in separate modules,
		1014	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1015	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1016	are big (7MB uncompressed, although F<staticperl> contains special
		1017	handling for those files), so including them on demand by your application
		1018	only might pay off.
		1019
		1020	To simply include the whole unicode database, use:
		1021
		1022	--incglob '/unicore/*.pl'
		1023
		1024	=item AnyEvent
		1025
		1026	AnyEvent needs a backend implementation that it will load in a delayed
		1027	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1028	for AnyEvent if it can't find anything else, and is usually a safe
		1029	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1030	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1031	well.
		1032
		1033	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1034	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1035	C<"AnyEvent/Util/uts46data.pl">.
		1036
		1037	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		1038	everything.
		1039
		1040	=item Carp
		1041
		1042	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1043	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1044
		1045	=item Config
		1046
		1047	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1048	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1049	both.
		1050
		1051	=item Term::ReadLine::Perl
		1052
		1053	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1054
		1055	=item URI
		1056
		1057	URI implements schemes as separate modules - the generic URL scheme is
		1058	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1059	you need to use any of these schemes, you should include these manually,
		1060	or use C<--usepacklist>.
		1061
		1062	=back
		1063
		1064	=head2 RECIPES
		1065
		1066	=over 4
		1067
		1068	=item Linking everything in
		1069
		1070	To link just about everything installed in the perl library into a new
		1071	perl, try this:
		1072
		1073	staticperl mkperl --strip ppi --incglob '*'
		1074
		1075	=item Getting rid of netdb function
		1076
		1077	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1078	and so on) that few applications use. You can avoid compiling them in by
		1079	putting the following fragment into a C<preconfigure> hook:
		1080
		1081	preconfigure() {
		1082	for sym in \
		1083	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1084	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1085	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1086	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1087	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1088	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1089	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1090	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1091	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1092	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1093	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1094	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1095	d_getspnam_r d_getsbyname
		1096	# d_gethbyname
		1097	do
		1098	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1099	done
		1100	}
		1101
		1102	This mostly gains space when linking staticaly, as the functions will
		1103	likely not be linked in. The gain for dynamically-linked binaries is
		1104	smaller.
		1105
		1106	Also, this leaves C<gethostbyname> in - not only is it actually used
		1107	often, the L<Socket> module also exposes it, so leaving it out usually
		1108	gains little. Why Socket exposes a C function that is in the core already
		1109	is anybody's guess.
		1110
		1111	=back
		1112
736	=head1 AUTHOR	1113	=head1 AUTHOR
737		1114
738	Marc Lehmann <schmorp@schmorp.de>	1115	Marc Lehmann <schmorp@schmorp.de>
739	http://software.schmorp.de/pkg/staticperl.html	1116	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.11 by root, Tue Dec 7 10:40:39 2010 UTC vs. Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.11 by root, Tue Dec 7 10:40:39 2010 UTC vs.
Revision 1.25 by root, Tue Dec 21 12:59:29 2010 UTC