370 lines
14 KiB
XML
370 lines
14 KiB
XML
<?xml version='1.0' encoding='ISO-8859-1'?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
|
|
|
<!-- Process this file with docbook-to-man to generate an nroff manual
|
|
page: `docbook-to-man manpage.xml > manpage.1'. You may view
|
|
the manual page with: `docbook-to-man manpage.xml | nroff -man |
|
|
less'. A typical entry in a Makefile or Makefile.am is:
|
|
|
|
manpage.1: manpage.xml
|
|
docbook-to-man $< > $@
|
|
|
|
The docbook-to-man binary is found in the docbook-to-man package.
|
|
Please remember that if you create the nroff version in one of the
|
|
debian/rules file targets (such as build), you will need to include
|
|
docbook-to-man in your Build-Depends control field.
|
|
-->
|
|
|
|
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
|
allowed: see man(7), man(1). -->
|
|
<!ENTITY package "pkcon">
|
|
<!ENTITY gnu "<acronym>GNU</acronym>">
|
|
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
|
|
]>
|
|
|
|
<refentry>
|
|
<refentryinfo>
|
|
<title>pkcon</title>
|
|
<productname>PackageKit</productname>
|
|
<address>
|
|
<email>richard@hughsie.com</email>;
|
|
</address>
|
|
<author>
|
|
<firstname>Richard</firstname>
|
|
<surname>Hughes</surname>
|
|
</author>
|
|
<copyright>
|
|
<year>2007 - 2013</year>
|
|
<holder>Richard Hughes</holder>
|
|
</copyright>
|
|
<date>July 29, 2013</date>
|
|
</refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>pkcon</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>&package;</refname>
|
|
<refpurpose>PackageKit console client</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>&package;</command>
|
|
<arg choice="opt" rep="repeat"><option>OPTION</option></arg>
|
|
<arg><option choice="req">COMMAND</option></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>
|
|
This manual page documents briefly the <command>&package;</command> command.
|
|
</para>
|
|
<para>
|
|
<command>&package;</command> is the command line client for PackageKit.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Commands</title>
|
|
<para>&package; knows about the following commands. Depending on the
|
|
backend in use, not all of them may be available.</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>backend-details</term>
|
|
<listitem><para>Print information about the PackageKit backend in use.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-roles</term>
|
|
<listitem><para>List the roles that a transaction can have.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-groups</term>
|
|
<listitem><para>List the available package groups.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-filters</term>
|
|
<listitem><para>List the available filters.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-transactions</term>
|
|
<listitem><para>List known transactions.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-time <replaceable>ROLE</replaceable></term>
|
|
<listitem><para>Print the time that has passed since the last
|
|
transaction with the given role.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>search [name|details|group|file] <replaceable>DATA</replaceable></term>
|
|
<listitem><para>Search for a package matching the given data.
|
|
The search is performed in the package information that is
|
|
indicated by the first argument: name, details, group or
|
|
files.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>install <replaceable>PACKAGES</replaceable></term>
|
|
<listitem><para>Install the given packages from repositories.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>install-local <replaceable>FILES</replaceable></term>
|
|
<listitem><para>Install the given packages from the local filesystem.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>download <replaceable>DIRECTORY</replaceable> <replaceable>PACKAGES</replaceable></term>
|
|
<listitem><para>Download the given packages from repositories, and
|
|
store them in the given directory.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>install-sig <replaceable>TYPE</replaceable> <replaceable>KEY_ID</replaceable> <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>Install a package signature. Only GPG signatures are supported at this time.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>remove <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>Remove the given package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>update [<replaceable>PACKAGES</replaceable>]</term>
|
|
<listitem><para>Update the system by installing available updates. If
|
|
a list of packages is specified, only install updates for these packages.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>refresh [force]</term>
|
|
<listitem><para>Refresh the cached information about available updates.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>resolve <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>Resolve the given package name and print information
|
|
about installed or available packages and updates.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>upgrade-system <replaceable>DISTRIBUTION</replaceable> [minimal|default|complete]</term>
|
|
<listitem><para>Upgrade the system to the given distribution.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-updates</term>
|
|
<listitem><para>List available updates.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-distro-upgrades</term>
|
|
<listitem><para>List available distribution upgrades.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>depends-on <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>List dependencies fo the given package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>required-by <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>List packages that require the given package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-details <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>Print details about the available or installed
|
|
package with the given name.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-details-local <replaceable>FILE</replaceable></term>
|
|
<listitem><para>Print details about the local package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-files <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>List the files contained in the given package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-files-local <replaceable>FILE</replaceable></term>
|
|
<listitem><para>List the files contained in the local package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-update-detail <replaceable>PACKAGE</replaceable></term>
|
|
<listitem><para>Print the package changelog for the given package.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-packages</term>
|
|
<listitem><para>List all available and installed packages.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repo-list</term>
|
|
<listitem><para>List all configured package repositories.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repo-enable <replaceable>REPOSITORY</replaceable></term>
|
|
<listitem><para>Enable the given repository.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repo-disable <replaceable>REPOSITORY</replaceable></term>
|
|
<listitem><para>Disable the given repository.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repo-set-data <replaceable>REPOSITORY</replaceable> <replaceable>PARAMETER</replaceable> <replaceable>DATA</replaceable></term>
|
|
<listitem><para>Set the given parameter to the given value for the repository.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repo-remove <replaceable>REPOSITORY</replaceable> <replaceable>PARAMETER</replaceable> </term>
|
|
<listitem><para>Removes the repository and optionally any packages installed from it.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>what-provides <replaceable>STRING</replaceable></term>
|
|
<listitem><para>List packages that provide the given string.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>accept-eula <replaceable>EULA_ID</replaceable></term>
|
|
<listitem><para>Accept the EULA with the given id.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>get-categories</term>
|
|
<listitem><para>List available categories.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>repair</term>
|
|
<listitem><para>Attempt to repair the system package database.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>offline-get-prepared</term>
|
|
<listitem><para>Print information about the prepared offline update.
|
|
If no offline update is prepared, exit with an exit code of 1.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>offline-trigger</term>
|
|
<listitem><para>Trigger an offline update.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>offline-status</term>
|
|
<listitem><para>Print information about the result of the last
|
|
offline update.</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Options</title>
|
|
<para>The following options can be used to influence the behavior
|
|
of <command>&package;</command>.</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>--version</term>
|
|
<listitem><para>Print the program version and exit.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-h, --help</term>
|
|
<listitem><para>Show help options.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--help-all</term>
|
|
<listitem><para>Show all help options.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--filter <replaceable>FILTER</replaceable></term>
|
|
<listitem><para>Set the filter to use.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-y, --noninteractive</term>
|
|
<listitem><para>Install packages without asking for confirmation.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--only-download</term>
|
|
<listitem><para>Prepare the transaction by downloading packages only.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-n, --background</term>
|
|
<listitem><para>Run the command using idle network bandwidth and also using less power.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-p, --plain</term>
|
|
<listitem><para>Print to screen a machine-readable output, rather than using animated widgets.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-v, --verbose</term>
|
|
<listitem><para>Show debugging information.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>-c, --cache-age <replaceable>AGE</replaceable></term>
|
|
<listitem><para>Set the maximum acceptable age for cached metadata, in seconds. Use -1 for 'never'.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--allow-untrusted</term>
|
|
<listitem><para>Allow untrusted packages to be installed.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--allow-downgrade</term>
|
|
<listitem><para>Allow packages to be downgraded during transaction.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--allow-reinstall</term>
|
|
<listitem><para>Allow packages to be reinstalled during transaction.</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Return values</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<option>0</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Success</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>1</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Failed with miscellaneous internal error.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>3</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Failed with syntax error, or failed to parse command.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>4</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Failed as a file or directory was not found.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>5</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Nothing useful was done.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>6</option>
|
|
</term>
|
|
<listitem>
|
|
<para>The initial setup failed, e.g. setting the network proxy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<option>7</option>
|
|
</term>
|
|
<listitem>
|
|
<para>The transaction failed, see the detailed error for more information.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>pkmon (1).</para>
|
|
<para>
|
|
The programs are documented fully on https://www.freedesktop.org/software/PackageKit.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>AUTHOR</title>
|
|
<para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|