packagekit/docs/api/PackageKit-docs.sgml

101 lines
3.1 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>PackageKit Reference Manual</title>
<releaseinfo>
for PackageKit &version;
</releaseinfo>
<authorgroup>
<author>
<firstname>Richard</firstname>
<surname>Hughes</surname>
<affiliation>
<address>
<email>richard@hughsie.com</email>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2008</year>
<holder>The PackageKit Authors</holder>
</copyright>
</bookinfo>
<reference id="specification">
<title>PackageKit Specification</title>
<partintro>
<para>
PackageKit is a D-Bus abstraction layer that allows the session user
to manage packages in a secure way using a cross-distro, cross-architecture API.
PackageKit is built using a lightweight backend architecture.
PackageKit is product and vendor neutral and is currently being developed by a small team
of developers.
</para>
<para>
This part documents core features of PackageKit.
</para>
</partintro>
<xi:include href="spec/pk-introduction.xml"/>
<xi:include href="spec/pk-concepts.xml"/>
<xi:include href="spec/pk-backend-compiled.xml"/>
<xi:include href="spec/pk-backend-dbus.xml"/>
<xi:include href="spec/pk-backend-spawn.xml"/>
</reference>
<reference id="api-reference">
<title>D-Bus API Reference</title>
<partintro>
<para>
This part documents the D-Bus interface used to access the PackageKit daemon.
</para>
</partintro>
<xi:include href="dbus/org.freedesktop.PackageKit.ref.xml"/>
<xi:include href="dbus/org.freedesktop.PackageKit.Transaction.ref.xml"/>
</reference>
<reference id="libpackagekit-gobject">
<title>libpackagekit GObjects</title>
<partintro>
<para>
This part documents GObjects used in libpackagekit.
</para>
</partintro>
<xi:include href="xml/pk-connection.xml"/>
<xi:include href="xml/pk-desktop.xml"/>
<xi:include href="xml/pk-client.xml"/>
<xi:include href="xml/pk-package-list.xml"/>
<xi:include href="xml/pk-control.xml"/>
<xi:include href="xml/pk-task-list.xml"/>
</reference>
<reference id="libpackagekit-helpers">
<title>libpackagekit glib helpers</title>
<partintro>
<para>
This part documents helper funtions in libpackagekit.
</para>
</partintro>
<xi:include href="xml/egg-debug.xml"/>
<xi:include href="xml/pk-common.xml"/>
<xi:include href="xml/pk-enum.xml"/>
<xi:include href="xml/pk-package-id.xml"/>
</reference>
<reference id="faq">
<title>Frequently asked questions</title>
<partintro>
<para>
This part has answers to developer frequently asked questions.
</para>
</partintro>
<xi:include href="spec/pk-developer-faq.xml"/>
</reference>
</book>