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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs.
Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC

…		…
20		20
21	Typical Examples:	21	Typical Examples:
22		22
23	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
24	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27	# 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	28	staticperl mkapp myapp --boot mainprog mymodules
29	# build a binary "myapp" from mainprog and mymodules	29	# build a binary "myapp" from mainprog and mymodules
30		30
…		…
139	with creating binaries and bundle files.	139	with creating binaries and bundle files.
140		140
141	=head2 PHASE 1 COMMANDS: INSTALLING PERL	141	=head2 PHASE 1 COMMANDS: INSTALLING PERL
142		142
143	The most important command is F<install>, which does basically	143	The most important command is F<install>, which does basically
144	everything. The default is to download and install perl 5.12.2 and a few	144	everything. The default is to download and install perl 5.12.3 and a few
145	modules required by F<staticperl> itself, but all this can (and should) be	145	modules required by F<staticperl> itself, but all this can (and should) be
146	changed - see L<CONFIGURATION>, below.	146	changed - see L<CONFIGURATION>, below.
147		147
148	The command	148	The command
149		149
…		…
252		252
253	# first make sure we have perl and the required modules	253	# first make sure we have perl and the required modules
254	staticperl instcpan AnyEvent::HTTPD	254	staticperl instcpan AnyEvent::HTTPD
255		255
256	# now build the perl	256	# now build the perl
257	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	257	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258	-MAnyEvent::HTTPD -MURI::http \	258	-MAnyEvent::HTTPD -MURI::http \
259	--add 'eg/httpd httpd.pm'	259	--add 'eg/httpd httpd.pm'
260		260
261	# finally, invoke it	261	# finally, invoke it
262	./perl -Mhttpd	262	./perl -Mhttpd
…		…
313		313
314	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
315		315
316	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
317	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
318	specifying a lot of modules can make the command line very cumbersome, you	318	specifying a lot of options can make the command line very long and
319	can put all long options into a "bundle specification file" (one option	319	unwieldy, you can put all long options into a "bundle specification file"
320	per line, with or without C<--> prefix) and specify this bundle file	320	(one option per line, with or without C<--> prefix) and specify this
321	instead.	321	bundle file instead.
322		322
323	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:
324		325
325	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
326		327
327	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
328		329	everything after the option is an argument):
		330
329	use "Config_heavy.pl"	331	use "Config_heavy.pl"
330	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
331	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
332	use URI::http	334	use URI::http
333	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
334		336
335	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
336	order given on the command line.	338	order given on the command line.
337		339
338	=head3 BUNDLE CREATION WORKFLOW	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
339		341
340	F<staticperl mkbundle> works by first assembling a list of candidate	342	F<staticperl mkbundle> works by first assembling a list of candidate
341	files and modules to include, then filtering them by include/exclude	343	files and modules to include, then filtering them by include/exclude
342	patterns. The remaining modules (together with their direct depdendencies,	344	patterns. The remaining modules (together with their direct dependencies,
343	such as link libraries and AutoLoader files) are then converted into	345	such as link libraries and L<AutoLoader> files) are then converted into
344	bundle files suitable for embedding. Afterwards, F<staticperl mkbundle>	346	bundle files suitable for embedding. F<staticperl mkbundle> can then
345	can optionally build a new perl interpreter or a standalone application.	347	optionally build a new perl interpreter or a standalone application.
346		348
347	=over 4	349	=over 4
348		350
349	=item Step 0: Generic argument processing.	351	=item Step 0: Generic argument processing.
350		352
351	The following options influence F<staticperl mkbundle> itself.	353	The following options influence F<staticperl mkbundle> itself.
352		354
353	=over 4	355	=over 4
354		356
355	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
356		358
357	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
358		360
359	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
360		362
361	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
362		364
363	=item any other argument	365	=item any other argument
364		366
365	Any other argument is interpreted as a bundle specification file, which	367	Any other argument is interpreted as a bundle specification file, which
366	supports most long options (without extra quoting), one option per line.	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.
367		372
368	=back	373	=back
369		374
370	=item Step 1: gather candidate files and modules	375	=item Step 1: gather candidate files and modules
371		376
…		…
376		381
377	=over 4	382	=over 4
378		383
379	=item C<--use> F<module> \| C<-M>F<module>	384	=item C<--use> F<module> \| C<-M>F<module>
380		385
381	Include the named module and trace direct dependencies. This is done by	386	Include the named module or perl library and trace direct
382	C<require>'ing the module in a subprocess and tracing which other modules	387	dependencies. This is done by loading the module in a subprocess and
383	and files it actually loads.	388	tracing which other modules and files it actually loads.
384		389
385	Example: include AnyEvent and AnyEvent::Impl::Perl.	390	Example: include AnyEvent and AnyEvent::Impl::Perl.
386		391
387	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	392	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
388		393
389	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	394	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
390	maybe other weirdly named files. To do that, you need to quote the name in	395	maybe other weirdly named files. To support this, the C<--use> option
391	single or double quotes. When given on the command line, you probably need	396	actually tries to do what you mean, depending on the string you specify:
392	to quote once more to avoid your shell interpreting it. Common cases that	397
393	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.	398	=over 4
		399
		400	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		401	F<Coro::Mysql>.
		402
		403	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		404	assumes that it is a normal module name. It will create a new package and
		405	evaluate a C<use module> in it, i.e. it will load the package and do a
		406	default import.
		407
		408	The import step is done because many modules trigger more dependencies
		409	when something is imported than without.
		410
		411	=item anything that contains F</> or F<.> characters,
		412	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		413
		414	The string will be quoted and passed to require, as if you used C<require
		415	$module>. Nothing will be imported.
		416
		417	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		418
		419	If you enclose the name into single or double quotes, then the quotes will
		420	be removed and the resulting string will be passed to require. This syntax
		421	is form compatibility with older versions of staticperl and should not be
		422	used anymore.
		423
		424	=back
		425
		426	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		427	symbols), and once via C<require>, not importing any symbols. The first
		428	form is preferred as many modules load some extra dependencies when asked
		429	to export symbols.
		430
		431	staticperl mkbundle -MAnyEvent::Socket # use + import
		432	staticperl mkbundle -MAnyEvent/Socket.pm # require only
394		433
395	Example: include the required files for F<perl -V> to work in all its	434	Example: include the required files for F<perl -V> to work in all its
396	glory (F<Config.pm> is included automatically by this).	435	glory (F<Config.pm> is included automatically by the dependency tracker).
397		436
398	# bourne shell	437	# shell command
399	staticperl mkbundle --use '"Config_heavy.pl"'	438	staticperl mkbundle -MConfig_heavy.pl
400		439
401	# bundle specification file	440	# bundle specification file
402	use "Config_heavy.pl"	441	use Config_heavy.pl
403		442
404	The C<-M>module syntax is included as an alias that might be easier to	443	The C<-M>module syntax is included as a convenience that might be easier
405	remember than C<--use>. Or maybe it confuses people. Time will tell. Or	444	to remember than C<--use> - it's the same switch as perl itself uses
		445	to load modules. Or maybe it confuses people. Time will tell. Or maybe
406	maybe not. Sigh.	446	not. Sigh.
407		447
408	=item C<--eval> "perl code" \| C<-e> "perl code"	448	=item C<--eval> "perl code" \| C<-e> "perl code"
409		449
410	Sometimes it is easier (or necessary) to specify dependencies using perl	450	Sometimes it is easier (or necessary) to specify dependencies using perl
411	code, or maybe one of the modules you use need a special use statement. In	451	code, or maybe one of the modules you use need a special use statement. In
412	that case, you can use C<--eval> to execute some perl snippet or set some	452	that case, you can use C<--eval> to execute some perl snippet or set some
413	variables or whatever you need. All files C<require>'d or C<use>'d while	453	variables or whatever you need. All files C<require>'d or C<use>'d while
414	executing the snippet are included in the final bundle.	454	executing the snippet are included in the final bundle.
415		455
416	Keep in mind that F<mkbundle> will only C<require> the modules named	456	Keep in mind that F<mkbundle> will not import any symbols from the modules
417	by the C<--use> option, so do not expect the symbols from modules you	457	named by the C<--use> option, so do not expect the symbols from modules
418	C<--use>'d earlier on the command line to be available.	458	you C<--use>'d earlier on the command line to be available.
419		459
420	Example: force L<AnyEvent> to detect a backend and therefore include it	460	Example: force L<AnyEvent> to detect a backend and therefore include it
421	in the final bundle.	461	in the final bundle.
422		462
423	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'	463	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
…		…
450	This is very useful to include "everything":	490	This is very useful to include "everything":
451		491
452	--incglob '*'	492	--incglob '*'
453		493
454	It is also useful for including perl libraries, or trees of those, such as	494	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	495	the unicode database files needed by some perl built-ins, the regex engine
456	and other modules.	496	and other modules.
457		497
458	--incglob '/unicore/**.pl'	498	--incglob '/unicore/**.pl'
459		499
460	=item C<--add> F<file> \| C<--add> "F<file> alias"	500	=item C<--add> F<file> \| C<--add> "F<file> alias"
461		501
462	Adds the given (perl) file into the bundle (and optionally call it	502	Adds the given (perl) file into the bundle (and optionally call it
463	"alias"). The F<file> is either an absolute path or a path relative to	503	"alias"). The F<file> is either an absolute path or a path relative to the
464	the current directory. If an alias is specified, then this is the name it	504	current directory. If an alias is specified, then this is the name it will
465	will use for C<@INC> searches, otherfile the F<file> will be used as the	505	use for C<@INC> searches, otherwise the path F<file> will be used as the
466	internal name.	506	internal name.
467		507
468	This switch is used to include extra files into the bundle.	508	This switch is used to include extra files into the bundle.
469		509
470	Example: embed the file F<httpd> in the current directory as F<httpd.pm>	510	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
471	when creating the bundle.	511	when creating the bundle.
472		512
473	staticperl mkperl --add "httpd httpd.pm"	513	staticperl mkperl --add "httpd httpd.pm"
		514
		515	# can be accessed via "use httpd"
		516
		517	Example: add a file F<initcode> from the current directory.
		518
		519	staticperl mkperl --add 'initcode &initcode'
		520
		521	# can be accessed via "do '&initcode'"
474		522
475	Example: add local files as extra modules in the bundle.	523	Example: add local files as extra modules in the bundle.
476		524
477	# specification file	525	# specification file
478	add file1 myfiles/file1.pm	526	add file1 myfiles/file1.pm
…		…
488		536
489	Just like C<--add>, except that it treats the file as binary and adds it	537	Just like C<--add>, except that it treats the file as binary and adds it
490	without any postprocessing (perl files might get stripped to reduce their	538	without any postprocessing (perl files might get stripped to reduce their
491	size).	539	size).
492		540
493	You should probably add a C</> prefix to avoid clashing with embedded perl	541	If you specify an alias you should probably add a C<&> prefix to avoid
494	files (whose paths do not start with C</>), and/or use a special directory	542	clashing with embedded perl files (whose paths never start with C<&>),
495	prefix, such as C</res/name>.	543	and/or use a special directory prefix, such as C<&res/name>.
496		544
497	You can later get a copy of these files by calling C<staticperl::find	545	You can later get a copy of these files by calling C<staticperl::find
498	"alias">.	546	"alias">.
499		547
500	An alternative way to embed binary files is to convert them to perl and	548	An alternative way to embed binary files is to convert them to perl and
…		…
513		561
514	=item Step 2: filter all files using C<--include> and C<--exclude> options.	562	=item Step 2: filter all files using C<--include> and C<--exclude> options.
515		563
516	After all candidate files and modules are added, they are I<filtered>	564	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	565	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	566	implicit C<--include *> at the end, so if no filters are specified, all
519	files are included).	567	files are included).
520		568
521	All that this step does is potentially reduce the number of files that are	569	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.	570	to be included - no new files are added during this step.
523		571
…		…
548	that are added automatically. Only one (F<.packlist> files) is currently	596	that are added automatically. Only one (F<.packlist> files) is currently
549	optional and can be influenced, the others are always included:	597	optional and can be influenced, the others are always included:
550		598
551	=over 4	599	=over 4
552		600
553	=item C<--usepacklist>	601	=item C<--usepacklists>
554		602
555	Read F<.packlist> files for each distribution that happens to match a	603	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	604	module name you specified. Sounds weird, and it is, so expect semantics to
557	change somehow in the future.	605	change somehow in the future.
558		606
…		…
626	Last not least, if you need accurate line numbers in error messages,	674	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	675	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	676	mistreated, you can specify C<none> to not mangle included perl sources in
629	any way.	677	any way.
630		678
631	=item --perl	679	=item C<--perl>
632		680
633	After writing out the bundle files, try to link a new perl interpreter. It	681	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	682	will be called F<perl> and will be left in the current working
635	directory. The bundle files will be removed.	683	directory. The bundle files will be removed.
636		684
…		…
641	it will be even smaller than the standard perl interpreter as none of the	689	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.	690	modules of the base distribution (such as L<Fcntl>) will be included.
643		691
644	staticperl mkperl -Mcommon::sense	692	staticperl mkperl -Mcommon::sense
645		693
646	=item --app name	694	=item C<--app> F<name>
647		695
648	After writing out the bundle files, try to link a new standalone	696	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	697	program. It will be called C<name>, and the bundle files get removed after
650	linking it.	698	linking it.
651		699
…		…
655	The difference to the (mutually exclusive) C<--perl> option is that the	703	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 -	704	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	705	instead it will simply initialise the perl interpreter, clean it up and
658	exit.	706	exit.
659		707
660	This means that, by default, it will do nothing but burna few CPU cycles	708	This means that, by default, it will do nothing but burn a few CPU cycles
661	- for it to do something useful you I<must> add some boot code, e.g. with	709	- for it to do something useful you I<must> add some boot code, e.g. with
662	the C<--boot> option.	710	the C<--boot> option.
663		711
664	Example: create a standalone perl binary called F<./myexe> that will	712	Example: create a standalone perl binary called F<./myexe> that will
665	execute F<appfile> when it is started.	713	execute F<appfile> when it is started.
666		714
667	staticperl mkbundle --app myexe --boot appfile	715	staticperl mkbundle --app myexe --boot appfile
668		716
		717	=item C<--ignore-env>
		718
		719	Generates extra code to unset some environment variables before
		720	initialising/running perl. Perl supports a lot of environment variables
		721	that might alter execution in ways that might be undesirablre for
		722	standalone applications, and this option removes those known to cause
		723	trouble.
		724
		725	Specifically, these are removed:
		726
		727	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
		728	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		729	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		730	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
		731
		732	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
		733	startup code used by F<staticperl> overrides C<@INC> in all cases.
		734
		735	This option will not make your program more secure (unless you are
		736	running with elevated privileges), but it will reduce the surprise effect
		737	when a user has these environment variables set and doesn't expect your
		738	standalone program to act like a perl interpreter.
		739
669	=item --static	740	=item C<--static>
670		741
671	Add C<-static> to F<bundle.ldopts>, which means a fully static (if	742	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	743	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	744	useful when just creating the bundle files, but is most useful when
674	linking a binary with the C<--perl> or C<--app> options.	745	linking a binary with the C<--perl> or C<--app> options.
…		…
681	systems based on GNU libc don't really support it in a very usable	752	systems based on GNU libc don't really support it in a very usable
682	fashion either. Try uClibc if you want to create fully statically linked	753	fashion either. Try uClibc if you want to create fully statically linked
683	executables, or try the C<--staticlib> option to link only some libraries	754	executables, or try the C<--staticlib> option to link only some libraries
684	statically.	755	statically.
685		756
686	=item --staticlib libname	757	=item C<--staticlib> libname
687		758
688	When not linking fully statically, this option allows you to link specific	759	When not linking fully statically, this option allows you to link specific
689	libraries statically. What it does is simply replace all occurances of	760	libraries statically. What it does is simply replace all occurrences of
690	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	761	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
691	option.	762	option.
692		763
693	This will have no effect unless the library is actually linked against,	764	This will have no effect unless the library is actually linked against,
694	specifically, C<--staticlib> will not link against the named library	765	specifically, C<--staticlib> will not link against the named library
695	unless it would be linked against anyway.	766	unless it would be linked against anyway.
696		767
697	Example: link libcrypt statically into the binary.	768	Example: link libcrypt statically into the final binary.
698		769
699	staticperl mkperl -MIO::AIO --staticlib crypt	770	staticperl mkperl -MIO::AIO --staticlib crypt
700		771
701	# ldopts might now contain:	772	# ldopts might now contain:
702	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	773	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
…		…
723	=item Patterns not starting with F</> will be anchored at the end of the path.	794	=item Patterns not starting with F</> will be anchored at the end of the path.
724		795
725	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	796	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.	797	hierarchy, but not any directories of the same name.
727		798
728	=item A F<*> matches any single component.	799	=item A F<*> matches anything within a single path component.
729		800
730	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	801	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<*>	802	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
732	will not match slashes.	803	will not match slashes.
733		804
…		…
808	installation, you can set any environment variable you want - some modules	879	installation, you can set any environment variable you want - some modules
809	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	880	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
810		881
811	=item C<PERL_VERSION>	882	=item C<PERL_VERSION>
812		883
813	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	884	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
814	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is	885	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
815	about as big as 5.12.2).	886	about as big as 5.12.3).
816		887
817	=item C<PERL_PREFIX>	888	=item C<PERL_PREFIX>
818		889
819	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	890	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
820	i.e. where the F<bin> and F<lib> subdirectories will end up.	891	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
944	A header file that contains the prototypes of the few symbols "exported"	1015	A header file that contains the prototypes of the few symbols "exported"
945	by bundle.c, and also exposes the perl headers to the application.	1016	by bundle.c, and also exposes the perl headers to the application.
946		1017
947	=over 4	1018	=over 4
948		1019
949	=item staticperl_init ()	1020	=item staticperl_init (xs_init = 0)
950		1021
951	Initialises the perl interpreter. You can use the normal perl functions	1022	Initialises the perl interpreter. You can use the normal perl functions
952	after calling this function, for example, to define extra functions or	1023	after calling this function, for example, to define extra functions or
953	to load a .pm file that contains some initialisation code, or the main	1024	to load a .pm file that contains some initialisation code, or the main
954	program function:	1025	program function:
…		…
961	}	1032	}
962		1033
963	static void	1034	static void
964	run_myapp(void)	1035	run_myapp(void)
965	{	1036	{
966	staticperl_init ();	1037	staticperl_init (0);
967	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1038	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
968	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1039	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
969	}	1040	}
970		1041
		1042	When your bootcode already wants to access some XS functions at
		1043	compiletime, then you need to supply an C<xs_init> function pointer that
		1044	is called as soon as perl is initialised enough to define XS functions,
		1045	but before the preamble code is executed:
		1046
		1047	static void
		1048	xs_init (pTHX)
		1049	{
		1050	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1051	}
		1052
		1053	static void
		1054	run_myapp(void)
		1055	{
		1056	staticperl_init (xs_init);
		1057	}
		1058
		1059	=item staticperl_cleanup ()
		1060
		1061	In the unlikely case that you want to destroy the perl interpreter, here
		1062	is the corresponding function.
		1063
971	=item staticperl_xs_init (pTHX)	1064	=item staticperl_xs_init (pTHX)
972		1065
973	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1066	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
974	which case you do not want to use C<staticperl_init> but call them on your	1067	which case you do not want to use C<staticperl_init> but call them on your
975	own.	1068	own.
976		1069
977	Then you need this function - either pass it directly as the C<xs_init>	1070	Then you need this function - either pass it directly as the C<xs_init>
978	function to C<perl_parse>, or call it from your own C<xs_init> function.	1071	function to C<perl_parse>, or call it as one of the first things from your
979		1072	own C<xs_init> function.
980	=item staticperl_cleanup ()
981
982	In the unlikely case that you want to destroy the perl interpreter, here
983	is the corresponding function.
984		1073
985	=item PerlInterpreter *staticperl	1074	=item PerlInterpreter *staticperl
986		1075
987	The perl interpreter pointer used by staticperl. Not normally so useful,	1076	The perl interpreter pointer used by staticperl. Not normally so useful,
988	but there it is.	1077	but there it is.
…		…
1024		1113
1025	Returns the list of all paths embedded in this binary.	1114	Returns the list of all paths embedded in this binary.
1026		1115
1027	=back	1116	=back
1028		1117
1029	=head1 FULLY STATIC BINARIES - BUILDROOT	1118	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1030		1119
1031	To make truly static (Linux-) libraries, you might want to have a look at	1120	To make truly static (Linux-) libraries, you might want to have a look at
1032	buildroot (L<http://buildroot.uclibc.org/>).	1121	buildroot (L<http://buildroot.uclibc.org/>).
1033		1122
1034	Buildroot is primarily meant to set up a cross-compile environment (which	1123	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
1095		1184
1096	Some functionality in the utf8 module, such as swash handling (used	1185	Some functionality in the utf8 module, such as swash handling (used
1097	for unicode character ranges in regexes) is implemented in the	1186	for unicode character ranges in regexes) is implemented in the
1098	C<"utf8_heavy.pl"> library:	1187	C<"utf8_heavy.pl"> library:
1099		1188
1100	-M'"utf8_heavy.pl"'	1189	-Mutf8_heavy.pl
1101		1190
1102	Many Unicode properties in turn are defined in separate modules,	1191	Many Unicode properties in turn are defined in separate modules,
1103	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1192	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	1193	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1105	are big (7MB uncompressed, although F<staticperl> contains special	1194	are big (7MB uncompressed, although F<staticperl> contains special
1106	handling for those files), so including them on demand by your application	1195	handling for those files), so including them on demand by your application
1107	only might pay off.	1196	only might pay off.
1108		1197
1109	To simply include the whole unicode database, use:	1198	To simply include the whole unicode database, use:
1110		1199
1111	--incglob '/unicore/*.pl'	1200	--incglob '/unicore/**.pl'
1112		1201
1113	=item AnyEvent	1202	=item AnyEvent
1114		1203
1115	AnyEvent needs a backend implementation that it will load in a delayed	1204	AnyEvent needs a backend implementation that it will load in a delayed
1116	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1205	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
1121		1210
1122	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1211	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	1212	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1124	C<"AnyEvent/Util/uts46data.pl">.	1213	C<"AnyEvent/Util/uts46data.pl">.
1125		1214
1126	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1215	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1127	everything.	1216	everything.
1128		1217
1129	=item Carp	1218	=item Carp
1130		1219
1131	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1220	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
…		…
1137	turn might need L<"Config_heavy.pl">. Including the latter gives you	1226	turn might need L<"Config_heavy.pl">. Including the latter gives you
1138	both.	1227	both.
1139		1228
1140	=item Term::ReadLine::Perl	1229	=item Term::ReadLine::Perl
1141		1230
1142	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1231	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1143		1232
1144	=item URI	1233	=item URI
1145		1234
1146	URI implements schemes as separate modules - the generic URL scheme is	1235	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	1236	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,	1237	you need to use any of these schemes, you should include these manually,
1149	or use C<--usepacklist>.	1238	or use C<--usepacklists>.
1150		1239
1151	=back	1240	=back
1152		1241
1153	=head2 RECIPES	1242	=head2 RECIPES
1154		1243
1155	=over 4	1244	=over 4
1156		1245
1157	=item Linking everything in	1246	=item Just link everything in
1158		1247
1159	To link just about everything installed in the perl library into a new	1248	To link just about everything installed in the perl library into a new
1160	perl, try this:	1249	perl, try this (the first time this runs it will take a long time, as a
		1250	lot of files need to be parsed):
1161		1251
1162	staticperl mkperl --strip ppi --incglob '*'	1252	staticperl mkperl -v --strip ppi --incglob '*'
1163		1253
		1254	If you don't mind the extra megabytes, this can be a very effective way of
		1255	creating bundles without having to worry about forgetting any modules.
		1256
		1257	You get even more useful variants of this method by first selecting
		1258	everything, and then excluding stuff you are reasonable sure not to need -
		1259	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1260
1164	=item Getting rid of netdb function	1261	=item Getting rid of netdb functions
1165		1262
1166	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1263	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	1264	and so on) that few applications use. You can avoid compiling them in by
1168	putting the following fragment into a C<preconfigure> hook:	1265	putting the following fragment into a C<preconfigure> hook:
1169		1266
…		…
1186	do	1283	do
1187	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1284	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1188	done	1285	done
1189	}	1286	}
1190		1287
1191	This mostly gains space when linking staticaly, as the functions will	1288	This mostly gains space when linking statically, as the functions will
1192	likely not be linked in. The gain for dynamically-linked binaries is	1289	likely not be linked in. The gain for dynamically-linked binaries is
1193	smaller.	1290	smaller.
1194		1291
1195	Also, this leaves C<gethostbyname> in - not only is it actually used	1292	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	1293	often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs. Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs.
Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC