This file is indexed.

/usr/share/help/C/gnome-packagekit/index.docbook is in gnome-packagekit-data 3.8.2-4ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
    "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY GFDL  SYSTEM "fdl-appendix.xml">
  <!ENTITY app "gnome-packagekit">
  <!ENTITY application "<application>&app;</application>">
  <!ENTITY appversion "2.17.1">
  <!ENTITY manrevision "2.17.1">
]>
<!--
      (Do not remove this comment block.)
  Template Maintained by the GNOME Documentation Project:
          http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->

<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->

  <articleinfo>
    <title>&application; Manual</title>
    <abstract role="description">
      <para>
        &application; is a suite of tools for integration with the GNOME desktop.
      </para>
    </abstract>
    <copyright>
      <year>2008</year>
      <holder>Richard Hughes (richard@hughsie.com)</holder>
    </copyright>

  <!-- translators: uncomment this:

  <copyright>
   <year>2007</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

  -->

<!-- An address can be added to the publisher information.  If a role is
     not specified, the publisher/author is the same for all versions of the
     document.  -->
    <publisher role="maintainer">
      <publishername>Richard Hughes</publishername>
    </publisher>

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and
        other legal stuff such as "NO WARRANTY" statement. Please do not change
        any of this. -->

    <authorgroup>
      <author role="maintainer">
        <firstname>Richard</firstname>
        <surname>Hughes</surname>
        <email>richard@hughsie.com</email>
      </author>
<!-- This is appropriate place for other contributors: translators,
      maintainers,  etc. Commented out by default.
       <othercredit role="translator">
        <firstname>Latin</firstname>
        <surname>Translator 1</surname>
        <affiliation>
          <orgname>Latin Translation Team</orgname>
          <address> <email>translator@gnome.org</email> </address>
        </affiliation>
        <contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>

    <revhistory>
      <revision>
       <revnumber>3.0</revnumber>
        <date>2008-03-31</date>
        <revdescription>
          <para role="author">Rahul Sundaram
            <email>sundaram@fedoraproject.org</email>
          </para>
          <para role="publisher">Rahul Sundaram</para>
        </revdescription>
      </revision>
      <revision>
        <revnumber>2.0</revnumber>
        <date>2007-08-30</date>
        <revdescription>
          <para role="author">Richard Hughes
            <email>richard@hughsie.com</email>
          </para>
          <para role="publisher">Richard Hughes</para>
        </revdescription>
      </revision>
    </revhistory>

    <legalnotice>
      <title>Feedback</title>
      <para>
        To report a bug or make a suggestion regarding the &app; application or
        this manual, follow the directions in the
        <ulink url="http://www.packagekit.org/"
          type="http">&application; Contact Page</ulink>.
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice>
  </articleinfo>

  <indexterm zone="index">
    <primary>&application;</primary>
  </indexterm>
  <indexterm zone="index">
    <primary>gpk-application</primary>
  </indexterm>

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<section id="intro">
  <title>Introduction</title>
  <!-- manrevision 2.0 compatibility -->
  <anchor id="aboutex"/>
  <anchor id="notice"/>
  <indexterm>
    <primary>&application;</primary>
    <secondary>Manual</secondary>
    <tertiary>gpk-application</tertiary>
  </indexterm>

  <para>
    &app; is a suite of tools for the <systemitem>GNOME desktop</systemitem>
  </para>
  <para>
    PackageKit is designed to unify all the software graphical tools used in
    different distributions.
    It abstracts the various underlying package management technologies like
    yum, apt, smart etc. and provides unified graphical and command line frontends.
    It also provides a framework that includes programming interfaces that other
    software applications can take advantage of.
    It is not a replacement for existing package managers like yum.
  </para>
  <para>
    Some of the architectural advantages of PackageKit over other package management solutions are
    that the PackageKit daemon runs as a system process that is not tied to any user session,
    which means that a long-running update or installation will not be interrupted if the user who
    started it logs out.
    Tasks are queued up, meaning that a user can initiate multiple tasks which will be executed one
    by one and also that multiple users can also use PackageKit in parallel without completely
    locking each other out.
    Access to all privileged operations is controlled via
    <ulink url="http://en.wikipedia.org/wiki/PolicyKit">PolicyKit</ulink>.
  </para>
  <figure>
    <title>PolicyKit Permissions UI</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-repo-auth.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>

</section>

<section id="application">
  <title>Applications</title>
  <para>
    <application>packagekitd</application> is started automatically when it is
    needed. <command>pkcon</command> offers a versatile command line interface
    to PackageKit.
  </para>
  <para>
    Below is a list containing the names and a short description of the
    utilities included in the gnome-packagekit pack:
  </para>
  <variablelist>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-application</command>: Add/Remove Software
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-update-viewer</command>: Updating your system.
          Also can view the history of updates.
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-prefs</command>: Configuring software updates preferences
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-repo</command>: Enabling or disabling software repositories
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-log</command>: History of updates including installing,
          removing or updating any software
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-install-file</command>: Installs locally available software packages.
          This also gets run if you double-click on a package in your desktop or within a file manager.
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-update-icon</command>: When PackageKit is installed, it starts the session
          icon automatically when you log in.
          This application displays an icon in the notification area of your panel when software
          updates are available, and is responsible for showing notifications about PackageKit
          operations and events.
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>Command line</term>
      <listitem>
        <para>
          <command>gpk-backend-status</command>: Shows technical status of
          support for the underlying package management backend.
          Only useful for developers.
        </para>
      </listitem>
    </varlistentry>
  </variablelist>
</section>

<section id="add-remove">
  <title>Add/Remove Software</title>
  <para>
    Add/Remove software application accessed via <menuchoice><guimenu>System</guimenu>
    <guisubmenu>Administration</guisubmenu>
    <guimenuitem>Add/Remove Software</guimenuitem></menuchoice>
    allows you to search the software repository easily or browse through the
    different groups like multimedia or office and select software packages to
    install or remove from your system.
    You can find more information about any package such as description and
    dependencies by just clicking on it.
    Before installing a package, you also can visit the home page of the
    software projects easily for getting any additional details.
  </para>
  <figure>
    <title>Searching for a group with filters</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-application-groups.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    Typically, you can find several thousands of software packages under
    different groups available.
    Since this can be overwhelming you can choose to filter the lists of
    software packages based on several criteria such as whether the package is already
    installed, whether it is a development or graphical application and based
    on the software license.
    See <xref linkend="filters"/> for more information about filters.
  </para>
  <para>
    A software source configuration is available in the system menu that
    allows you to enable or disable a existing software repository.
    You can also refresh the application lists for displaying the latest
    information about software packages available in the repository.
  </para>

  <section id="filters">
    <title>Filters</title>
    <para>
      You can limit the amount of software packages that is shown by several criteria.
    </para>
    <para>
      To see only installed or only uninstalled software, choose the
      corresponding menu item in the <menuchoice><guimenu>Filters</guimenu>
      <guisubmenu>Installed</guisubmenu></menuchoice> menu.
    </para>
    <para>
      To see only software containing applications with a graphical user
      interface or only applications with a command line interface, choose a
      filter from the <menuchoice><guimenu>Filters</guimenu>
      <guisubmenu>Graphical</guisubmenu></menuchoice>
      menu.
    </para>
    <note><para>
      Note that PackageKit uses a heuristic to determine if a package is a 'graphical'
      application and can get this wrong when a package has dependencies like gtk2+.
    </para></note>
    <para>
      To see only software that qualify as free software, choose the
      corresponding menu item from the <menuchoice><guimenu>Filters</guimenu>
      <guisubmenu>Free</guisubmenu></menuchoice>
      menu. Currently, PackageKit considers a package to be free software
      if its license is listed as such in the Fedora
      <ulink url="http://fedoraproject.org/wiki/Licensing">Licensing</ulink> page.
    </para>
  </section>

  <section id="searching">
    <title>Searching for software</title>
    <para>
      The search entry and <guibutton>Find</guibutton> button let you search
      for software. The icon inside the entry indicates what kind
      of search is performed. By clicking on it, you can select to search for
      a string that is contained in package name, the package description, or
      search for the name of a file contained in the package.
    </para>
  </section>

</section>

<section id="software-sources">
  <title>Software Sources</title>
  <para>
    The software repository viewer allows you to enable or disable software
    sources - also known as <quote>repositories</quote>. Repositories
    are collections of software that are known to work together and
    are compatible with your operating system. Apart from the repositories for
    the operating system itself, there are third-party repositories offering
    additional software for many Linux distributions - check your
    distribution-specific documentation for more information.
  </para>
  <figure>
    <title>Software Sources UI</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-repo.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    At this time, PackageKit does not offer a way to add new repositories to
    your system. It only allows you to enable or disable known repositories.
    However, it is often possible to make a new repository known to PackageKit
    by installing a package with the necessary information. These are usually
    called (foo)-release, where foo is the name of the repository.
  </para>
</section>

<section id="mime-types">
  <title>File Handler Helper</title>
  <para>
    Sometimes you will not have the software on your system to open a particular
    file. If the file type is not recognized, then applications that can open
    this file type are shown.
  </para>
  <para>
    At this time, only a limited number of results will be shown, as they will
    need to be rebuilt by the distribution to support the extra data needed by
    PackageKit. This will happen automatically, and soon all suitable
    applications will be shown.
  </para>
</section>

<section id="update-viewer">
  <title>Update Viewer</title>
  <para>
    You can update your system via <menuchoice><guimenu>System</guimenu>
    <guisubmenu>Administration</guisubmenu>
    <guimenuitem>Update System</guimenuitem></menuchoice>
    or by selecting <menuchoice><guimenuitem>Show Updates</guimenuitem></menuchoice>
    from the update icon in the notification area.
    When you do this, the update viewer application launches and immediately
    starts checking for updates. Once this check completes, it shows you an
    overview of available updates, grouped by severity. The severities range
    from security updates over important updates to bug fix updates and
    finally enhancements.
  </para>
  <note><para>
    Note that the severity information must be provided by the software
    repositories where the software packages originate. This information may not
    be available for development branches of distributions.
  </para></note>
  <figure>
    <title>Updates overview</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-updates-overview.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    Below the summary of available updates, the update viewer gives and
    indication how long ago the last check (or <quote>refresh</quote>)
    for new updates happened, and when updates where last installed.
  </para>
  <para>
    You can choose to manually refresh and verify the presence of
    updates by clicking the <guibutton>Refresh</guibutton> button.
  </para>
  <tip><para>
    You can change how often PackageKit refreshes on its own in
    the <link linkend="prefs">Software Update Preferences</link>.
  </para></tip>
  <para>
    There is a option to view the history of updates including
    previous installations, removal or updates of software.
  </para>
  <para>
    Use the <guibutton>Update System</guibutton> button to install
    all available updates or use the <guibutton>Review</guibutton>
    button to review and select individual updates.
    If you do not want to install updates at this time, you can just
    close the window.
  </para>

  <section id="update-viewer-details">
    <title>Detailed information about updates</title>
    <para>
      The <guibutton>Review</guibutton> button brings up a listing
      of the individual updates that are available. The area below
      the list displays detailed information about the selected update.
      The information may include references to bugs and vulnerability
      reports that are fixed by the update.
    </para>
    <note><para>
      Note that the detailed update information must be provided by the
      software repositories where the software packages originate. This information
      may not be available for development branches of distributions.
    </para></note>
    <para>
      The checkboxes next to each package in the list allow to select
      individual updates for installation. Use the <guibutton>Apply
      Updates</guibutton> button to install only the selected updates.
      If you do not want to install updates at this time, you can just
      close the window.
    </para>
    <figure>
      <title>Update viewer tool</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-updates.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <note><para>
      You can uncheck all the updates quickly by right clicking on the list and
      selecting the menu item <guibutton>Unselect all</guibutton>.
    </para></note>
  </section>
</section>

<section id="prefs">
  <title>Software Updates Preferences</title>
  <figure>
    <title>Preferences tool</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-prefs.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    Preferences can be configured via <menuchoice><guimenu>System</guimenu>
    <guisubmenu>Preferences</guisubmenu><guisubmenu>System</guisubmenu>
    <guimenuitem>Software Updates</guimenuitem></menuchoice>.
    You can configure it to check for updates on a daily, hourly or weekly
    basis or never. Note that these frequencies are only approximate, and
    checks for updates can be triggered by other events, such as the screen
    being unlocked, network becoming available, or another user checking for
    updates. The default setting is to check for updates daily.
    You can also configure it to automatically install all updates or just the
    ones that fix security issues.
    These settings are per-user and effective only for the current user logged
    in the system.
 </para>
</section>

<section id="software-log">
  <title>Software Log Viewer</title>
  <figure>
    <title>Log viewer</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-log.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    This tool can be opened using <menuchoice><guimenu>Applications</guimenu>
    <guisubmenu>System Tools</guisubmenu>
    <guimenuitem>Software Log Viewer</guimenuitem></menuchoice>.
  </para>
  <para>
    The log viewer can be used to find out what updates were downloaded and
    installed.
    The filter will match on the package name, version or architecture.
  </para>
</section>

<section id="service-pack">
  <title>Service Pack Creator</title>
  <figure>
    <title>Service pack creator</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-service-pack.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    This tool can be opened using <menuchoice><guimenu>Applications</guimenu>
    <guisubmenu>System Tools</guisubmenu>
    <guimenuitem>Service Pack Creator</guimenuitem></menuchoice>.
  </para>
  <para>
    A service pack is a tarball which contains a set of packages and their dependencies.
    To explain better what a service pack is, it is best to show a few use-cases.
  </para>
  <note><para>
    You can add multiple packages to a service pack by separating the package
    names with a comma, for instance <literal>hal,gnome-power-manager</literal>.
  </para></note>
  <orderedlist numeration="arabic">
    <listitem>
      <para>
        You have seven desktops you've just installed with Fedora 9.
        Each one needs to have 204Mb of updates installed.
      </para>
    </listitem>
    <listitem>
      <para>
        You have a laptop that needs network drivers before it can download updates,
        and you have a similar up to date laptop with internet access nearby.
        The network drivers require a few dependencies, and other packages to be
        upgraded before they will install.
      </para>
    </listitem>
    <listitem>
      <para>
        You frequently install Linux on other peoples computers.
        You carry around a live-cd and a pendrive with a single 204Mb file
        <filename>Fedora-updates-SP1.servicepack</filename> which contains all the
        updates since last week.
      </para>
    </listitem>
    <listitem>
      <para>
        A free software magazine wants to distribute patent encumbered multimedia
        plugins and programs with the latest Fedora release DVD.
        They want a way in which even the most lazy user can get the things
        installed without much fuss.
      </para>
    </listitem>
  </orderedlist>
  <para>
    Internally, the pack file is just an uncompressed tarball, with the packages
    and a single metadata.conf file inside.
    The metadata file is just the distribution identifier and the time of creation.
    This ensures you don't try installing a <filename>fedora-9-i386</filename>
    service pack on a <filename>ubuntu-intrepid-ppc</filename> machine.
  </para>
  <para>
    We need a destination file list because we not know what packages are
    installed on the destination computer.
    For example:
  </para>
  <figure>
    <title>Two example computers</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-service-pack-example.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    Computer A has the following packages installed, and has internet access.
  </para>
  <itemizedlist>
    <listitem><para><literal>glib</literal></para></listitem>
    <listitem><para><literal>dbus</literal></para></listitem>
    <listitem><para><literal>dbus-glib</literal></para></listitem>
    <listitem><para><literal>libgnome</literal></para></listitem>
  </itemizedlist>
  <para>
    Computer B has the following packages installed, and does not have internet access.
  </para>
  <itemizedlist>
    <listitem><para><literal>glib</literal></para></listitem>
    <listitem><para><literal>dbus</literal></para></listitem>
    <listitem><para><literal>kdebase</literal></para></listitem>
    <listitem><para><literal>kdeapps</literal></para></listitem>
  </itemizedlist>
  <para>
    Computer B wants to have a service pack containing a new version of
    <literal>k3b</literal> so that it can burn DVD-RWs.
  </para>
  <para>
    The <literal>k3b</literal> program has dependencies of <literal>dbus</literal>,
    <literal>dbus-glib</literal> and <literal>kdebase</literal>.
    Now, if we asked computer A to download <literal>k3b</literal>, it would download
    <literal>k3b</literal> <emphasis>and</emphasis> <literal>kdebase</literal>, but
    <emphasis>not</emphasis> <literal>dbus-glib</literal>.
    We need to provide computer A with the information about what packages computer B
    has got installed before we can create the service pack.
  </para>
  <para>
    If we generate a package list on computer B, and the transfer it to
    computer A on a USB pendrive or CD-RW we can download the correct packages.
    In this case we would download <literal>k3b</literal> and
    <literal>dbus-glib</literal> and pack it into the new service pack.
  </para>
  <para>
    The service pack can now be transferred from computer A to computer B on
    the USB pendrive.
  </para>
  <para>
    The <command>pkgenpack</command> command line tool can also be used for
    creating service pack files.
  </para>
</section>

<section id="auto-updates">
  <title>Automatic Updates</title>
  <para>
    Automatic updates can be performed in the background system wide using the
    PackageKit-cron package.
    The settings are controlled via the configuration file at
    <filename>/etc/sysconfig/packagekit-background</filename>.
    You can set it to just check for updates or perform the updates
    automatically and notify any email address.
  </para>
</section>

<section id="update-icon">
  <title>Update Icon</title>
  <para>
     The icon offers menu items for installing the available updates or
     for starting the update viewer, which allows you to obtain detailed
     information about the available updates before installing them. See
     <xref linkend="update-viewer"/> for more information.
  </para>
  <figure>
    <title>Preferences tool</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-updates-warning.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
</section>

<section id="eula">
  <title>Agreeing to EULAs</title>
  <para>
    A license agreement is a contract between a producer and a user of software
    which grants the user a software license.
    A software license agreement defines the legal terms under which a user
    may use the software.
    This is called an end-user license agreement or EULA for short.
  </para>
  <para>
    Many EULAs assert extensive liability limitations for the software.
    Typically a EULA will hold the software producer immune in the event that
    the software causes damage to the computer hardware or data.
    Some software also includes limitations if the user can be held liable for
    damage that arises through improper use of the software.
  </para>
  <figure>
    <title>Example EULA</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-eula.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    Be sure to carefully read and accept the EULA text before continuing with
    the install or update.
  </para>
</section>

<section id="gpg-signature">
  <title>Accepting a security signature</title>
  <para>
    Packages from a software source are typically signed by the project managing
    the repository or packages.
    This allows users to be sure a package signed with a security key is
    actually from the software source it claims to be.
  </para>
  <para>
    For a package management infrastructure to operate effectively, it has to
    trust repositories so that updates can be downloaded and installed
    automatically.
    The other benefit is that signed packages can be installed without using the
    administrator password, assuming your admin has enabled this option.
  </para>
  <figure>
    <title>Example signature prompt</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="figures/gpk-signature.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </figure>
  <para>
    To trust a repository, you should verify the details of the signing key.
    Normally the best way to do this is to go to the web page of the software
    source, and try to find details about the key used to sign the packages.
    This is normally called a <literal>GPG key</literal>.
  </para>
  <para>
    You should only proceed with this dialog if you are happy to trust packages
    from this software source.
  </para>
</section>

<section id="dialogs">
  <title>Common Dialogs Explained</title>
  <para>
    This application tries to reuse dialogs as much as possible, so that there
    is a repeatable and consistent user interface when managing packages.
    In the following subsections, some of the dialogs will be explained further,
    often with examples or web links.
  </para>

  <section id="dialog-installing-private-files">
    <title>Copying Files To Another Location</title>
    <figure>
      <title>Example dialog</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-client-copy-local.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      If a file has been downloaded to your home directory, it is usually
      downloaded to a location similar to <literal>/home/hughsie/Downloads</literal>.
      The PackageKit service is not run as the same user as the the normal
      desktop user, and so the daemon would not normally be able to access this file.
      If the download folder cannot be read by the root user then it is copied to a
      temporary directory so it can be accessed.
    </para>
  </section>

  <section id="dialog-install-files">
    <title>Installing Local Files</title>
    <para>
      An application has asked to install local files on your system.
      If you initiated the action, please click the install button.
    </para>
  </section>

  <section id="dialog-install-catalogs">
    <title>Installing Catalogs</title>
    <para>
      A package catalog is a simple file that indicates that other packages should
      be installed.
      There are no optional packages, as a catalog file is designed to be simple
      and need no user interaction.
      Using a catalog file allows you to install different packages quickly and easily.
    </para>
    <note><para>
      To find more information about catalogs, please visit the
      <ulink url="http://www.packagekit.org/pk-faq.html#catalogs" type="http">FAQ</ulink>.
    </para></note>
  </section>

  <section id="dialog-catalog-none-required">
    <title>No Packages Required</title>
    <para>
      The catalog that you tried to install made no changes to your system as
      you already have the required packages installed.
      No further actions are required.
    </para>
    <note><para>
      To find more information about catalogs, please visit the
      <ulink url="http://www.packagekit.org/pk-faq.html#catalogs" type="http">FAQ</ulink>.
    </para></note>
  </section>

  <section id="dialog-application-confirm">
    <title>Confirmation Required</title>
    <figure>
      <title>Example plugin dialog</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-client-codecs.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      An application needs your permission before modifying packages on your system.
      The program name and the icon is from the application asking for permission.
    </para>
  </section>

  <section id="dialog-finding-requires">
    <title>Finding Other Required Packages</title>
    <para>
      Other packages may depend on this package to operate correctly.
      This application is searching for other packages that require the package
      you are trying to remove.
      No changes are being made, and you will be prompted later if this is required.
    </para>
  </section>

  <section id="dialog-finding-depends">
    <title>Finding Other Dependent Packages</title>
    <para>
      This package may require resources in other packages to operate correctly.
      This application is searching for other required packages of the package
      you are trying to install.
    </para>
  </section>

  <section id="dialog-remove-other-packages">
    <title>Removing Other Packages</title>
    <figure>
      <title>Example dialog when removing rarian</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-remove-confirm.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      Other packages need to be removed if this package is to be removed.
      If you remove these packages you may loose functionality in other
      applications.
    </para>
    <caution><para>
      If you are unsure you should not remove the package.
    </para></caution>
  </section>

  <section id="dialog-install-other-packages">
    <title>Installing Other Packages</title>
    <figure>
      <title>Example dialog when installing xfce-utils</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-added-deps.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      Other packages need to be installed if this package is to be installed.
      If you remove these packages you may loose functionality in other
      applications.
      Downloading and installing extra packages will increase the time it
      takes to install this package.
    </para>
  </section>

  <section id="dialog-finding-packages">
    <title>Finding Packages</title>
    <para>
      The package database is being searched for your query.
      This may take some time if new package lists need to be downloaded from
      the Internet.
    </para>
  </section>

  <section id="dialog-package-not-found">
    <title>Package Not Found</title>
    <para>
      No packages could be found in any remote software source.
      This normally means that you do not have any third party repositories
      enabled or installed.
      These extra repositories can often be found using search engines or forums.
    </para>
    <caution><para>
      Only install packages from reputable software sources.
    </para></caution>
  </section>

  <section id="dialog-progress">
    <title>Progress Window</title>
    <para>
      If we start an action automatically, we typically do it non-interactively.
      If this task starts doing something using the network, or that will take a
      long time, then a new dialog will appear.
      This gives you the opportunity to cancel the task if this is not desired.
    </para>
  </section>

  <section id="dialog-permissions">
    <title>No Privileges</title>
    <figure>
      <title>PolicyKit Permissions UI</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpk-repo-auth.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      You don't have the necessary privileges to perform this action.
      This can happen when you fail to authenticate correctly, for instance
      by entering your password correctly twice in a row.
      NOTE: you also need to enter the root password on some distributions,
      not your own password.
    </para>
    <note><para>
      If you cannot authenticate, you need to speak to your systems administrator.
    </para></note>
  </section>

  <section id="dialog-no-service">
    <title>No PackageKit Service Running</title>
    <para>
      The core PackageKit service could not be started.
      This will only happen when you have a serious system error.
      You can get more information about the error by running (as the root user):
      <literal>/usr/sbin/packagekitd --verbose</literal>
    </para>
  </section>

  <section id="dialog-update-system">
    <title>Update System</title>
    <para>
      All the packages that can be updated on your system are now being updated.
      You can cancel the update if the cancel button is not insensitive.
    </para>
  </section>

  <section id="dialog-update-packages">
    <title>Update Packages</title>
    <para>
      Some packages on your system are now being upgraded.
      You can cancel the update if the cancel button is not insensitive.
    </para>
  </section>

  <section id="dialog-refresh">
    <title>Refreshing Package Lists</title>
    <para>
      Once a week (although this can be changed in the preferences)
      you will automatically have the latest package lists downloaded.
      This means that when you search for a package you do not have installed,
      you will get any new software that was added to a software source.
    </para>
    <para>
      Once the package lists are downloaded, the installed and available packages
      will be cached so client tools can auto-complete.
      When this is completed, any new applications are scanned and added to a
      client database.
    </para>
  </section>
</section>

<section id="about">
  <title>About</title>
  <para>
    &app; is maintained Richard Hughes <email>richard@hughsie.com</email> and developed along with
    several others.
    To find more information about &app;, please visit the
    <ulink url="http://www.packagekit.org/" type="http">&application; web page</ulink>.
  </para>
  <para>
    To report a bug or make a suggestion regarding this application or
    this manual, follow the directions at the
    <ulink url="http://www.packagekit.org/" type="http">
    &application; Bug Page</ulink>.
  </para>
  <para>This program is distributed under the terms of the GNU
    General Public license as published by the Free Software
    Foundation; either version 2 of the License, or (at your option)
    any later version. A copy of this license can be found at this
    <ulink url="gpk-application:gpl" type="help">link</ulink>, or in the file
    COPYING included with the source code of this program.
  </para>
</section>

</article>