… | |
… | |
9 | staticperl configure # fetch and then configure perl |
9 | staticperl configure # fetch and then configure perl |
10 | staticperl build # configure and then build perl |
10 | staticperl build # configure and then build perl |
11 | staticperl install # build and then install perl |
11 | staticperl install # build and then install perl |
12 | staticperl clean # clean most intermediate files (restart at configure) |
12 | staticperl clean # clean most intermediate files (restart at configure) |
13 | staticperl distclean # delete everything installed by this script |
13 | staticperl distclean # delete everything installed by this script |
|
|
14 | staticperl perl ... # invoke the perlinterpreter |
14 | staticperl cpan # invoke CPAN shell |
15 | staticperl cpan # invoke CPAN shell |
15 | staticperl instmod path... # install unpacked modules |
16 | staticperl instmod path... # install unpacked modules |
16 | staticperl instcpan modulename... # install modules from CPAN |
17 | staticperl instcpan modulename... # install modules from CPAN |
17 | staticperl mkbundle <bundle-args...> # see documentation |
18 | staticperl mkbundle <bundle-args...> # see documentation |
18 | staticperl mkperl <bundle-args...> # see documentation |
19 | staticperl mkperl <bundle-args...> # see documentation |
… | |
… | |
20 | |
21 | |
21 | Typical Examples: |
22 | Typical Examples: |
22 | |
23 | |
23 | staticperl install # fetch, configure, build and install perl |
24 | staticperl install # fetch, configure, build and install perl |
24 | staticperl cpan # run interactive cpan shell |
25 | staticperl cpan # run interactive cpan shell |
25 | staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V |
26 | staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V |
26 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
27 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
27 | # build a perl with the above modules linked in |
28 | # build a perl with the above modules linked in |
28 | staticperl mkapp myapp --boot mainprog mymodules |
29 | staticperl mkapp myapp --boot mainprog mymodules |
29 | # build a binary "myapp" from mainprog and mymodules |
30 | # build a binary "myapp" from mainprog and mymodules |
30 | |
31 | |
… | |
… | |
139 | with creating binaries and bundle files. |
140 | with creating binaries and bundle files. |
140 | |
141 | |
141 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
142 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
142 | |
143 | |
143 | The most important command is F<install>, which does basically |
144 | 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 |
145 | 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 |
146 | modules required by F<staticperl> itself, but all this can (and should) be |
146 | changed - see L<CONFIGURATION>, below. |
147 | changed - see L<CONFIGURATION>, below. |
147 | |
148 | |
148 | The command |
149 | The command |
149 | |
150 | |
… | |
… | |
185 | |
186 | |
186 | =item F<staticperl install> |
187 | =item F<staticperl install> |
187 | |
188 | |
188 | Wipes the perl installation directory (usually F<~/.staticperl/perl>) and |
189 | Wipes the perl installation directory (usually F<~/.staticperl/perl>) and |
189 | installs the perl distribution, potentially after building it first. |
190 | installs the perl distribution, potentially after building it first. |
|
|
191 | |
|
|
192 | =item F<staticperl perl> [args...] |
|
|
193 | |
|
|
194 | Invokes the compiled perl interpreter with the given args. Basically the |
|
|
195 | same as starting perl directly (usually via F<~/.staticperl/bin/perl>), |
|
|
196 | but beats typing the path sometimes. |
|
|
197 | |
|
|
198 | Example: check that the Gtk2 module is installed and loadable. |
|
|
199 | |
|
|
200 | staticperl perl -MGtk2 -e0 |
190 | |
201 | |
191 | =item F<staticperl cpan> [args...] |
202 | =item F<staticperl cpan> [args...] |
192 | |
203 | |
193 | Starts an interactive CPAN shell that you can use to install further |
204 | Starts an interactive CPAN shell that you can use to install further |
194 | modules. Installs the perl first if necessary, but apart from that, |
205 | modules. Installs the perl first if necessary, but apart from that, |
… | |
… | |
252 | |
263 | |
253 | # first make sure we have perl and the required modules |
264 | # first make sure we have perl and the required modules |
254 | staticperl instcpan AnyEvent::HTTPD |
265 | staticperl instcpan AnyEvent::HTTPD |
255 | |
266 | |
256 | # now build the perl |
267 | # now build the perl |
257 | staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ |
268 | staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \ |
258 | -MAnyEvent::HTTPD -MURI::http \ |
269 | -MAnyEvent::HTTPD -MURI::http \ |
259 | --add 'eg/httpd httpd.pm' |
270 | --add 'eg/httpd httpd.pm' |
260 | |
271 | |
261 | # finally, invoke it |
272 | # finally, invoke it |
262 | ./perl -Mhttpd |
273 | ./perl -Mhttpd |
… | |
… | |
381 | |
392 | |
382 | =over 4 |
393 | =over 4 |
383 | |
394 | |
384 | =item C<--use> F<module> | C<-M>F<module> |
395 | =item C<--use> F<module> | C<-M>F<module> |
385 | |
396 | |
386 | Include the named module and trace direct dependencies. This is done by |
397 | Include the named module or perl library and trace direct |
387 | C<use>'ing the module from a fresh package in a subprocess and tracing |
398 | dependencies. This is done by loading the module in a subprocess and |
388 | which other modules and files it actually loads. |
399 | tracing which other modules and files it actually loads. |
389 | |
400 | |
390 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
401 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
391 | |
402 | |
392 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
403 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
393 | |
404 | |
394 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), |
405 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
395 | or maybe other weirdly named files. To do that, you need to quote |
406 | maybe other weirdly named files. To support this, the C<--use> option |
396 | the name in single or double quotes (this is because F<staticperl> |
407 | actually tries to do what you mean, depending on the string you specify: |
397 | I<literally> just adds the string after the C<require> - which acts |
408 | |
398 | different when confronted with quoted vs. unquoted strings). When given on |
409 | =over 4 |
399 | the command line, you probably need to quote once more to avoid your shell |
410 | |
400 | interpreting it. Common cases that need this are F<Config_heavy.pl> and |
411 | =item a possibly valid module name, e.g. F<common::sense>, F<Carp>, |
401 | F<utf8_heavy.pl>. |
412 | F<Coro::Mysql>. |
|
|
413 | |
|
|
414 | If the string contains no quotes, no F</> and no F<.>, then C<--use> |
|
|
415 | assumes that it is a normal module name. It will create a new package and |
|
|
416 | evaluate a C<use module> in it, i.e. it will load the package and do a |
|
|
417 | default import. |
|
|
418 | |
|
|
419 | The import step is done because many modules trigger more dependencies |
|
|
420 | when something is imported than without. |
|
|
421 | |
|
|
422 | =item anything that contains F</> or F<.> characters, |
|
|
423 | e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>. |
|
|
424 | |
|
|
425 | The string will be quoted and passed to require, as if you used C<require |
|
|
426 | $module>. Nothing will be imported. |
|
|
427 | |
|
|
428 | =item "path" or 'path', e.g. C<"utf8_heavy.pl">. |
|
|
429 | |
|
|
430 | If you enclose the name into single or double quotes, then the quotes will |
|
|
431 | be removed and the resulting string will be passed to require. This syntax |
|
|
432 | is form compatibility with older versions of staticperl and should not be |
|
|
433 | used anymore. |
|
|
434 | |
|
|
435 | =back |
|
|
436 | |
|
|
437 | Example: C<use> AnyEvent::Socket, once using C<use> (importing the |
|
|
438 | symbols), and once via C<require>, not importing any symbols. The first |
|
|
439 | form is preferred as many modules load some extra dependencies when asked |
|
|
440 | to export symbols. |
|
|
441 | |
|
|
442 | staticperl mkbundle -MAnyEvent::Socket # use + import |
|
|
443 | staticperl mkbundle -MAnyEvent/Socket.pm # require only |
402 | |
444 | |
403 | Example: include the required files for F<perl -V> to work in all its |
445 | Example: include the required files for F<perl -V> to work in all its |
404 | glory (F<Config.pm> is included automatically by this). |
446 | glory (F<Config.pm> is included automatically by the dependency tracker). |
405 | |
447 | |
406 | # bourne shell |
448 | # shell command |
407 | staticperl mkbundle --use '"Config_heavy.pl"' |
449 | staticperl mkbundle -MConfig_heavy.pl |
408 | |
450 | |
409 | # bundle specification file |
451 | # bundle specification file |
410 | use "Config_heavy.pl" |
452 | use Config_heavy.pl |
411 | |
453 | |
412 | The C<-M>module syntax is included as a convenience that might be easier |
454 | The C<-M>module syntax is included as a convenience that might be easier |
413 | to remember than C<--use> - it's the same switch as perl itself uses |
455 | to remember than C<--use> - it's the same switch as perl itself uses |
414 | to load modules. Or maybe it confuses people. Time will tell. Or maybe |
456 | to load modules. Or maybe it confuses people. Time will tell. Or maybe |
415 | not. Sigh. |
457 | not. Sigh. |
… | |
… | |
469 | =item C<--add> F<file> | C<--add> "F<file> alias" |
511 | =item C<--add> F<file> | C<--add> "F<file> alias" |
470 | |
512 | |
471 | Adds the given (perl) file into the bundle (and optionally call it |
513 | Adds the given (perl) file into the bundle (and optionally call it |
472 | "alias"). The F<file> is either an absolute path or a path relative to the |
514 | "alias"). The F<file> is either an absolute path or a path relative to the |
473 | current directory. If an alias is specified, then this is the name it will |
515 | current directory. If an alias is specified, then this is the name it will |
474 | use for C<@INC> searches, otherwise the path F<&file> will be used as the |
516 | use for C<@INC> searches, otherwise the path F<file> will be used as the |
475 | internal name. |
517 | internal name. |
476 | |
518 | |
477 | This switch is used to include extra files into the bundle. |
519 | This switch is used to include extra files into the bundle. |
478 | |
520 | |
479 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
521 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
… | |
… | |
483 | |
525 | |
484 | # can be accessed via "use httpd" |
526 | # can be accessed via "use httpd" |
485 | |
527 | |
486 | Example: add a file F<initcode> from the current directory. |
528 | Example: add a file F<initcode> from the current directory. |
487 | |
529 | |
488 | staticperl mkperl --add initcode |
530 | staticperl mkperl --add 'initcode &initcode' |
489 | |
531 | |
490 | # can be accessed via "do '&initcode'" |
532 | # can be accessed via "do '&initcode'" |
491 | |
533 | |
492 | Example: add local files as extra modules in the bundle. |
534 | Example: add local files as extra modules in the bundle. |
493 | |
535 | |
… | |
… | |
681 | Example: create a standalone perl binary called F<./myexe> that will |
723 | Example: create a standalone perl binary called F<./myexe> that will |
682 | execute F<appfile> when it is started. |
724 | execute F<appfile> when it is started. |
683 | |
725 | |
684 | staticperl mkbundle --app myexe --boot appfile |
726 | staticperl mkbundle --app myexe --boot appfile |
685 | |
727 | |
|
|
728 | =item C<--ignore-env> |
|
|
729 | |
|
|
730 | Generates extra code to unset some environment variables before |
|
|
731 | initialising/running perl. Perl supports a lot of environment variables |
|
|
732 | that might alter execution in ways that might be undesirablre for |
|
|
733 | standalone applications, and this option removes those known to cause |
|
|
734 | trouble. |
|
|
735 | |
|
|
736 | Specifically, these are removed: |
|
|
737 | |
|
|
738 | C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible |
|
|
739 | output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and |
|
|
740 | C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>, |
|
|
741 | C<PERLIO_DEBUG> and C<PERLIO> can affect input and output. |
|
|
742 | |
|
|
743 | The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the |
|
|
744 | startup code used by F<staticperl> overrides C<@INC> in all cases. |
|
|
745 | |
|
|
746 | This option will not make your program more secure (unless you are |
|
|
747 | running with elevated privileges), but it will reduce the surprise effect |
|
|
748 | when a user has these environment variables set and doesn't expect your |
|
|
749 | standalone program to act like a perl interpreter. |
|
|
750 | |
686 | =item C<--static> |
751 | =item C<--static> |
687 | |
752 | |
688 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
753 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
689 | supported by the OS) executable will be created. This is not immensely |
754 | supported by the OS) executable will be created. This is not immensely |
690 | useful when just creating the bundle files, but is most useful when |
755 | useful when just creating the bundle files, but is most useful when |
… | |
… | |
825 | installation, you can set any environment variable you want - some modules |
890 | installation, you can set any environment variable you want - some modules |
826 | (such as L<Coro> or L<EV>) use environment variables for further tweaking. |
891 | (such as L<Coro> or L<EV>) use environment variables for further tweaking. |
827 | |
892 | |
828 | =item C<PERL_VERSION> |
893 | =item C<PERL_VERSION> |
829 | |
894 | |
830 | The perl version to install - default is currently C<5.12.2>, but C<5.8.9> |
895 | The perl version to install - default is currently C<5.12.3>, but C<5.8.9> |
831 | is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is |
896 | is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is |
832 | about as big as 5.12.2). |
897 | about as big as 5.12.3). |
833 | |
898 | |
834 | =item C<PERL_PREFIX> |
899 | =item C<PERL_PREFIX> |
835 | |
900 | |
836 | The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
901 | The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
837 | i.e. where the F<bin> and F<lib> subdirectories will end up. |
902 | i.e. where the F<bin> and F<lib> subdirectories will end up. |
… | |
… | |
858 | F<~/.staticperlrc> to override them. |
923 | F<~/.staticperlrc> to override them. |
859 | |
924 | |
860 | Most of the variables override (or modify) the corresponding F<Configure> |
925 | Most of the variables override (or modify) the corresponding F<Configure> |
861 | variable, except C<PERL_CCFLAGS>, which gets appended. |
926 | variable, except C<PERL_CCFLAGS>, which gets appended. |
862 | |
927 | |
|
|
928 | You should have a look near the beginning of the F<staticperl> script - |
|
|
929 | staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options |
|
|
930 | suitable for newer gcc versions. For other compilers or older versions you |
|
|
931 | need to adjust these, for example, in your F<~/.staticperlrc>. |
|
|
932 | |
863 | =back |
933 | =back |
864 | |
934 | |
865 | =head4 Variables you probably I<do not want> to override |
935 | =head4 Variables you probably I<do not want> to override |
866 | |
936 | |
867 | =over 4 |
937 | =over 4 |
… | |
… | |
885 | =head3 OVERRIDABLE HOOKS |
955 | =head3 OVERRIDABLE HOOKS |
886 | |
956 | |
887 | In addition to environment variables, it is possible to provide some |
957 | In addition to environment variables, it is possible to provide some |
888 | shell functions that are called at specific times. To provide your own |
958 | shell functions that are called at specific times. To provide your own |
889 | commands, just define the corresponding function. |
959 | commands, just define the corresponding function. |
|
|
960 | |
|
|
961 | The actual order in which hooks are invoked during a full install |
|
|
962 | from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>, |
|
|
963 | C<postbuild>, C<postinstall>. |
890 | |
964 | |
891 | Example: install extra modules from CPAN and from some directories |
965 | Example: install extra modules from CPAN and from some directories |
892 | at F<staticperl install> time. |
966 | at F<staticperl install> time. |
893 | |
967 | |
894 | postinstall() { |
968 | postinstall() { |
… | |
… | |
901 | |
975 | |
902 | =over 4 |
976 | =over 4 |
903 | |
977 | |
904 | =item preconfigure |
978 | =item preconfigure |
905 | |
979 | |
906 | Called just before running F<./Configur> in the perl source |
980 | Called just before running F<./Configure> in the perl source |
907 | directory. Current working directory is the perl source directory. |
981 | directory. Current working directory is the perl source directory. |
908 | |
982 | |
909 | This can be used to set any C<PERL_xxx> variables, which might be costly |
983 | This can be used to set any C<PERL_xxx> variables, which might be costly |
910 | to compute. |
984 | to compute. |
911 | |
985 | |
|
|
986 | =item patchconfig |
|
|
987 | |
|
|
988 | Called after running F<./Configure> in the perl source directory to create |
|
|
989 | F<./config.sh>, but before running F<./Configure -S> to actually apply the |
|
|
990 | config. Current working directory is the perl source directory. |
|
|
991 | |
|
|
992 | Can be used to tailor/patch F<config.sh> or do any other modifications. |
|
|
993 | |
912 | =item postconfigure |
994 | =item postconfigure |
913 | |
995 | |
914 | Called after configuring, but before building perl. Current working |
996 | Called after configuring, but before building perl. Current working |
915 | directory is the perl source directory. |
997 | directory is the perl source directory. |
916 | |
|
|
917 | Could be used to tailor/patch config.sh (followed by F<sh Configure -S>) |
|
|
918 | or do any other modifications. |
|
|
919 | |
998 | |
920 | =item postbuild |
999 | =item postbuild |
921 | |
1000 | |
922 | Called after building, but before installing perl. Current working |
1001 | Called after building, but before installing perl. Current working |
923 | directory is the perl source directory. |
1002 | directory is the perl source directory. |
… | |
… | |
1130 | |
1209 | |
1131 | Some functionality in the utf8 module, such as swash handling (used |
1210 | Some functionality in the utf8 module, such as swash handling (used |
1132 | for unicode character ranges in regexes) is implemented in the |
1211 | for unicode character ranges in regexes) is implemented in the |
1133 | C<"utf8_heavy.pl"> library: |
1212 | C<"utf8_heavy.pl"> library: |
1134 | |
1213 | |
1135 | -M'"utf8_heavy.pl"' |
1214 | -Mutf8_heavy.pl |
1136 | |
1215 | |
1137 | Many Unicode properties in turn are defined in separate modules, |
1216 | Many Unicode properties in turn are defined in separate modules, |
1138 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
1217 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
1139 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
1218 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
1140 | are big (7MB uncompressed, although F<staticperl> contains special |
1219 | are big (7MB uncompressed, although F<staticperl> contains special |
… | |
… | |
1159 | C<"AnyEvent/Util/uts46data.pl">. |
1238 | C<"AnyEvent/Util/uts46data.pl">. |
1160 | |
1239 | |
1161 | Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
1240 | Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
1162 | everything. |
1241 | everything. |
1163 | |
1242 | |
|
|
1243 | =item Cairo |
|
|
1244 | |
|
|
1245 | See Glib, same problem, same solution. |
|
|
1246 | |
1164 | =item Carp |
1247 | =item Carp |
1165 | |
1248 | |
1166 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1249 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1167 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
1250 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
1168 | |
1251 | |
1169 | =item Config |
1252 | =item Config |
1170 | |
1253 | |
1171 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
1254 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
1172 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1255 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1173 | both. |
1256 | both. |
|
|
1257 | |
|
|
1258 | =item Glib |
|
|
1259 | |
|
|
1260 | Glib literally requires Glib to be installed already to build - it tries |
|
|
1261 | to fake this by running Glib out of the build directory before being |
|
|
1262 | built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and |
|
|
1263 | C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable. |
|
|
1264 | |
|
|
1265 | =item Gtk2 |
|
|
1266 | |
|
|
1267 | See Pango, same problems, same solution. |
|
|
1268 | |
|
|
1269 | =item Pango |
|
|
1270 | |
|
|
1271 | In addition to the C<MAN3PODS> problem in Glib, Pango also routes around |
|
|
1272 | L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl> |
|
|
1273 | tries to patch L<ExtUtils::MM_Unix> to route around Pango. |
1174 | |
1274 | |
1175 | =item Term::ReadLine::Perl |
1275 | =item Term::ReadLine::Perl |
1176 | |
1276 | |
1177 | Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
1277 | Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
1178 | |
1278 | |