pp - Perl Packager |
pp - Perl Packager
pp [ -BILMSVXdeghilmoprsv ] [ parfile | scriptfile ]...
Note: When running on Microsoft Windows, the a.out below will be replaced by a.exe instead.
% pp hello # Pack 'hello' into executable 'a.out' % pp -o hello hello.pl # Pack 'hello.pl' into executable 'hello'
% pp -o foo foo.pl bar.pl # Pack 'foo.pl' and 'bar.pl' into 'foo' % ./foo # Run 'foo.pl' inside 'foo' % mv foo bar; ./bar # Run 'bar.pl' inside 'foo' % mv bar baz; ./baz # Error: Can't open perl script "baz"
% pp -p file # Creates a PAR file, 'a.par' % pp -o hello a.par # Pack 'a.par' to executable 'hello' % pp -S -o hello file # Combine the two steps above
% pp -p -o out.par file # Creates 'out.par' from 'file' % pp -B -p -o out.par file # same as above, but bundles core modules % pp -P -o out.pl file # Creates 'out.pl' from 'file' % pp -B -p -o out.pl file # same as above, but bundles core modules # (-B is assumed when making executables)
% pp -e "print 123" # Pack a one-liner into 'a.out' % pp -p -e "print 123" # Creates a PAR file 'a.par' % pp -P -e "print 123" # Creates a perl script 'a.pl'
% pp -c hello # Check dependencies from "perl -c hello" % pp -x hello # Check dependencies from "perl hello" % pp -n -x hello # same as above, but skips static scanning
% pp -I /foo hello # Extra include paths % pp -M Foo::Bar hello # Extra modules in the include path % pp -M abbrev.pl hello # Extra libraries in the include path % pp -X Foo::Bar hello # Exclude modules % pp -a data.txt hello # Additional data files
% pp -r hello # Pack 'hello' into 'a.out', runs 'a.out' % pp -r hello a b c # Pack 'hello' into 'a.out', runs 'a.out' # with arguments 'a b c'
% pp hello --log=c # Pack 'hello' into 'a.out', logs # messages into 'c'
# Pack 'hello' into a console-less 'out.exe' with icon (Win32 only) % pp --gui --icon hello.ico -o out.exe hello
pp creates standalone executables from Perl programs, using the compressed packager provided by PAR, and dependency detection heuristics offered by the Module::ScanDeps manpage. Source files are compressed verbatim without compilation.
You may think of pp as ``perlcc that works without hassle''. :-)
A GUI interface is also available as the tkpp command.
It does not provide the compilation-step acceleration provided by perlcc (however, see -f below for byte-compiled, source-hiding techniques), but makes up for it with better reliability, smaller executable size, and full retrieval of original source code.
When a single input program is specified, the resulting executable will
behave identically as that program. However, when multiple programs
are packaged, the produced executable will run the one that has the
same basename as $0
(i.e. the filename used to invoke it). If
nothing matches, it dies with the error Can't open perl script "$0"
.
Options are available in a short form and a long form. For example, the three lines below are all equivalent:
% pp -o output.exe input.pl % pp --output output.exe input.pl % pp --output=output.exe input.pl
By default, files are placed under /
inside the package with their
original names. You may override this by appending the target filename
after a ;
, like this:
% pp -a "old_filename.txt;new_filename.txt" % pp -a "old_dirname;new_dirname"
You may specify -a
multiple times.
You may specify -A
multiple times.
-p
or -P
is specified.
perl -c inputfile
to determine additonal run-time dependencies.
perl -e '...'
perl inputfile
to determine additonal run-time dependencies.
script(s)
with a the PAR::Filter manpage subclass. You may specify
multiple such filters.
If you wish to hide the source code from casual prying, this will do:
% pp -f Bleach source.pl
Users with Perl 5.8.1 and above may also try out the experimental byte-compiling filter, which will strip away all comments and indents:
% pp -f Bytecode source.pl
-p
is specified.
-p
is specified.
META.yml
and in the executable header (if applicable). The name/value pair is
joined by =
. You may specify -N
multiple times, or use ;
to
link several pairs.
For Win32 executables, these special KEY
names are recognized:
Comments CompanyName FileDescription FileVersion InternalName LegalCopyright LegalTrademarks OriginalFilename ProductName ProductVersion
-l ncurses
means the same thing as -l libncurses.so
or
-l /usr/local/lib/libncurses.so
in most Unixes. May be specified
multiple times.
module(s)
with a the PAR::Filter manpage subclass.
You may specify multiple such filters.
@INC
path; i.e. -M
Module::ScanDeps
means the same thing as -M Module/ScanDeps.pm
.
If MODULE has an extension that is not .pm
/.ix
/.al
, it will not
be scanned for dependencies, and will be placed under /
instead of
/lib/
inside the PAR file. This use is deprecated -- consider using
the -a option instead.
You may specify -M
multiple times.
1
to 3
,
3
being the most verbose. Defaults to 1
if specified without an
argument. Alternatively, -vv sets verbose level to 2
, and -vvv
sets it to 3
.
Here are some recipes showing how to utilize pp to bundle source.pl with all its dependencies, on target machines with different expected settings:
% pp -o packed.exe source.pl # makes packed.exe # Now, deploy 'packed.exe' to target machine... $ packed.exe # run it
% pp -B -P -o packed.pl source.pl # makes packed.exe # Now, deploy 'packed.exe' to target machine... $ perl packed.pl # run it
% pp -P -o packed.pl source.pl # makes packed.exe # Now, deploy 'packed.pl' to target machine... $ perl packed.pl # run it
% pp -p source.pl # makes source.par % echo "use PAR 'source.par';" > packed.pl; % cat source.pl >> packed.pl; # makes packed.pl # Now, deploy 'source.par' and 'packed.pl' to target machine... $ perl packed.pl # run it
Note that even if your perl was built with a shared library, the
'Stand-alone setup' above will not need a separate perl5x.dll
or libperl.so to function correctly. Use --dependent
if you
are willing to ship the shared library with the application, which
can significantly reduce the executable size.
tkpp, par.pl, parl, perlcc
PAR, the PAR::Packer manpage, the Module::ScanDeps manpage
Simon Cozens, Tom Christiansen and Edward Peschko for writing perlcc; this program try to mimic its interface as close as possible, and copied liberally from their code.
Jan Dubois for writing the exetype.pl utility, which has been
partially adapted into the -g
flag.
Mattia Barbon for providing the myldr
binary loader code.
Jeff Goff for suggesting the name pp
.
Autrijus Tang <autrijus@autrijus.org>
http://par.perl.org/ is the official PAR website. You can write to the mailing list at <par@perl.org>, or send an empty mail to <par-subscribe@perl.org> to participate in the discussion.
Please submit bug reports to <bug-par@rt.cpan.org>.
Copyright 2002, 2003, 2004 by Autrijus Tang <autrijus@autrijus.org>.
Neither this program nor the associated parl program impose any licensing restrictions on files generated by their execution, in accordance with the 8th article of the Artistic License:
"Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package."
Therefore, you are absolutely free to place any license on the resulting executable, as long as the packed 3rd-party libraries are also available under the Artistic License.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See http://www.perl.com/perl/misc/Artistic.html
pp - Perl Packager |