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