94 |
jpm |
1 |
<commands version="1.0">
|
|
|
2 |
<install>
|
|
|
3 |
<summary>Install Package</summary>
|
|
|
4 |
<function>doInstall</function>
|
|
|
5 |
<shortcut>i</shortcut>
|
|
|
6 |
<options>
|
|
|
7 |
<force>
|
|
|
8 |
<shortopt>f</shortopt>
|
|
|
9 |
<doc>will overwrite newer installed packages</doc>
|
|
|
10 |
</force>
|
|
|
11 |
<loose>
|
|
|
12 |
<shortopt>l</shortopt>
|
|
|
13 |
<doc>do not check for recommended dependency version</doc>
|
|
|
14 |
</loose>
|
|
|
15 |
<nodeps>
|
|
|
16 |
<shortopt>n</shortopt>
|
|
|
17 |
<doc>ignore dependencies, install anyway</doc>
|
|
|
18 |
</nodeps>
|
|
|
19 |
<register-only>
|
|
|
20 |
<shortopt>r</shortopt>
|
|
|
21 |
<doc>do not install files, only register the package as installed</doc>
|
|
|
22 |
</register-only>
|
|
|
23 |
<soft>
|
|
|
24 |
<shortopt>s</shortopt>
|
|
|
25 |
<doc>soft install, fail silently, or upgrade if already installed</doc>
|
|
|
26 |
</soft>
|
|
|
27 |
<nobuild>
|
|
|
28 |
<shortopt>B</shortopt>
|
187 |
mathias |
29 |
<doc>don't build C extensions</doc>
|
94 |
jpm |
30 |
</nobuild>
|
|
|
31 |
<nocompress>
|
|
|
32 |
<shortopt>Z</shortopt>
|
|
|
33 |
<doc>request uncompressed files when downloading</doc>
|
|
|
34 |
</nocompress>
|
|
|
35 |
<installroot>
|
|
|
36 |
<shortopt>R</shortopt>
|
187 |
mathias |
37 |
<doc>root directory used when installing files (ala PHP's INSTALL_ROOT), use packagingroot for RPM</doc>
|
94 |
jpm |
38 |
<arg>DIR</arg>
|
|
|
39 |
</installroot>
|
187 |
mathias |
40 |
<packagingroot>
|
|
|
41 |
<shortopt>P</shortopt>
|
|
|
42 |
<doc>root directory used when packaging files, like RPM packaging</doc>
|
|
|
43 |
<arg>DIR</arg>
|
|
|
44 |
</packagingroot>
|
94 |
jpm |
45 |
<ignore-errors>
|
187 |
mathias |
46 |
<shortopt></shortopt>
|
94 |
jpm |
47 |
<doc>force install even if there were errors</doc>
|
|
|
48 |
</ignore-errors>
|
|
|
49 |
<alldeps>
|
|
|
50 |
<shortopt>a</shortopt>
|
|
|
51 |
<doc>install all required and optional dependencies</doc>
|
|
|
52 |
</alldeps>
|
|
|
53 |
<onlyreqdeps>
|
|
|
54 |
<shortopt>o</shortopt>
|
|
|
55 |
<doc>install all required dependencies</doc>
|
|
|
56 |
</onlyreqdeps>
|
|
|
57 |
<offline>
|
|
|
58 |
<shortopt>O</shortopt>
|
|
|
59 |
<doc>do not attempt to download any urls or contact channels</doc>
|
|
|
60 |
</offline>
|
|
|
61 |
<pretend>
|
|
|
62 |
<shortopt>p</shortopt>
|
|
|
63 |
<doc>Only list the packages that would be downloaded</doc>
|
|
|
64 |
</pretend>
|
|
|
65 |
</options>
|
|
|
66 |
<doc>[channel/]<package> ...
|
|
|
67 |
Installs one or more PEAR packages. You can specify a package to
|
|
|
68 |
install in four ways:
|
|
|
69 |
|
|
|
70 |
"Package-1.0.tgz" : installs from a local file
|
|
|
71 |
|
|
|
72 |
"http://example.com/Package-1.0.tgz" : installs from
|
|
|
73 |
anywhere on the net.
|
|
|
74 |
|
|
|
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.
|
|
|
78 |
|
187 |
mathias |
79 |
"Package[-version/state][.tar]" : queries your default channel's server
|
94 |
jpm |
80 |
({config master_server}) and downloads the newest package with
|
|
|
81 |
the preferred quality/state ({config preferred_state}).
|
|
|
82 |
|
|
|
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)
|
|
|
86 |
|
|
|
87 |
To download a package from another channel, prefix with the channel name like
|
|
|
88 |
"channel/Package"
|
|
|
89 |
|
|
|
90 |
More than one package may be specified at once. It is ok to mix these
|
|
|
91 |
four ways of specifying packages.
|
|
|
92 |
</doc>
|
|
|
93 |
</install>
|
|
|
94 |
<upgrade>
|
|
|
95 |
<summary>Upgrade Package</summary>
|
|
|
96 |
<function>doInstall</function>
|
|
|
97 |
<shortcut>up</shortcut>
|
|
|
98 |
<options>
|
187 |
mathias |
99 |
<channel>
|
|
|
100 |
<shortopt>c</shortopt>
|
|
|
101 |
<doc>upgrade packages from a specific channel</doc>
|
|
|
102 |
<arg>CHAN</arg>
|
|
|
103 |
</channel>
|
94 |
jpm |
104 |
<force>
|
|
|
105 |
<shortopt>f</shortopt>
|
|
|
106 |
<doc>overwrite newer installed packages</doc>
|
|
|
107 |
</force>
|
|
|
108 |
<loose>
|
|
|
109 |
<shortopt>l</shortopt>
|
|
|
110 |
<doc>do not check for recommended dependency version</doc>
|
|
|
111 |
</loose>
|
|
|
112 |
<nodeps>
|
|
|
113 |
<shortopt>n</shortopt>
|
|
|
114 |
<doc>ignore dependencies, upgrade anyway</doc>
|
|
|
115 |
</nodeps>
|
|
|
116 |
<register-only>
|
|
|
117 |
<shortopt>r</shortopt>
|
|
|
118 |
<doc>do not install files, only register the package as upgraded</doc>
|
|
|
119 |
</register-only>
|
|
|
120 |
<nobuild>
|
|
|
121 |
<shortopt>B</shortopt>
|
187 |
mathias |
122 |
<doc>don't build C extensions</doc>
|
94 |
jpm |
123 |
</nobuild>
|
|
|
124 |
<nocompress>
|
|
|
125 |
<shortopt>Z</shortopt>
|
|
|
126 |
<doc>request uncompressed files when downloading</doc>
|
|
|
127 |
</nocompress>
|
|
|
128 |
<installroot>
|
|
|
129 |
<shortopt>R</shortopt>
|
187 |
mathias |
130 |
<doc>root directory used when installing files (ala PHP's INSTALL_ROOT)</doc>
|
94 |
jpm |
131 |
<arg>DIR</arg>
|
|
|
132 |
</installroot>
|
|
|
133 |
<ignore-errors>
|
187 |
mathias |
134 |
<shortopt></shortopt>
|
94 |
jpm |
135 |
<doc>force install even if there were errors</doc>
|
|
|
136 |
</ignore-errors>
|
|
|
137 |
<alldeps>
|
|
|
138 |
<shortopt>a</shortopt>
|
|
|
139 |
<doc>install all required and optional dependencies</doc>
|
|
|
140 |
</alldeps>
|
|
|
141 |
<onlyreqdeps>
|
|
|
142 |
<shortopt>o</shortopt>
|
|
|
143 |
<doc>install all required dependencies</doc>
|
|
|
144 |
</onlyreqdeps>
|
|
|
145 |
<offline>
|
|
|
146 |
<shortopt>O</shortopt>
|
|
|
147 |
<doc>do not attempt to download any urls or contact channels</doc>
|
|
|
148 |
</offline>
|
|
|
149 |
<pretend>
|
|
|
150 |
<shortopt>p</shortopt>
|
|
|
151 |
<doc>Only list the packages that would be downloaded</doc>
|
|
|
152 |
</pretend>
|
|
|
153 |
</options>
|
|
|
154 |
<doc><package> ...
|
|
|
155 |
Upgrades one or more PEAR packages. See documentation for the
|
|
|
156 |
"install" command for ways to specify a package.
|
|
|
157 |
|
|
|
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
|
|
|
160 |
upgrade anyway).
|
|
|
161 |
|
|
|
162 |
More than one package may be specified at once.
|
|
|
163 |
</doc>
|
|
|
164 |
</upgrade>
|
|
|
165 |
<upgrade-all>
|
187 |
mathias |
166 |
<summary>Upgrade All Packages [Deprecated in favor of calling upgrade with no parameters]</summary>
|
|
|
167 |
<function>doUpgradeAll</function>
|
94 |
jpm |
168 |
<shortcut>ua</shortcut>
|
|
|
169 |
<options>
|
187 |
mathias |
170 |
<channel>
|
|
|
171 |
<shortopt>c</shortopt>
|
|
|
172 |
<doc>upgrade packages from a specific channel</doc>
|
|
|
173 |
<arg>CHAN</arg>
|
|
|
174 |
</channel>
|
94 |
jpm |
175 |
<nodeps>
|
|
|
176 |
<shortopt>n</shortopt>
|
|
|
177 |
<doc>ignore dependencies, upgrade anyway</doc>
|
|
|
178 |
</nodeps>
|
|
|
179 |
<register-only>
|
|
|
180 |
<shortopt>r</shortopt>
|
|
|
181 |
<doc>do not install files, only register the package as upgraded</doc>
|
|
|
182 |
</register-only>
|
|
|
183 |
<nobuild>
|
|
|
184 |
<shortopt>B</shortopt>
|
187 |
mathias |
185 |
<doc>don't build C extensions</doc>
|
94 |
jpm |
186 |
</nobuild>
|
|
|
187 |
<nocompress>
|
|
|
188 |
<shortopt>Z</shortopt>
|
|
|
189 |
<doc>request uncompressed files when downloading</doc>
|
|
|
190 |
</nocompress>
|
|
|
191 |
<installroot>
|
|
|
192 |
<shortopt>R</shortopt>
|
187 |
mathias |
193 |
<doc>root directory used when installing files (ala PHP's INSTALL_ROOT), use packagingroot for RPM</doc>
|
94 |
jpm |
194 |
<arg>DIR</arg>
|
|
|
195 |
</installroot>
|
|
|
196 |
<ignore-errors>
|
187 |
mathias |
197 |
<shortopt></shortopt>
|
94 |
jpm |
198 |
<doc>force install even if there were errors</doc>
|
|
|
199 |
</ignore-errors>
|
|
|
200 |
<loose>
|
187 |
mathias |
201 |
<shortopt></shortopt>
|
94 |
jpm |
202 |
<doc>do not check for recommended dependency version</doc>
|
|
|
203 |
</loose>
|
|
|
204 |
</options>
|
|
|
205 |
<doc>
|
187 |
mathias |
206 |
WARNING: This function is deprecated in favor of using the upgrade command with no params
|
|
|
207 |
|
94 |
jpm |
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
|
|
|
211 |
more stable.
|
|
|
212 |
</doc>
|
|
|
213 |
</upgrade-all>
|
|
|
214 |
<uninstall>
|
|
|
215 |
<summary>Un-install Package</summary>
|
|
|
216 |
<function>doUninstall</function>
|
|
|
217 |
<shortcut>un</shortcut>
|
|
|
218 |
<options>
|
|
|
219 |
<nodeps>
|
|
|
220 |
<shortopt>n</shortopt>
|
|
|
221 |
<doc>ignore dependencies, uninstall anyway</doc>
|
|
|
222 |
</nodeps>
|
|
|
223 |
<register-only>
|
|
|
224 |
<shortopt>r</shortopt>
|
|
|
225 |
<doc>do not remove files, only register the packages as not installed</doc>
|
|
|
226 |
</register-only>
|
|
|
227 |
<installroot>
|
|
|
228 |
<shortopt>R</shortopt>
|
187 |
mathias |
229 |
<doc>root directory used when installing files (ala PHP's INSTALL_ROOT)</doc>
|
94 |
jpm |
230 |
<arg>DIR</arg>
|
|
|
231 |
</installroot>
|
|
|
232 |
<ignore-errors>
|
187 |
mathias |
233 |
<shortopt></shortopt>
|
94 |
jpm |
234 |
<doc>force install even if there were errors</doc>
|
|
|
235 |
</ignore-errors>
|
|
|
236 |
<offline>
|
|
|
237 |
<shortopt>O</shortopt>
|
|
|
238 |
<doc>do not attempt to uninstall remotely</doc>
|
|
|
239 |
</offline>
|
|
|
240 |
</options>
|
|
|
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})
|
|
|
245 |
</doc>
|
|
|
246 |
</uninstall>
|
|
|
247 |
<bundle>
|
|
|
248 |
<summary>Unpacks a Pecl Package</summary>
|
|
|
249 |
<function>doBundle</function>
|
|
|
250 |
<shortcut>bun</shortcut>
|
|
|
251 |
<options>
|
|
|
252 |
<destination>
|
|
|
253 |
<shortopt>d</shortopt>
|
187 |
mathias |
254 |
<doc>Optional destination directory for unpacking (defaults to current path or "ext" if exists)</doc>
|
94 |
jpm |
255 |
<arg>DIR</arg>
|
|
|
256 |
</destination>
|
|
|
257 |
<force>
|
|
|
258 |
<shortopt>f</shortopt>
|
|
|
259 |
<doc>Force the unpacking even if there were errors in the package</doc>
|
|
|
260 |
</force>
|
|
|
261 |
</options>
|
|
|
262 |
<doc><package>
|
|
|
263 |
Unpacks a Pecl Package into the selected location. It will download the
|
|
|
264 |
package if needed.
|
|
|
265 |
</doc>
|
|
|
266 |
</bundle>
|
|
|
267 |
<run-scripts>
|
|
|
268 |
<summary>Run Post-Install Scripts bundled with a package</summary>
|
|
|
269 |
<function>doRunScripts</function>
|
|
|
270 |
<shortcut>rs</shortcut>
|
|
|
271 |
<options />
|
|
|
272 |
<doc><package>
|
|
|
273 |
Run post-installation scripts in package <package>, if any exist.
|
|
|
274 |
</doc>
|
|
|
275 |
</run-scripts>
|
|
|
276 |
</commands>
|