Subversion Repositories Applications.gtt

Rev

Rev 94 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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