1pip(3)                User Contributed Perl Documentation               pip(3)
2
3
4

NAME

6       pip - The Perl Installation Program, for scripted and third-party
7       distribution installation.
8

SYNOPSIS

10         pip script.p5i
11         pip script.p5z
12         pip Distribution-1.23.tgz
13         pip Distribution-1.23.tar.gz
14         pip Distribution-1.23-MSWin32-5.8.0.par
15         pip http://server/Distribution-1.23.tar.gz
16         pip http://github.com/gitpan/Distribution/tarball/1.23
17

DESCRIPTION

19       The pip ("Perl Installation Program") console application is used to
20       install Perl distributions in a wide variety of formats, both from CPAN
21       and from external third-party locations, while supporting module
22       dependencies that go across the boundary from third-party to CPAN.
23
24       Using pip you can install CPAN modules, arbitrary tarballs from both
25       the local file-system or across the internet from arbitrary URIs.
26
27       You can use pip to ensure that specific versions of CPAN modules are
28       installed instead of the most current version.
29
30       And beyond just single installations, you script script a series of
31       these installations by creating a "P5I" (Perl 5 Installation) file.
32
33       A Perl 5 Installation (P5I) file is a small script-like file that
34       describes a set of distributions to install, and integrates the
35       installation of these distributions with the CPAN installer.
36
37       The primary use of P5I files are for installing proprietary or non-CPAN
38       software that may still require the installation of a number of CPAN
39       dependencies in order to function.
40
41       P5I files are also extensible, with the first line of the file
42       specifying the name of the Perl class that implements the plan.
43
44       For the moment, the class described at the top of the P5I file must be
45       installed.
46
47       The simple Module::Plan::Lite plan class is bundled with the main
48       distribution, and additional types can be installed if needed.
49
50   Future Additions
51       Also on the development schedule for pip is the creation and
52       installation of distributions via "P5Z" files, which are tarballs
53       containing a P5I file, as well as all the distribution tarballs
54       referenced by the P5I file.
55
56       It is also anticipated that pip will gain support for PAR binary
57       packages and potentially also for ActivePerl PPM files.
58

USAGE

60       The primary use of pip is to install from a P5I script, with the
61       canonical use case as follows:
62
63         pip directory/myplan.p5i
64
65       This command will load the plan file directory/myplan.p5i, create the
66       plan, and then execute it.
67
68       If only a directory name is given, pip will look for a default.p5i plan
69       in the directory. Thus, all of the following are equivalent
70
71         pip directory
72         pip directory/
73         pip directory/default.p5i
74
75       If no target is provided at all, then the current directory will be
76       used.  Thus, the following are equivalent
77
78         pip
79         pip .
80         pip default.p5i
81         pip ./default.p5i
82
83   Syntax of a plan file
84       Initially, the only plan is available is the Module::Plan::Lite (MPL)
85       plan.
86
87       A typical MPL plan will look like the following
88
89         # myplan.p5i
90         Module::Plan::Lite
91
92         Process-0.17.tar.gz
93         YAML-Tiny-0.10.tar.gz
94
95   Direct installation of a single tarball
96       With the functionality available in pip, you can find that sometimes
97       you don't even want to make a file at all, you just want to install a
98       single tarball.
99
100       The "-i" option lets you pass the name of a single file and it will
101       treat it as an installer for that single file. Further, if the
102       extension of the tarball is .tar.gz, the -i option is implied.
103
104       For example, the following are equivalent.
105
106         # Installing with the -i|--install option
107         > pip Process-0.17.tar.gz
108         > pip -i Process-0.17.tar.gz
109         > pip --install Process-0.17.tar.gz
110
111         # Installing from the file as normal
112         > pip ./default.p5i
113
114         # myplan.p5i
115         Module::Plan::Lite
116
117         Process-0.17.tar.gz
118
119       The "-i" option can be used with any single value supported by
120       Module::Plan::Lite (see above).
121
122       This means you can also use pip to install a distribution from any
123       arbitrary URI, including installing direct from a subversion
124       repository.
125
126         > pip http://svn.ali.as/cpan/release/Process-0.17.tar.gz
127

SUPPORT

129       This module is stored in an Open Repository at the following address.
130
131       <http://svn.ali.as/cpan/trunk/pip>
132
133       Write access to the repository is made available automatically to any
134       published CPAN author, and to most other volunteers on request.
135
136       If you are able to submit your bug report in the form of new (failing)
137       unit tests, or can apply your fix directly instead of submitting a
138       patch, you are strongly encouraged to do so. The author currently
139       maintains over 100 modules and it may take some time to deal with non-
140       Critical bug reports or patches.
141
142       This will guarentee that your issue will be addressed in the next
143       release of the module.
144
145       If you cannot provide a direct test or fix, or don't have time to do
146       so, then regular bug reports are still accepted and appreciated via the
147       CPAN bug tracker.
148
149       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=pip>
150
151       For other issues, for commercial enhancement and support, or to have
152       your write access enabled for the repository, contact the author at the
153       email address above.
154

AUTHORS

156       Adam Kennedy <adamk@cpan.org>
157

SEE ALSO

159       Module::Plan::Base, Module::Plan::Lite, Module::Plan
160
162       Copyright 2006 - 2010 Adam Kennedy.
163
164       This program is free software; you can redistribute it and/or modify it
165       under the same terms as Perl itself.
166
167       The full text of the license can be found in the LICENSE file included
168       with this module.
169
170
171
172perl v5.36.0                      2023-01-20                            pip(3)
Impressum