summaryrefslogtreecommitdiff
path: root/client/pkcon.xml
blob: 50b2ed595c33a17f02cfde65b616c0b2b65ac0f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
<?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 http://www.packagekit.org.
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
    </para>
  </refsect1>
</refentry>