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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.29 by root, Wed Dec 22 01:23:37 2010 UTC

…		…
14	staticperl cpan # invoke CPAN shell	14	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	15	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	16	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	17	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	18	staticperl mkperl <bundle-args...> # see documentation
		19	staticperl mkapp appname <bundle-args...> # see documentation
19		20
20	Typical Examples:	21	Typical Examples:
21		22
22	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
23	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
24	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V
25	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26	# build a perl with the above modules linked in	27	# build a perl with the above modules linked in
		28	staticperl mkapp myapp --boot mainprog mymodules
		29	# build a binary "myapp" from mainprog and mymodules
27		30
28	=head1 DESCRIPTION	31	=head1 DESCRIPTION
29		32
30	This script helps you creating single-file perl interpreters, or embedding	33	This script helps you to create single-file perl interpreters
31	a perl interpreter in your applications. Single-file means that it is	34	or applications, or embedding a perl interpreter in your
32	fully self-contained - no separate shared objects, no autoload fragments,	35	applications. Single-file means that it is fully self-contained - no
33	no .pm or .pl files are needed. And when linking statically, you can	36	separate shared objects, no autoload fragments, no .pm or .pl files are
34	create (or embed) a single file that contains perl interpreter, libc, all	37	needed. And when linking statically, you can create (or embed) a single
35	the modules you need and all the libraries you need.	38	file that contains perl interpreter, libc, all the modules you need, all
		39	the libraries you need and of course your actual program.
36		40
37	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,	42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39	Coro and so on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
		44
		45	To see how this turns out, you can try out smallperl and bigperl, two
		46	pre-built static and compressed perl binaries with many and even more
		47	modules: just follow the links at L<http://staticperl.schmorp.de/>.
40		48
41	The created files do not need write access to the file system (like PAR	49	The created files do not need write access to the file system (like PAR
42	does). In fact, since this script is in many ways similar to PAR::Packer,	50	does). In fact, since this script is in many ways similar to PAR::Packer,
43	here are the differences:	51	here are the differences:
44		52
…		…
63	=item * The generated executables don't need a writable filesystem.	71	=item * The generated executables don't need a writable filesystem.
64		72
65	F<staticperl> loads all required files directly from memory. There is no	73	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	74	need to unpack files into a temporary directory.
67		75
68	=item * More control over included files.	76	=item * More control over included files, more burden.
69		77
70	PAR tries to be maintenance and hassle-free - it tries to include more	78	PAR tries to be maintenance and hassle-free - it tries to include more
71	files than necessary to make sure everything works out of the box. The	79	files than necessary to make sure everything works out of the box. It
72	extra files (such as the unicode database) can take substantial amounts of	80	mostly succeeds at this, but he extra files (such as the unicode database)
73	memory and file size.	81	can take substantial amounts of memory and file size.
74		82
75	With F<staticperl>, the burden is mostly with the developer - only direct	83	With F<staticperl>, the burden is mostly with the developer - only direct
76	compile-time dependencies and L<AutoLoader> are handled automatically.	84	compile-time dependencies and L<AutoLoader> are handled automatically.
77	This means the modules to include often need to be tweaked manually.	85	This means the modules to include often need to be tweaked manually.
		86
		87	All this does not preclude more permissive modes to be implemented in
		88	the future, but right now, you have to resolve state hidden dependencies
		89	manually.
78		90
79	=item * PAR works out of the box, F<staticperl> does not.	91	=item * PAR works out of the box, F<staticperl> does not.
80		92
81	Maintaining your own custom perl build can be a pain in the ass, and while	93	Maintaining your own custom perl build can be a pain in the ass, and while
82	F<staticperl> tries to make this easy, it still requires a custom perl	94	F<staticperl> tries to make this easy, it still requires a custom perl
…		…
103	Afterwards, you create a list of files and modules you want to include,	115	Afterwards, you create a list of files and modules you want to include,
104	and then either build a new perl binary (that acts just like a normal perl	116	and then either build a new perl binary (that acts just like a normal perl
105	except everything is compiled in), or you create bundle files (basically C	117	except everything is compiled in), or you create bundle files (basically C
106	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
107		119
108	This step is very fast (a few seconds if PPI is not used for stripping,	120	This step is very fast (a few seconds if PPI is not used for stripping, or
109	more seconds otherwise, as PPI is very slow), and can be tweaked and	121	the stripped files are in the cache), and can be tweaked and repeated as
110	repeated as often as necessary.	122	often as necessary.
111		123
112	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
113		125
114	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
115	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
116	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
117	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
118	F<bin/staticperl>, without any installation.	130	tarball as F<bin/staticperl>, without any installation. The
		131	newest (possibly alpha) version can also be downloaded from
		132	L<http://staticperl.schmorp.de/staticperl>.
119		133
120	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
121	optionally followed by any parameters.	135	optionally followed by any parameters.
122		136
123	There are two command categories: the "phase 1" commands which deal with	137	There are two command categories: the "phase 1" commands which deal with
…		…
133		147
134	The command	148	The command
135		149
136	staticperl install	150	staticperl install
137		151
138	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
139	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
140	perl interpreter if required.	154	perl interpreter if required.
141		155
142	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
143	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.
144		163
145	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
146	distclean> first.	165	distclean> first.
147		166
148	=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.
149		172
150	=item F<staticperl fetch>	173	=item F<staticperl fetch>
151		174
152	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.
153		176
…		…
191		214
192	=item F<staticperl clean>	215	=item F<staticperl clean>
193		216
194	Deletes the perl source directory (and potentially cleans up other	217	Deletes the perl source directory (and potentially cleans up other
195	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
196	building perl, without removing the installed perl interpreter, or to	219	building perl, without removing the installed perl interpreter.
197	force a re-build from scratch.
198		220
199	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.
200		224
201	=item F<staticperl distclean>	225	=item F<staticperl distclean>
202		226
203	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
204	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
244	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	268	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
245	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	269	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
246	to include that module. I found out about these dependencies by carefully	270	to include that module. I found out about these dependencies by carefully
247	watching any error messages about missing modules...	271	watching any error messages about missing modules...
248		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
249	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
250		315
251	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
252	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
253	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
254	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"
255	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.
256		322
257	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:
258		325
259	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
260		327
261	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
262		329	everything after the option is an argument):
		330
263	use "Config_heavy.pl"	331	use "Config_heavy.pl"
264	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
265	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
266	use URI::http	334	use URI::http
267	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
268		336
269	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
270	order given on the command line (that affects the C<--use> and C<--eval>	338	order given on the command line.
271	options at the moment).
272		339
273	=head3 MKBUNDLE OPTIONS	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
274		341
275	=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.
276		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
277	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
278		358
279	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
280		360
281	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
282		362
283	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
284		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<require>'ing the module in a subprocess and tracing which other modules
		388	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 only C<require> the modules named
		426	by the C<--use> option, so do not expect the symbols from modules you
		427	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
285	=item --strip none\|pod\|ppi	619	=item C<--strip> C<none>\|C<pod>\|C<ppi>
286		620
287	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
288	sources included.	622	sources included.
289		623
290	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
291	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.
292		626
293	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
294	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,
295	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 -
296	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
297	(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
298	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>).
299		634
300	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,
301	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
302	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
303	any way.	638	any way.
304		639
305	=item --perl	640	=item C<--perl>
306		641
307	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
308	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
309	directory. The bundle files will be removed.	644	directory. The bundle files will be removed.
310		645
311	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
312	C<mkperl> command (instead of C<mkbundle>):	647	C<mkperl> command instead of C<mkbundle>.
313		648
314	# 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
315	staticperl mkperl -Mcommon::sense	653	staticperl mkperl -Mcommon::sense
316		654
317	=item --use module \| -Mmodule	655	=item C<--app> F<name>
318		656
319	Include the named module and all direct dependencies. This is done by	657	After writing out the bundle files, try to link a new standalone
320	C<require>'ing the module in a subprocess and tracing which other modules	658	program. It will be called C<name>, and the bundle files get removed after
321	and files it actually loads. If the module uses L<AutoLoader>, then all	659	linking it.
322	splitfiles will be included as well.
323		660
324	Example: include AnyEvent and AnyEvent::Impl::Perl.	661	This switch is automatically used when F<staticperl> is invoked with the
		662	C<mkapp> command instead of C<mkbundle>.
325		663
326	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	664	The difference to the (mutually exclusive) C<--perl> option is that the
		665	binary created by this option will not try to act as a perl interpreter -
		666	instead it will simply initialise the perl interpreter, clean it up and
		667	exit.
327		668
328	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	669	This means that, by default, it will do nothing but burna few CPU cycles
329	maybe other weirdly named files. To do that, you need to quote the name in	670	- for it to do something useful you I<must> add some boot code, e.g. with
330	single or double quotes. When given on the command line, you probably need	671	the C<--boot> option.
331	to quote once more to avoid your shell interpreting it. Common cases that
332	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
333		672
334	Example: include the required files for F<perl -V> to work in all its	673	Example: create a standalone perl binary called F<./myexe> that will
335	glory (F<Config.pm> is included automatically by this).	674	execute F<appfile> when it is started.
336		675
337	# bourne shell	676	staticperl mkbundle --app myexe --boot appfile
338	staticperl mkbundle --use '"Config_heavy.pl"'
339		677
340	# bundle specification file
341	use "Config_heavy.pl"
342
343	The C<-Mmodule> syntax is included as an alias that might be easier to
344	remember than C<use>. Or maybe it confuses people. Time will tell. Or
345	maybe not. Argh.
346
347	=item --eval "perl code" \| -e "perl code"
348
349	Sometimes it is easier (or necessary) to specify dependencies using perl
350	code, or maybe one of the modules you use need a special use statement. In
351	that case, you can use C<eval> to execute some perl snippet or set some
352	variables or whatever you need. All files C<require>'d or C<use>'d in the
353	script are included in the final bundle.
354
355	Keep in mind that F<mkbundle> will only C<require> the modules named
356	by the C<--use> option, so do not expect the symbols from modules you
357	C<--use>'d earlier on the command line to be available.
358
359	Example: force L<AnyEvent> to detect a backend and therefore include it
360	in the final bundle.
361
362	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
363
364	# or like this
365	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
366
367	Example: use a separate "bootstrap" script that C<use>'s lots of modules
368	and include this in the final bundle, to be executed automatically.
369
370	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
371
372	=item --boot filename
373
374	Include the given file in the bundle and arrange for it to be executed
375	(using a C<require>) before anything else when the new perl is
376	initialised. This can be used to modify C<@INC> or anything else before
377	the perl interpreter executes scripts given on the command line (or via
378	C<-e>). This works even in an embedded interpreter.
379
380	=item --add "file" \| --add "file alias"
381
382	Adds the given (perl) file into the bundle (and optionally call it
383	"alias"). This is useful to include any custom files into the bundle.
384
385	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
386
387	staticperl mkperl --add "httpd httpd.pm"
388
389	It is also a great way to add any custom modules:
390
391	# specification file
392	add file1 myfiles/file1
393	add file2 myfiles/file2
394	add file3 myfiles/file3
395
396	=item --binadd "file" \| --add "file alias"
397
398	Just like C<--add>, except that it treats the file as binary and adds it
399	without any processing.
400
401	You should probably add a C</> prefix to avoid clashing with embedded
402	perl files (whose paths do not start with C</>), and/or use a special
403	directory, such as C</res/name>.
404
405	You can later get a copy of these files by calling C<staticperl::find
406	"alias">.
407
408	=item --static	678	=item C<--static>
409		679
410	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
411	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
412	perl modules are linked statically, but all external libraries are still	686	modules are linked statically, but all external libraries are still
413	referenced dynamically).	687	referenced dynamically).
414		688
415	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
416	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
417	either. Try uClibc if you want to create fully statically linked	691	fashion either. Try uClibc if you want to create fully statically linked
418	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
419	statically.	693	statically.
420		694
421	=item any other argument	695	=item C<--staticlib> libname
422		696
423	Any other argument is interpreted as a bundle specification file, which	697	When not linking fully statically, this option allows you to link specific
424	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.
425		701
426	=back	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.
427		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</>.
		752
		753	=back
		754
428	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	755	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
429		756
430	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
431	files in order:	767	shell files in order:
432		768
433	/etc/staticperlrc	769	/etc/staticperlrc
434	~/.staticperlrc	770	~/.staticperlrc
435	$STATICPERL/rc	771	$STATICPERL/rc
436
437	They can be used to override shell variables, or define functions to be
438	called at specific phases.
439		772
440	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
441	generally should not be used.	774	generally should not be used.
442		775
443	=head3 CONFIGURATION VARIABLES	776	=head3 CONFIGURATION VARIABLES
…		…
505		838
506	More commonly, you would either activate 64 bit integer support	839	More commonly, you would either activate 64 bit integer support
507	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	840	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
508	reduce filesize further.	841	reduce filesize further.
509		842
510	=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>
511		844
512	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
513	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
514	contain subtle workarounds around various build issues, changing these	847	contain subtle workarounds around various build issues, changing these
515	usually requires understanding their default values - best look at the top	848	usually requires understanding their default values - best look at
516	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.
517		854
518	=back	855	=back
519		856
520	=head4 Variables you probably I<do not want> to override	857	=head4 Variables you probably I<do not want> to override
521		858
522	=over 4	859	=over 4
		860
		861	=item C<MAKE>
		862
		863	The make command to use - default is C<make>.
523		864
524	=item C<MKBUNDLE>	865	=item C<MKBUNDLE>
525		866
526	Where F<staticperl> writes the C<mkbundle> command to	867	Where F<staticperl> writes the C<mkbundle> command to
527	(default: F<$STATICPERL/mkbundle>).	868	(default: F<$STATICPERL/mkbundle>).
…		…
692		1033
693	Returns the list of all paths embedded in this binary.	1034	Returns the list of all paths embedded in this binary.
694		1035
695	=back	1036	=back
696		1037
697	=head1 FULLY STATIC BINARIES - BUILDROOT	1038	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
698		1039
699	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
700	buildroot (L<http://buildroot.uclibc.org/>).	1041	buildroot (L<http://buildroot.uclibc.org/>).
701		1042
702	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
…		…
747	After you have compiled and set up your buildroot target, you can copy	1088	After you have compiled and set up your buildroot target, you can copy
748	F<staticperl> from the C<App::Staticperl> distribution or from your	1089	F<staticperl> from the C<App::Staticperl> distribution or from your
749	perl f<bin> directory (if you installed it) into the F<output/target>	1090	perl f<bin> directory (if you installed it) into the F<output/target>
750	filesystem, chroot inside and run it.	1091	filesystem, chroot inside and run it.
751		1092
		1093	=head1 RECIPES / SPECIFIC MODULES
		1094
		1095	This section contains some common(?) recipes and information about
		1096	problems with some common modules or perl constructs that require extra
		1097	files to be included.
		1098
		1099	=head2 MODULES
		1100
		1101	=over 4
		1102
		1103	=item utf8
		1104
		1105	Some functionality in the utf8 module, such as swash handling (used
		1106	for unicode character ranges in regexes) is implemented in the
		1107	C<"utf8_heavy.pl"> library:
		1108
		1109	-M'"utf8_heavy.pl"'
		1110
		1111	Many Unicode properties in turn are defined in separate modules,
		1112	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		1113	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		1114	are big (7MB uncompressed, although F<staticperl> contains special
		1115	handling for those files), so including them on demand by your application
		1116	only might pay off.
		1117
		1118	To simply include the whole unicode database, use:
		1119
		1120	--incglob '/unicore/*.pl'
		1121
		1122	=item AnyEvent
		1123
		1124	AnyEvent needs a backend implementation that it will load in a delayed
		1125	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		1126	for AnyEvent if it can't find anything else, and is usually a safe
		1127	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		1128	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1129	well.
		1130
		1131	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1132	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1133	C<"AnyEvent/Util/uts46data.pl">.
		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
		1153	=item URI
		1154
		1155	URI implements schemes as separate modules - the generic URL scheme is
		1156	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1157	you need to use any of these schemes, you should include these manually,
		1158	or use C<--usepacklists>.
		1159
		1160	=back
		1161
		1162	=head2 RECIPES
		1163
		1164	=over 4
		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
		1181	=item Getting rid of netdb functions
		1182
		1183	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1184	and so on) that few applications use. You can avoid compiling them in by
		1185	putting the following fragment into a C<preconfigure> hook:
		1186
		1187	preconfigure() {
		1188	for sym in \
		1189	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1190	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1191	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1192	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1193	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1194	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1195	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1196	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1197	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1198	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1199	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1200	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1201	d_getspnam_r d_getsbyname
		1202	# d_gethbyname
		1203	do
		1204	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1205	done
		1206	}
		1207
		1208	This mostly gains space when linking staticaly, as the functions will
		1209	likely not be linked in. The gain for dynamically-linked binaries is
		1210	smaller.
		1211
		1212	Also, this leaves C<gethostbyname> in - not only is it actually used
		1213	often, the L<Socket> module also exposes it, so leaving it out usually
		1214	gains little. Why Socket exposes a C function that is in the core already
		1215	is anybody's guess.
		1216
		1217	=back
		1218
752	=head1 AUTHOR	1219	=head1 AUTHOR
753		1220
754	Marc Lehmann <schmorp@schmorp.de>	1221	Marc Lehmann <schmorp@schmorp.de>
755	http://software.schmorp.de/pkg/staticperl.html	1222	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs. Revision 1.29 by root, Wed Dec 22 01:23:37 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.13 by root, Tue Dec 7 19:55:56 2010 UTC vs.
Revision 1.29 by root, Wed Dec 22 01:23:37 2010 UTC