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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.17 by root, Thu Dec 9 08:55:52 2010 UTC vs.
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC

…		…
40		40
41	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
42	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,
43	Coro and so on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
44		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/>.
		48
45	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
46	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,
47	here are the differences:	51	here are the differences:
48		52
49	=over 4	53	=over 4
…		…
111	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,
112	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
113	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
114	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
115		119
116	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
117	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
118	repeated as often as necessary.	122	often as necessary.
119		123
120	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
121		125
122	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
123	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
124	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
125	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
126	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>.
127		133
128	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
129	optionally followed by any parameters.	135	optionally followed by any parameters.
130		136
131	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
…		…
141		147
142	The command	148	The command
143		149
144	staticperl install	150	staticperl install
145		151
146	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
147	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
148	perl interpreter if required.	154	perl interpreter if required.
149		155
150	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
151	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.
152		163
153	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
154	distclean> first.	165	distclean> first.
155		166
156	=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.
157		172
158	=item F<staticperl fetch>	173	=item F<staticperl fetch>
159		174
160	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.
161		176
…		…
199		214
200	=item F<staticperl clean>	215	=item F<staticperl clean>
201		216
202	Deletes the perl source directory (and potentially cleans up other	217	Deletes the perl source directory (and potentially cleans up other
203	intermediate files). This can be used to clean up files only needed for	218	intermediate files). This can be used to clean up files only needed for
204	building perl, without removing the installed perl interpreter, or to	219	building perl, without removing the installed perl interpreter.
205	force a re-build from scratch.
206		220
207	At the moment, it doesn't delete downloaded tarballs.	221	At the moment, it doesn't delete downloaded tarballs.
		222
		223	The exact semantics of this command will probably change.
208		224
209	=item F<staticperl distclean>	225	=item F<staticperl distclean>
210		226
211	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
212	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
262	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
263		279
264	# run it	280	# run it
265	./app	281	./app
266		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
267	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
268		315
269	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
270	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
271	specifying a lot of modules can make the command line very cumbersome,	318	specifying a lot of options can make the command line very long and
272	you can put all long options into a "bundle specification file" (with or	319	unwieldy, you can put all long options into a "bundle specification file"
273	without C<--> prefix) and specify this bundle file instead.	320	(one option per line, with or without C<--> prefix) and specify this
		321	bundle file instead.
274		322
275	For example, the command given earlier could also look like this:	323	For example, the command given earlier to link a new F<perl> could also
		324	look like this:
276		325
277	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
278		327
279	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
280		329	everything after the option is an argument):
		330
281	use "Config_heavy.pl"	331	use "Config_heavy.pl"
282	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
283	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
284	use URI::http	334	use URI::http
285	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
286		336
287	All options that specify modules or files to be added are processed in the	337	All options that specify modules or files to be added are processed in the
288	order given on the command line (that affects the C<--use> and C<--eval>	338	order given on the command line.
289	options at the moment).
290		339
291	=head3 MKBUNDLE OPTIONS	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
292		341
293	=over 4	342	F<staticperl mkbundle> works by first assembling a list of candidate
		343	files and modules to include, then filtering them by include/exclude
		344	patterns. The remaining modules (together with their direct dependencies,
		345	such as link libraries and L<AutoLoader> files) are then converted into
		346	bundle files suitable for embedding. F<staticperl mkbundle> can then
		347	optionally build a new perl interpreter or a standalone application.
294		348
		349	=over 4
		350
		351	=item Step 0: Generic argument processing.
		352
		353	The following options influence F<staticperl mkbundle> itself.
		354
		355	=over 4
		356
295	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
296		358
297	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
298		360
299	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
300		362
301	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
302		364
		365	=item any other argument
		366
		367	Any other argument is interpreted as a bundle specification file, which
		368	supports all options (without extra quoting), one option per line, in the
		369	format C<option> or C<option argument>. They will effectively be expanded
		370	and processed as if they were directly written on the command line, in
		371	place of the file name.
		372
		373	=back
		374
		375	=item Step 1: gather candidate files and modules
		376
		377	In this step, modules, perl libraries (F<.pl> files) and other files are
		378	selected for inclusion in the bundle. The relevant options are executed
		379	in order (this makes a difference mostly for C<--eval>, which can rely on
		380	earlier C<--use> options to have been executed).
		381
		382	=over 4
		383
		384	=item C<--use> F<module> \| C<-M>F<module>
		385
		386	Include the named module and trace direct dependencies. This is done by
		387	C<use>'ing the module from a fresh package in a subprocess and tracing
		388	which other modules and files it actually loads.
		389
		390	Example: include AnyEvent and AnyEvent::Impl::Perl.
		391
		392	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		393
		394	Sometimes you want to load old-style "perl libraries" (F<.pl> files),
		395	or maybe other weirdly named files. To do that, you need to quote
		396	the name in single or double quotes (this is because F<staticperl>
		397	I<literally> just adds the string after the C<require> - which acts
		398	different when confronted with quoted vs. unquoted strings). When given on
		399	the command line, you probably need to quote once more to avoid your shell
		400	interpreting it. Common cases that need this are F<Config_heavy.pl> and
		401	F<utf8_heavy.pl>.
		402
		403	Example: include the required files for F<perl -V> to work in all its
		404	glory (F<Config.pm> is included automatically by this).
		405
		406	# bourne shell
		407	staticperl mkbundle --use '"Config_heavy.pl"'
		408
		409	# bundle specification file
		410	use "Config_heavy.pl"
		411
		412	The C<-M>module syntax is included as a convenience that might be easier
		413	to remember than C<--use> - it's the same switch as perl itself uses
		414	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		415	not. Sigh.
		416
		417	=item C<--eval> "perl code" \| C<-e> "perl code"
		418
		419	Sometimes it is easier (or necessary) to specify dependencies using perl
		420	code, or maybe one of the modules you use need a special use statement. In
		421	that case, you can use C<--eval> to execute some perl snippet or set some
		422	variables or whatever you need. All files C<require>'d or C<use>'d while
		423	executing the snippet are included in the final bundle.
		424
		425	Keep in mind that F<mkbundle> will not import any symbols from the modules
		426	named by the C<--use> option, so do not expect the symbols from modules
		427	you C<--use>'d earlier on the command line to be available.
		428
		429	Example: force L<AnyEvent> to detect a backend and therefore include it
		430	in the final bundle.
		431
		432	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		433
		434	# or like this
		435	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		436
		437	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		438	and also include this in the final bundle, to be executed automatically
		439	when the interpreter is initialised.
		440
		441	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		442
		443	=item C<--boot> F<filename>
		444
		445	Include the given file in the bundle and arrange for it to be
		446	executed (using C<require>) before the main program when the new perl
		447	is initialised. This can be used to modify C<@INC> or do similar
		448	modifications before the perl interpreter executes scripts given on the
		449	command line (or via C<-e>). This works even in an embedded interpreter -
		450	the file will be executed during interpreter initialisation in that case.
		451
		452	=item C<--incglob> pattern
		453
		454	This goes through all standard library directories and tries to match any
		455	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		456	a file matches, it is added. The pattern is matched against the full path
		457	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		458
		459	This is very useful to include "everything":
		460
		461	--incglob '*'
		462
		463	It is also useful for including perl libraries, or trees of those, such as
		464	the unicode database files needed by some perl built-ins, the regex engine
		465	and other modules.
		466
		467	--incglob '/unicore/**.pl'
		468
		469	=item C<--add> F<file> \| C<--add> "F<file> alias"
		470
		471	Adds the given (perl) file into the bundle (and optionally call it
		472	"alias"). The F<file> is either an absolute path or a path relative to
		473	the current directory. If an alias is specified, then this is the name it
		474	will use for C<@INC> searches, otherwise the F<file> will be used as the
		475	internal name.
		476
		477	This switch is used to include extra files into the bundle.
		478
		479	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		480	when creating the bundle.
		481
		482	staticperl mkperl --add "httpd httpd.pm"
		483
		484	Example: add local files as extra modules in the bundle.
		485
		486	# specification file
		487	add file1 myfiles/file1.pm
		488	add file2 myfiles/file2.pm
		489	add file3 myfiles/file3.pl
		490
		491	# then later, in perl, use
		492	use myfiles::file1;
		493	require myfiles::file2;
		494	my $res = do "myfiles/file3.pl";
		495
		496	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		497
		498	Just like C<--add>, except that it treats the file as binary and adds it
		499	without any postprocessing (perl files might get stripped to reduce their
		500	size).
		501
		502	You should probably add a C</> prefix to avoid clashing with embedded perl
		503	files (whose paths do not start with C</>), and/or use a special directory
		504	prefix, such as C</res/name>.
		505
		506	You can later get a copy of these files by calling C<staticperl::find
		507	"alias">.
		508
		509	An alternative way to embed binary files is to convert them to perl and
		510	use C<do> to get the contents - this method is a bit cumbersome, but works
		511	both inside and outside of a staticperl bundle:
		512
		513	# a "binary" file, call it "bindata.pl"
		514	<<'SOME_MARKER'
		515	binary data NOT containing SOME_MARKER
		516	SOME_MARKER
		517
		518	# load the binary
		519	chomp (my $data = do "bindata.pl");
		520
		521	=back
		522
		523	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		524
		525	After all candidate files and modules are added, they are I<filtered>
		526	by a combination of C<--include> and C<--exclude> patterns (there is an
		527	implicit C<--include *> at the end, so if no filters are specified, all
		528	files are included).
		529
		530	All that this step does is potentially reduce the number of files that are
		531	to be included - no new files are added during this step.
		532
		533	=over 4
		534
		535	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		536
		537	These specify an include or exclude pattern to be applied to the candidate
		538	file list. An include makes sure that the given files will be part of the
		539	resulting file set, an exclude will exclude remaining files. The patterns
		540	are "extended glob patterns" (see below).
		541
		542	The patterns are applied "in order" - files included via earlier
		543	C<--include> specifications cannot be removed by any following
		544	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		545	cannot be added by any following C<--include>.
		546
		547	For example, to include everything except C<Devel> modules, but still
		548	include F<Devel::PPPort>, you could use this:
		549
		550	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		551
		552	=back
		553
		554	=item Step 3: add any extra or "hidden" dependencies.
		555
		556	F<staticperl> currently knows about three extra types of depdendencies
		557	that are added automatically. Only one (F<.packlist> files) is currently
		558	optional and can be influenced, the others are always included:
		559
		560	=over 4
		561
		562	=item C<--usepacklists>
		563
		564	Read F<.packlist> files for each distribution that happens to match a
		565	module name you specified. Sounds weird, and it is, so expect semantics to
		566	change somehow in the future.
		567
		568	The idea is that most CPAN distributions have a F<.pm> file that matches
		569	the name of the distribution (which is rather reasonable after all).
		570
		571	If this switch is enabled, then if any of the F<.pm> files that have been
		572	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		573	and F<.ix> files installed by this distribution are also included.
		574
		575	For example, using this switch, when the L<URI> module is specified, then
		576	all L<URI> submodules that have been installed via the CPAN distribution
		577	are included as well, so you don't have to manually specify them.
		578
		579	=item L<AutoLoader> splitfiles
		580
		581	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		582	are split into separate F<.al> files, and an index (F<.ix>) file contains
		583	the prototypes.
		584
		585	Both F<.ix> and F<.al> files will be detected automatically and added to
		586	the bundle.
		587
		588	=item link libraries (F<.a> files)
		589
		590	Modules using XS (or any other non-perl language extension compiled at
		591	installation time) will have a static archive (typically F<.a>). These
		592	will automatically be added to the linker options in F<bundle.ldopts>.
		593
		594	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		595	will warn about it - obviously this shouldn't happen unless you use
		596	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		597	use dynamic loading.
		598
		599	=item extra libraries (F<extralibs.ld>)
		600
		601	Some modules need linking against external libraries - these are found in
		602	F<extralibs.ld> and added to F<bundle.ldopts>.
		603
		604	=back
		605
		606	=item Step 4: write bundle files and optionally link a program
		607
		608	At this point, the select files will be read, processed (stripped) and
		609	finally the bundle files get written to disk, and F<staticperl mkbundle>
		610	is normally finished. Optionally, it can go a step further and either link
		611	a new F<perl> binary with all selected modules and files inside, or build
		612	a standalone application.
		613
		614	Both the contents of the bundle files and any extra linking is controlled
		615	by these options:
		616
		617	=over 4
		618
303	=item --strip none\|pod\|ppi	619	=item C<--strip> C<none>\|C<pod>\|C<ppi>
304		620
305	Specify the stripping method applied to reduce the file of the perl	621	Specify the stripping method applied to reduce the file of the perl
306	sources included.	622	sources included.
307		623
308	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	624	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
309	pod documentation, which is very fast and reduces file size a lot.	625	pod documentation, which is very fast and reduces file size a lot.
310		626
311	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	627	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
312	saves a lot more than just L<Pod::Strip>, and is generally safer, but	628	saves a lot more than just L<Pod::Strip>, and is generally safer,
313	is also a lot slower, so is best used for production builds. Note that	629	but is also a lot slower (some files take almost a minute to strip -
314	this method doesn't optimise for raw file size, but for best compression	630	F<staticperl> maintains a cache of stripped files to speed up subsequent
315	(that means that the uncompressed file size is a bit larger, but the files	631	runs for this reason). Note that this method doesn't optimise for raw file
316	compress better, e.g. with F<upx>).	632	size, but for best compression (that means that the uncompressed file size
		633	is a bit larger, but the files compress better, e.g. with F<upx>).
317		634
318	Last not least, if you need accurate line numbers in error messages,	635	Last not least, if you need accurate line numbers in error messages,
319	or in the unlikely case where C<pod> is too slow, or some module gets	636	or in the unlikely case where C<pod> is too slow, or some module gets
320	mistreated, you can specify C<none> to not mangle included perl sources in	637	mistreated, you can specify C<none> to not mangle included perl sources in
321	any way.	638	any way.
322		639
323	=item --perl	640	=item C<--perl>
324		641
325	After writing out the bundle files, try to link a new perl interpreter. It	642	After writing out the bundle files, try to link a new perl interpreter. It
326	will be called F<perl> and will be left in the current working	643	will be called F<perl> and will be left in the current working
327	directory. The bundle files will be removed.	644	directory. The bundle files will be removed.
328		645
329	This switch is automatically used when F<staticperl> is invoked with the	646	This switch is automatically used when F<staticperl> is invoked with the
330	C<mkperl> command (instead of C<mkbundle>):	647	C<mkperl> command instead of C<mkbundle>.
331		648
332	# build a new ./perl with only common::sense in it - very small :)	649	Example: build a new F<./perl> binary with only L<common::sense> inside -
		650	it will be even smaller than the standard perl interpreter as none of the
		651	modules of the base distribution (such as L<Fcntl>) will be included.
		652
333	staticperl mkperl -Mcommon::sense	653	staticperl mkperl -Mcommon::sense
334		654
335	=item --app name	655	=item C<--app> F<name>
336		656
337	After writing out the bundle files, try to link a new standalone	657	After writing out the bundle files, try to link a new standalone
338	program. It will be called C<name>, and the bundle files get removed after	658	program. It will be called C<name>, and the bundle files get removed after
339	linking it.	659	linking it.
		660
		661	This switch is automatically used when F<staticperl> is invoked with the
		662	C<mkapp> command instead of C<mkbundle>.
340		663
341	The difference to the (mutually exclusive) C<--perl> option is that the	664	The difference to the (mutually exclusive) C<--perl> option is that the
342	binary created by this option will not try to act as a perl interpreter -	665	binary created by this option will not try to act as a perl interpreter -
343	instead it will simply initialise the perl interpreter, clean it up and	666	instead it will simply initialise the perl interpreter, clean it up and
344	exit.	667	exit.
345		668
346	This switch is automatically used when F<staticperl> is invoked with the	669	This means that, by default, it will do nothing but burna few CPU cycles
347	C<mkapp> command (instead of C<mkbundle>):
348
349	To let it do something useful you I<must> add some boot code, e.g. with	670	- for it to do something useful you I<must> add some boot code, e.g. with
350	the C<--boot> option.	671	the C<--boot> option.
351		672
352	Example: create a standalone perl binary that will execute F<appfile> when	673	Example: create a standalone perl binary called F<./myexe> that will
353	it is started.	674	execute F<appfile> when it is started.
354		675
355	staticperl mkbundle --app myexe --boot appfile	676	staticperl mkbundle --app myexe --boot appfile
356		677
357	=item --use module \| -Mmodule
358
359	Include the named module and all direct dependencies. This is done by
360	C<require>'ing the module in a subprocess and tracing which other modules
361	and files it actually loads. If the module uses L<AutoLoader>, then all
362	splitfiles will be included as well.
363
364	Example: include AnyEvent and AnyEvent::Impl::Perl.
365
366	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
367
368	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
369	maybe other weirdly named files. To do that, you need to quote the name in
370	single or double quotes. When given on the command line, you probably need
371	to quote once more to avoid your shell interpreting it. Common cases that
372	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
373
374	Example: include the required files for F<perl -V> to work in all its
375	glory (F<Config.pm> is included automatically by this).
376
377	# bourne shell
378	staticperl mkbundle --use '"Config_heavy.pl"'
379
380	# bundle specification file
381	use "Config_heavy.pl"
382
383	The C<-Mmodule> syntax is included as an alias that might be easier to
384	remember than C<use>. Or maybe it confuses people. Time will tell. Or
385	maybe not. Argh.
386
387	=item --eval "perl code" \| -e "perl code"
388
389	Sometimes it is easier (or necessary) to specify dependencies using perl
390	code, or maybe one of the modules you use need a special use statement. In
391	that case, you can use C<eval> to execute some perl snippet or set some
392	variables or whatever you need. All files C<require>'d or C<use>'d in the
393	script are included in the final bundle.
394
395	Keep in mind that F<mkbundle> will only C<require> the modules named
396	by the C<--use> option, so do not expect the symbols from modules you
397	C<--use>'d earlier on the command line to be available.
398
399	Example: force L<AnyEvent> to detect a backend and therefore include it
400	in the final bundle.
401
402	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
403
404	# or like this
405	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
406
407	Example: use a separate "bootstrap" script that C<use>'s lots of modules
408	and include this in the final bundle, to be executed automatically.
409
410	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
411
412	=item --boot filename
413
414	Include the given file in the bundle and arrange for it to be executed
415	(using a C<require>) before anything else when the new perl is
416	initialised. This can be used to modify C<@INC> or anything else before
417	the perl interpreter executes scripts given on the command line (or via
418	C<-e>). This works even in an embedded interpreter.
419
420	=item --add "file" \| --add "file alias"
421
422	Adds the given (perl) file into the bundle (and optionally call it
423	"alias"). This is useful to include any custom files into the bundle.
424
425	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
426
427	staticperl mkperl --add "httpd httpd.pm"
428
429	It is also a great way to add any custom modules:
430
431	# specification file
432	add file1 myfiles/file1
433	add file2 myfiles/file2
434	add file3 myfiles/file3
435
436	=item --binadd "file" \| --add "file alias"
437
438	Just like C<--add>, except that it treats the file as binary and adds it
439	without any processing.
440
441	You should probably add a C</> prefix to avoid clashing with embedded
442	perl files (whose paths do not start with C</>), and/or use a special
443	directory, such as C</res/name>.
444
445	You can later get a copy of these files by calling C<staticperl::find
446	"alias">.
447
448	=item --static	678	=item C<--static>
449		679
450	When C<--perl> is also given, link statically instead of dynamically. The	680	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		681	supported by the OS) executable will be created. This is not immensely
		682	useful when just creating the bundle files, but is most useful when
		683	linking a binary with the C<--perl> or C<--app> options.
		684
451	default is to link the new perl interpreter fully dynamic (that means all	685	The default is to link the new binary dynamically (that means all perl
452	perl modules are linked statically, but all external libraries are still	686	modules are linked statically, but all external libraries are still
453	referenced dynamically).	687	referenced dynamically).
454		688
455	Keep in mind that Solaris doesn't support static linking at all, and	689	Keep in mind that Solaris doesn't support static linking at all, and
456	systems based on GNU libc don't really support it in a usable fashion	690	systems based on GNU libc don't really support it in a very usable
457	either. Try uClibc if you want to create fully statically linked	691	fashion either. Try uClibc if you want to create fully statically linked
458	executables, or try the C<--staticlibs> option to link only some libraries	692	executables, or try the C<--staticlib> option to link only some libraries
459	statically.	693	statically.
460		694
461	=item any other argument	695	=item C<--staticlib> libname
462		696
463	Any other argument is interpreted as a bundle specification file, which	697	When not linking fully statically, this option allows you to link specific
464	supports most long options (without extra quoting), one option per line.	698	libraries statically. What it does is simply replace all occurrences of
		699	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		700	option.
		701
		702	This will have no effect unless the library is actually linked against,
		703	specifically, C<--staticlib> will not link against the named library
		704	unless it would be linked against anyway.
		705
		706	Example: link libcrypt statically into the final binary.
		707
		708	staticperl mkperl -MIO::AIO --staticlib crypt
		709
		710	# ldopts might now contain:
		711	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		712
		713	=back
		714
		715	=back
		716
		717	=head3 EXTENDED GLOB PATTERNS
		718
		719	Some options of F<staticperl mkbundle> expect an I<extended glob
		720	pattern>. This is neither a normal shell glob nor a regex, but something
		721	in between. The idea has been copied from rsync, and there are the current
		722	matching rules:
		723
		724	=over 4
		725
		726	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		727
		728	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		729	nothing inside, and neither any other file or directory called F<unicore>
		730	anywhere else in the hierarchy.
		731
		732	=item Patterns not starting with F</> will be anchored at the end of the path.
		733
		734	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		735	hierarchy, but not any directories of the same name.
		736
		737	=item A F<*> matches anything within a single path component.
		738
		739	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		740	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		741	will not match slashes.
		742
		743	=item A F<**> matches anything.
		744
		745	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		746	no matter how deeply nested they are inside subdirectories.
		747
		748	=item A F<?> matches a single character within a component.
		749
		750	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		751	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
465		752
466	=back	753	=back
467		754
468	=head2 F<STATICPERL> CONFIGURATION AND HOOKS	755	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
469		756
470	During (each) startup, F<staticperl> tries to source the following shell	757	During (each) startup, F<staticperl> tries to source some shell files to
		758	allow you to fine-tune/override configuration settings.
		759
		760	In them you can override shell variables, or define shell functions
		761	("hooks") to be called at specific phases during installation. For
		762	example, you could define a C<postinstall> hook to install additional
		763	modules from CPAN each time you start from scratch.
		764
		765	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		766	to source the file named with it only. Otherwise, it tries the following
471	files in order:	767	shell files in order:
472		768
473	/etc/staticperlrc	769	/etc/staticperlrc
474	~/.staticperlrc	770	~/.staticperlrc
475	$STATICPERL/rc	771	$STATICPERL/rc
476
477	They can be used to override shell variables, or define functions to be
478	called at specific phases.
479		772
480	Note that the last file is erased during F<staticperl distclean>, so	773	Note that the last file is erased during F<staticperl distclean>, so
481	generally should not be used.	774	generally should not be used.
482		775
483	=head3 CONFIGURATION VARIABLES	776	=head3 CONFIGURATION VARIABLES
…		…
545		838
546	More commonly, you would either activate 64 bit integer support	839	More commonly, you would either activate 64 bit integer support
547	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	840	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
548	reduce filesize further.	841	reduce filesize further.
549		842
550	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	843	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
551		844
552	These flags are passed to perl's F<Configure> script, and are generally	845	These flags are passed to perl's F<Configure> script, and are generally
553	optimised for small size (at the cost of performance). Since they also	846	optimised for small size (at the cost of performance). Since they also
554	contain subtle workarounds around various build issues, changing these	847	contain subtle workarounds around various build issues, changing these
555	usually requires understanding their default values - best look at the top	848	usually requires understanding their default values - best look at
556	of the F<staticperl> script for more info on these.	849	the top of the F<staticperl> script for more info on these, and use a
		850	F<~/.staticperlrc> to override them.
		851
		852	Most of the variables override (or modify) the corresponding F<Configure>
		853	variable, except C<PERL_CCFLAGS>, which gets appended.
557		854
558	=back	855	=back
559		856
560	=head4 Variables you probably I<do not want> to override	857	=head4 Variables you probably I<do not want> to override
561		858
562	=over 4	859	=over 4
		860
		861	=item C<MAKE>
		862
		863	The make command to use - default is C<make>.
563		864
564	=item C<MKBUNDLE>	865	=item C<MKBUNDLE>
565		866
566	Where F<staticperl> writes the C<mkbundle> command to	867	Where F<staticperl> writes the C<mkbundle> command to
567	(default: F<$STATICPERL/mkbundle>).	868	(default: F<$STATICPERL/mkbundle>).
…		…
732		1033
733	Returns the list of all paths embedded in this binary.	1034	Returns the list of all paths embedded in this binary.
734		1035
735	=back	1036	=back
736		1037
737	=head1 FULLY STATIC BINARIES - BUILDROOT	1038	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
738		1039
739	To make truly static (Linux-) libraries, you might want to have a look at	1040	To make truly static (Linux-) libraries, you might want to have a look at
740	buildroot (L<http://buildroot.uclibc.org/>).	1041	buildroot (L<http://buildroot.uclibc.org/>).
741		1042
742	Buildroot is primarily meant to set up a cross-compile environment (which	1043	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
801		1102
802	=item utf8	1103	=item utf8
803		1104
804	Some functionality in the utf8 module, such as swash handling (used	1105	Some functionality in the utf8 module, such as swash handling (used
805	for unicode character ranges in regexes) is implemented in the	1106	for unicode character ranges in regexes) is implemented in the
806	C<"utf8_heavy.pl"> library.	1107	C<"utf8_heavy.pl"> library:
		1108
		1109	-M'"utf8_heavy.pl"'
807		1110
808	Many Unicode properties in turn are defined in separate modules,	1111	Many Unicode properties in turn are defined in separate modules,
809	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1112	such as C<"unicore/Heavy.pl"> and more specific data tables such as
810	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These	1113	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
811	tables are big (7MB uncompressed), so including them on demand by your	1114	are big (7MB uncompressed, although F<staticperl> contains special
		1115	handling for those files), so including them on demand by your application
812	applciation only might pay off.	1116	only might pay off.
813		1117
814	=item Carp	1118	To simply include the whole unicode database, use:
815		1119
816	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1120	--incglob '/unicore/**.pl'
817	perl 5.12.2 (maybe earlier), this dependency no longer exists.
818
819	=item Config
820
821	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
822	turn might need L<"Config_heavy.pl">. Including the latter gives you
823	both.
824		1121
825	=item AnyEvent	1122	=item AnyEvent
826		1123
827	AnyEvent needs a backend implementation that it will load in a delayed	1124	AnyEvent needs a backend implementation that it will load in a delayed
828	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1125	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
833		1130
834	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1131	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
835	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1132	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
836	C<"AnyEvent/Util/uts46data.pl">.	1133	C<"AnyEvent/Util/uts46data.pl">.
837		1134
		1135	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1136	everything.
		1137
		1138	=item Carp
		1139
		1140	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1141	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1142
		1143	=item Config
		1144
		1145	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1146	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1147	both.
		1148
		1149	=item Term::ReadLine::Perl
		1150
		1151	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
		1152
838	=item URI	1153	=item URI
839		1154
840	URI implements schemes as separate modules - the generic URL scheme is	1155	URI implements schemes as separate modules - the generic URL scheme is
841	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1156	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
842	you need to use any of these schemes, you should include these manually.	1157	you need to use any of these schemes, you should include these manually,
		1158	or use C<--usepacklists>.
843		1159
844	=back	1160	=back
845		1161
846	=head2 RECIPES	1162	=head2 RECIPES
847		1163
848	=over 4	1164	=over 4
849		1165
		1166	=item Just link everything in
		1167
		1168	To link just about everything installed in the perl library into a new
		1169	perl, try this (the first time this runs it will take a long time, as a
		1170	lot of files need to be parsed):
		1171
		1172	staticperl mkperl -v --strip ppi --incglob '*'
		1173
		1174	If you don't mind the extra megabytes, this can be a very effective way of
		1175	creating bundles without having to worry about forgetting any modules.
		1176
		1177	You get even more useful variants of this method by first selecting
		1178	everything, and then excluding stuff you are reasonable sure not to need -
		1179	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1180
850	=item Getting rid of netdb function	1181	=item Getting rid of netdb functions
851		1182
852	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1183	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
853	and so on) that few applications use. You can avoid compiling them in by	1184	and so on) that few applications use. You can avoid compiling them in by
854	putting the following fragment into a C<preconfigure> hook:	1185	putting the following fragment into a C<preconfigure> hook:
855		1186
…		…
872	do	1203	do
873	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1204	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
874	done	1205	done
875	}	1206	}
876		1207
877	This mostly gains space when linking staticaly, as the functions will	1208	This mostly gains space when linking statically, as the functions will
878	liekly not be linked in. The gain for dynamically-linked binaries is	1209	likely not be linked in. The gain for dynamically-linked binaries is
879	smaller.	1210	smaller.
880		1211
881	Also, this leaves C<gethostbyname> in - not only is it actually used	1212	Also, this leaves C<gethostbyname> in - not only is it actually used
882	often, the L<Socket> module also exposes it, so leaving it out usually	1213	often, the L<Socket> module also exposes it, so leaving it out usually
883	gains little. Why Socket exposes a C function that is in the core already	1214	gains little. Why Socket exposes a C function that is in the core already

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.17 by root, Thu Dec 9 08:55:52 2010 UTC vs. Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.17 by root, Thu Dec 9 08:55:52 2010 UTC vs.
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC