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

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

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.16 by root, Wed Dec 8 23:03:21 2010 UTC vs.
Revision 1.27 by root, Tue Dec 21 19:32:34 2010 UTC