123 lines
4.1 KiB
XML
123 lines
4.1 KiB
XML
<commands version="1.0">
|
|
<list-channels>
|
|
<summary>List Available Channels</summary>
|
|
<function>doList</function>
|
|
<shortcut>lc</shortcut>
|
|
<options />
|
|
<doc>
|
|
List all available channels for installation.
|
|
</doc>
|
|
</list-channels>
|
|
<update-channels>
|
|
<summary>Update the Channel List</summary>
|
|
<function>doUpdateAll</function>
|
|
<shortcut>uc</shortcut>
|
|
<options />
|
|
<doc>
|
|
List all installed packages in all channels.
|
|
</doc>
|
|
</update-channels>
|
|
<channel-delete>
|
|
<summary>Remove a Channel From the List</summary>
|
|
<function>doDelete</function>
|
|
<shortcut>cde</shortcut>
|
|
<options />
|
|
<doc><channel name>
|
|
Delete a channel from the registry. You may not
|
|
remove any channel that has installed packages.
|
|
</doc>
|
|
</channel-delete>
|
|
<channel-add>
|
|
<summary>Add a Channel</summary>
|
|
<function>doAdd</function>
|
|
<shortcut>ca</shortcut>
|
|
<options />
|
|
<doc><channel.xml>
|
|
Add a private channel to the channel list. Note that all
|
|
public channels should be synced using "update-channels".
|
|
Parameter may be either a local file or remote URL to a
|
|
channel.xml.
|
|
</doc>
|
|
</channel-add>
|
|
<channel-update>
|
|
<summary>Update an Existing Channel</summary>
|
|
<function>doUpdate</function>
|
|
<shortcut>cu</shortcut>
|
|
<options>
|
|
<force>
|
|
<shortopt>f</shortopt>
|
|
<doc>will force download of new channel.xml if an existing channel name is used</doc>
|
|
</force>
|
|
<channel>
|
|
<shortopt>c</shortopt>
|
|
<doc>will force download of new channel.xml if an existing channel name is used</doc>
|
|
<arg>CHANNEL</arg>
|
|
</channel>
|
|
</options>
|
|
<doc>[<channel.xml>|<channel name>]
|
|
Update a channel in the channel list directly. Note that all
|
|
public channels can be synced using "update-channels".
|
|
Parameter may be a local or remote channel.xml, or the name of
|
|
an existing channel.
|
|
</doc>
|
|
</channel-update>
|
|
<channel-info>
|
|
<summary>Retrieve Information on a Channel</summary>
|
|
<function>doInfo</function>
|
|
<shortcut>ci</shortcut>
|
|
<options />
|
|
<doc><package>
|
|
List the files in an installed package.
|
|
</doc>
|
|
</channel-info>
|
|
<channel-alias>
|
|
<summary>Specify an alias to a channel name</summary>
|
|
<function>doAlias</function>
|
|
<shortcut>cha</shortcut>
|
|
<options />
|
|
<doc><channel> <alias>
|
|
Specify a specific alias to use for a channel name.
|
|
The alias may not be an existing channel name or
|
|
alias.
|
|
</doc>
|
|
</channel-alias>
|
|
<channel-discover>
|
|
<summary>Initialize a Channel from its server</summary>
|
|
<function>doDiscover</function>
|
|
<shortcut>di</shortcut>
|
|
<options />
|
|
<doc>[<channel.xml>|<channel name>]
|
|
Initialize a channel from its server and create a local channel.xml.
|
|
If <channel name> is in the format "<username>:<password>@<channel>" then
|
|
<username> and <password> will be set as the login username/password for
|
|
<channel>. Use caution when passing the username/password in this way, as
|
|
it may allow other users on your computer to briefly view your username/
|
|
password via the system's process list.
|
|
</doc>
|
|
</channel-discover>
|
|
<channel-login>
|
|
<summary>Connects and authenticates to remote channel server</summary>
|
|
<function>doLogin</function>
|
|
<shortcut>cli</shortcut>
|
|
<options />
|
|
<doc><channel name>
|
|
Log in to a remote channel server. If <channel name> is not supplied,
|
|
the default channel is used. To use remote functions in the installer
|
|
that require any kind of privileges, you need to log in first. The
|
|
username and password you enter here will be stored in your per-user
|
|
PEAR configuration (~/.pearrc on Unix-like systems). After logging
|
|
in, your username and password will be sent along in subsequent
|
|
operations on the remote server.</doc>
|
|
</channel-login>
|
|
<channel-logout>
|
|
<summary>Logs out from the remote channel server</summary>
|
|
<function>doLogout</function>
|
|
<shortcut>clo</shortcut>
|
|
<options />
|
|
<doc><channel name>
|
|
Logs out from a remote channel server. If <channel name> is not supplied,
|
|
the default channel is used. This command does not actually connect to the
|
|
remote server, it only deletes the stored username and password from your user
|
|
configuration.</doc>
|
|
</channel-logout>
|
|
</commands> |