| 94 |
jpm |
1 |
<commands version="1.0">
|
|
|
2 |
<list-channels>
|
|
|
3 |
<summary>List Available Channels</summary>
|
|
|
4 |
<function>doList</function>
|
|
|
5 |
<shortcut>lc</shortcut>
|
|
|
6 |
<options />
|
|
|
7 |
<doc>
|
|
|
8 |
List all available channels for installation.
|
|
|
9 |
</doc>
|
|
|
10 |
</list-channels>
|
|
|
11 |
<update-channels>
|
|
|
12 |
<summary>Update the Channel List</summary>
|
|
|
13 |
<function>doUpdateAll</function>
|
|
|
14 |
<shortcut>uc</shortcut>
|
|
|
15 |
<options />
|
|
|
16 |
<doc>
|
|
|
17 |
List all installed packages in all channels.
|
|
|
18 |
</doc>
|
|
|
19 |
</update-channels>
|
|
|
20 |
<channel-delete>
|
|
|
21 |
<summary>Remove a Channel From the List</summary>
|
|
|
22 |
<function>doDelete</function>
|
|
|
23 |
<shortcut>cde</shortcut>
|
|
|
24 |
<options />
|
|
|
25 |
<doc><channel name>
|
|
|
26 |
Delete a channel from the registry. You may not
|
|
|
27 |
remove any channel that has installed packages.
|
|
|
28 |
</doc>
|
|
|
29 |
</channel-delete>
|
|
|
30 |
<channel-add>
|
|
|
31 |
<summary>Add a Channel</summary>
|
|
|
32 |
<function>doAdd</function>
|
|
|
33 |
<shortcut>ca</shortcut>
|
|
|
34 |
<options />
|
|
|
35 |
<doc><channel.xml>
|
|
|
36 |
Add a private channel to the channel list. Note that all
|
|
|
37 |
public channels should be synced using "update-channels".
|
|
|
38 |
Parameter may be either a local file or remote URL to a
|
|
|
39 |
channel.xml.
|
|
|
40 |
</doc>
|
|
|
41 |
</channel-add>
|
|
|
42 |
<channel-update>
|
|
|
43 |
<summary>Update an Existing Channel</summary>
|
|
|
44 |
<function>doUpdate</function>
|
|
|
45 |
<shortcut>cu</shortcut>
|
|
|
46 |
<options>
|
|
|
47 |
<force>
|
|
|
48 |
<shortopt>f</shortopt>
|
|
|
49 |
<doc>will force download of new channel.xml if an existing channel name is used</doc>
|
|
|
50 |
</force>
|
|
|
51 |
<channel>
|
|
|
52 |
<shortopt>c</shortopt>
|
| 187 |
mathias |
53 |
<doc>will force download of new channel.xml if an existing channel name is used</doc>
|
| 94 |
jpm |
54 |
<arg>CHANNEL</arg>
|
|
|
55 |
</channel>
|
|
|
56 |
</options>
|
|
|
57 |
<doc>[<channel.xml>|<channel name>]
|
|
|
58 |
Update a channel in the channel list directly. Note that all
|
|
|
59 |
public channels can be synced using "update-channels".
|
|
|
60 |
Parameter may be a local or remote channel.xml, or the name of
|
|
|
61 |
an existing channel.
|
|
|
62 |
</doc>
|
|
|
63 |
</channel-update>
|
|
|
64 |
<channel-info>
|
|
|
65 |
<summary>Retrieve Information on a Channel</summary>
|
|
|
66 |
<function>doInfo</function>
|
|
|
67 |
<shortcut>ci</shortcut>
|
|
|
68 |
<options />
|
|
|
69 |
<doc><package>
|
|
|
70 |
List the files in an installed package.
|
|
|
71 |
</doc>
|
|
|
72 |
</channel-info>
|
|
|
73 |
<channel-alias>
|
|
|
74 |
<summary>Specify an alias to a channel name</summary>
|
|
|
75 |
<function>doAlias</function>
|
|
|
76 |
<shortcut>cha</shortcut>
|
|
|
77 |
<options />
|
|
|
78 |
<doc><channel> <alias>
|
|
|
79 |
Specify a specific alias to use for a channel name.
|
|
|
80 |
The alias may not be an existing channel name or
|
|
|
81 |
alias.
|
|
|
82 |
</doc>
|
|
|
83 |
</channel-alias>
|
|
|
84 |
<channel-discover>
|
|
|
85 |
<summary>Initialize a Channel from its server</summary>
|
|
|
86 |
<function>doDiscover</function>
|
|
|
87 |
<shortcut>di</shortcut>
|
|
|
88 |
<options />
|
|
|
89 |
<doc>[<channel.xml>|<channel name>]
|
| 187 |
mathias |
90 |
Initialize a channel from its server and create a local channel.xml.
|
|
|
91 |
If <channel name> is in the format "<username>:<password>@<channel>" then
|
|
|
92 |
<username> and <password> will be set as the login username/password for
|
|
|
93 |
<channel>. Use caution when passing the username/password in this way, as
|
|
|
94 |
it may allow other users on your computer to briefly view your username/
|
|
|
95 |
password via the system's process list.
|
| 94 |
jpm |
96 |
</doc>
|
|
|
97 |
</channel-discover>
|
| 187 |
mathias |
98 |
<channel-login>
|
|
|
99 |
<summary>Connects and authenticates to remote channel server</summary>
|
|
|
100 |
<function>doLogin</function>
|
|
|
101 |
<shortcut>cli</shortcut>
|
|
|
102 |
<options />
|
|
|
103 |
<doc><channel name>
|
|
|
104 |
Log in to a remote channel server. If <channel name> is not supplied,
|
|
|
105 |
the default channel is used. To use remote functions in the installer
|
|
|
106 |
that require any kind of privileges, you need to log in first. The
|
|
|
107 |
username and password you enter here will be stored in your per-user
|
|
|
108 |
PEAR configuration (~/.pearrc on Unix-like systems). After logging
|
|
|
109 |
in, your username and password will be sent along in subsequent
|
|
|
110 |
operations on the remote server.</doc>
|
|
|
111 |
</channel-login>
|
|
|
112 |
<channel-logout>
|
|
|
113 |
<summary>Logs out from the remote channel server</summary>
|
|
|
114 |
<function>doLogout</function>
|
|
|
115 |
<shortcut>clo</shortcut>
|
|
|
116 |
<options />
|
|
|
117 |
<doc><channel name>
|
|
|
118 |
Logs out from a remote channel server. If <channel name> is not supplied,
|
|
|
119 |
the default channel is used. This command does not actually connect to the
|
|
|
120 |
remote server, it only deletes the stored username and password from your user
|
|
|
121 |
configuration.</doc>
|
|
|
122 |
</channel-logout>
|
|
|
123 |
</commands>
|