1 <commands version="1.0">
3 <summary>Install Package</summary>
4 <function>doInstall</function>
9 <doc>will overwrite newer installed packages</doc>
12 <shortopt>l</shortopt>
13 <doc>do not check for recommended dependency version</doc>
16 <shortopt>n</shortopt>
17 <doc>ignore dependencies, install anyway</doc>
20 <shortopt>r</shortopt>
21 <doc>do not install files, only register the package as installed</doc>
24 <shortopt>s</shortopt>
25 <doc>soft install, fail silently, or upgrade if already installed</doc>
28 <shortopt>B</shortopt>
29 <doc>don't build C extensions</doc>
32 <shortopt>Z</shortopt>
33 <doc>request uncompressed files when downloading</doc>
36 <shortopt>R</shortopt>
37 <doc>root directory used when installing files (ala PHP's INSTALL_ROOT), use packagingroot for RPM</doc>
41 <shortopt>P</shortopt>
42 <doc>root directory used when packaging files, like RPM packaging</doc>
47 <doc>force install even if there were errors</doc>
50 <shortopt>a</shortopt>
51 <doc>install all required and optional dependencies</doc>
54 <shortopt>o</shortopt>
55 <doc>install all required dependencies</doc>
58 <shortopt>O</shortopt>
59 <doc>do not attempt to download any urls or contact channels</doc>
62 <shortopt>p</shortopt>
63 <doc>Only list the packages that would be downloaded</doc>
66 <doc>[channel/]<package> ...
67 Installs one or more PEAR packages. You can specify a package to
70 "Package-1.0.tgz" : installs from a local file
72 "http://example.com/Package-1.0.tgz" : installs from
75 "package.xml" : installs the package described in
76 package.xml. Useful for testing, or for wrapping a PEAR package in
77 another package manager such as RPM.
79 "Package[-version/state][.tar]" : queries your default channel's server
80 ({config master_server}) and downloads the newest package with
81 the preferred quality/state ({config preferred_state}).
83 To retrieve Package version 1.1, use "Package-1.1," to retrieve
84 Package state beta, use "Package-beta." To retrieve an uncompressed
85 file, append .tar (make sure there is no file by the same name first)
87 To download a package from another channel, prefix with the channel name like
88 "channel/Package"
90 More than one package may be specified at once. It is ok to mix these
91 four ways of specifying packages.
95 <summary>Upgrade Package</summary>
96 <function>doInstall</function>
97 <shortcut>up</shortcut>
100 <shortopt>c</shortopt>
101 <doc>upgrade packages from a specific channel</doc>
105 <shortopt>f</shortopt>
106 <doc>overwrite newer installed packages</doc>
109 <shortopt>l</shortopt>
110 <doc>do not check for recommended dependency version</doc>
113 <shortopt>n</shortopt>
114 <doc>ignore dependencies, upgrade anyway</doc>
117 <shortopt>r</shortopt>
118 <doc>do not install files, only register the package as upgraded</doc>
121 <shortopt>B</shortopt>
122 <doc>don't build C extensions</doc>
125 <shortopt>Z</shortopt>
126 <doc>request uncompressed files when downloading</doc>
129 <shortopt>R</shortopt>
130 <doc>root directory used when installing files (ala PHP's INSTALL_ROOT)</doc>
134 <shortopt></shortopt>
135 <doc>force install even if there were errors</doc>
138 <shortopt>a</shortopt>
139 <doc>install all required and optional dependencies</doc>
142 <shortopt>o</shortopt>
143 <doc>install all required dependencies</doc>
146 <shortopt>O</shortopt>
147 <doc>do not attempt to download any urls or contact channels</doc>
150 <shortopt>p</shortopt>
151 <doc>Only list the packages that would be downloaded</doc>
154 <doc><package> ...
155 Upgrades one or more PEAR packages. See documentation for the
156 "install" command for ways to specify a package.
158 When upgrading, your package will be updated if the provided new
159 package has a higher version number (use the -f option if you need to
162 More than one package may be specified at once.
166 <summary>Upgrade All Packages [Deprecated in favor of calling upgrade with no parameters]</summary>
167 <function>doUpgradeAll</function>
168 <shortcut>ua</shortcut>
171 <shortopt>c</shortopt>
172 <doc>upgrade packages from a specific channel</doc>
176 <shortopt>n</shortopt>
177 <doc>ignore dependencies, upgrade anyway</doc>
180 <shortopt>r</shortopt>
181 <doc>do not install files, only register the package as upgraded</doc>
184 <shortopt>B</shortopt>
185 <doc>don't build C extensions</doc>
188 <shortopt>Z</shortopt>
189 <doc>request uncompressed files when downloading</doc>
192 <shortopt>R</shortopt>
193 <doc>root directory used when installing files (ala PHP's INSTALL_ROOT), use packagingroot for RPM</doc>
197 <shortopt></shortopt>
198 <doc>force install even if there were errors</doc>
201 <shortopt></shortopt>
202 <doc>do not check for recommended dependency version</doc>
206 WARNING: This function is deprecated in favor of using the upgrade command with no params
208 Upgrades all packages that have a newer release available. Upgrades are
209 done only if there is a release available of the state specified in
210 "preferred_state" (currently {config preferred_state}), or a state considered
215 <summary>Un-install Package</summary>
216 <function>doUninstall</function>
217 <shortcut>un</shortcut>
220 <shortopt>n</shortopt>
221 <doc>ignore dependencies, uninstall anyway</doc>
224 <shortopt>r</shortopt>
225 <doc>do not remove files, only register the packages as not installed</doc>
228 <shortopt>R</shortopt>
229 <doc>root directory used when installing files (ala PHP's INSTALL_ROOT)</doc>
233 <shortopt></shortopt>
234 <doc>force install even if there were errors</doc>
237 <shortopt>O</shortopt>
238 <doc>do not attempt to uninstall remotely</doc>
241 <doc>[channel/]<package> ...
242 Uninstalls one or more PEAR packages. More than one package may be
243 specified at once. Prefix with channel name to uninstall from a
244 channel not in your default channel ({config default_channel})
248 <summary>Unpacks a Pecl Package</summary>
249 <function>doBundle</function>
250 <shortcut>bun</shortcut>
253 <shortopt>d</shortopt>
254 <doc>Optional destination directory for unpacking (defaults to current path or "ext" if exists)</doc>
258 <shortopt>f</shortopt>
259 <doc>Force the unpacking even if there were errors in the package</doc>
263 Unpacks a Pecl Package into the selected location. It will download the
268 <summary>Run Post-Install Scripts bundled with a package</summary>
269 <function>doRunScripts</function>
270 <shortcut>rs</shortcut>
273 Run post-installation scripts in package <package>, if any exist.