polkit-1-docs.xml 4.94 KB
Newer Older
David Zeuthen's avatar
David Zeuthen committed
1 2 3
<?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" [
David Zeuthen's avatar
David Zeuthen committed
4
<!ENTITY version SYSTEM "../version.xml">
5
<!ENTITY extensiondir SYSTEM "../extensiondir.xml">
David Zeuthen's avatar
David Zeuthen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>PolicyKit Reference Manual</title>
    <releaseinfo>Version &version;</releaseinfo>
    <authorgroup>
      <author>
        <firstname>David</firstname>
        <surname>Zeuthen</surname>
        <affiliation>
          <address>
            <email>davidz@redhat.com</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>

    <copyright>
24
      <year>2008-2009</year>
David Zeuthen's avatar
David Zeuthen committed
25 26 27
      <holder>The PolicyKit Authors</holder>
    </copyright>

28
    <legalnotice id="polkit-legal-notice">
David Zeuthen's avatar
David Zeuthen committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
      <para>
        Permission is granted to copy, distribute and/or modify this
        document under the terms of the <citetitle>GNU Free
        Documentation License</citetitle>, Version 1.1 or any later
        version published by the Free Software Foundation with no
        Invariant Sections, no Front-Cover Texts, and no Back-Cover
        Texts. You may obtain a copy of the <citetitle>GNU Free
        Documentation License</citetitle> from the Free Software
        Foundation by visiting <ulink type="http"
        url="http://www.fsf.org">their Web site</ulink> or by writing
        to:

        <address>
          The Free Software Foundation, Inc.,
          <street>59 Temple Place</street> - Suite 330,
          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
          <country>USA</country>
        </address>
      </para>

      <para>
        Many of the names used by companies to distinguish their
        products and services are claimed as trademarks. Where those
52 53 54 55
        names appear in any freedesktop.org documentation, and those
        trademarks are made aware to the members of the
        freedesktop.org Documentation Project, the names have been
        printed in caps or initial caps.
David Zeuthen's avatar
David Zeuthen committed
56 57 58 59
      </para>
    </legalnotice>
  </bookinfo>

60 61
  <xi:include href="overview.xml"/>

62 63 64
  <part id="ref-dbus-api">
    <title>D-Bus API Reference</title>
    <xi:include href="../../src/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml"/>
65
    <xi:include href="../../src/polkit/docbook-interface-org.freedesktop.PolicyKit1.LocalAuthority.xml"/>
66 67
    <xi:include href="../../src/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml"/>
  </part>
68

69
  <part id="ref-api">
70
    <title>Client API Reference</title>
71 72 73 74 75 76 77 78 79 80 81
    <xi:include href="xml/polkitauthority.xml"/>
    <xi:include href="xml/polkitauthorizationresult.xml"/>
    <xi:include href="xml/polkitdetails.xml"/>
    <xi:include href="xml/polkiterror.xml"/>
    <xi:include href="xml/polkitactiondescription.xml"/>
    <chapter id="subjects">
      <title>Subjects</title>
      <xi:include href="xml/polkitsubject.xml"/>
      <xi:include href="xml/polkitunixprocess.xml"/>
      <xi:include href="xml/polkitunixsession.xml"/>
      <xi:include href="xml/polkitsystembusname.xml"/>
David Zeuthen's avatar
David Zeuthen committed
82
    </chapter>
83 84 85 86 87
    <chapter id="Identities">
      <title>Identities</title>
      <xi:include href="xml/polkitidentity.xml"/>
      <xi:include href="xml/polkitunixuser.xml"/>
      <xi:include href="xml/polkitunixgroup.xml"/>
88
    </chapter>
89
  </part>
David Zeuthen's avatar
David Zeuthen committed
90

91 92 93 94 95 96
  <part id="ref-local-api">
    <title>Local Authority Client API Reference</title>
    <xi:include href="xml/polkitlocalauthority.xml"/>
    <xi:include href="xml/polkitlocalauthorization.xml"/>
  </part>

97 98 99 100 101 102 103 104 105
  <part id="ref-backend-api">
    <title>Backend API Reference</title>
    <xi:include href="xml/polkitbackendauthority.xml"/>
    <xi:include href="xml/polkitbackendlocalauthority.xml"/>
    <xi:include href="xml/polkitbackendactionpool.xml"/>
    <xi:include href="xml/polkitbackendsessionmonitor.xml"/>
    <xi:include href="xml/polkitbackendconfigsource.xml"/>
    <xi:include href="xml/polkitbackendactionlookup.xml"/>
  </part>
David Zeuthen's avatar
David Zeuthen committed
106

107 108 109 110
  <part id="ref-authentication-agent-api">
    <title>Authentication Agent API Reference</title>
    <xi:include href="xml/polkitagentlistener.xml"/>
    <xi:include href="xml/polkitagentsession.xml"/>
David Zeuthen's avatar
David Zeuthen committed
111
  </part>
David Zeuthen's avatar
David Zeuthen committed
112

David Zeuthen's avatar
David Zeuthen committed
113
  <part id="manpages">
David Zeuthen's avatar
David Zeuthen committed
114
    <title>Manual Pages</title>
David Zeuthen's avatar
David Zeuthen committed
115 116
    <xi:include href="../man/PolicyKit-1.xml"/>
    <xi:include href="../man/polkitd-1.xml"/>
117
    <xi:include href="../man/pkcheck.xml"/>
118 119
    <xi:include href="../man/pkaction.xml"/>
    <xi:include href="../man/pkexec.xml"/>
David Zeuthen's avatar
David Zeuthen committed
120
  </part>
David Zeuthen's avatar
David Zeuthen committed
121

122 123 124 125 126
  <chapter id="polkit-hierarchy">
    <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>
  </chapter>

127
  <index id="polit-index">
David Zeuthen's avatar
David Zeuthen committed
128 129 130 131 132 133 134 135 136 137
    <title>Index</title>
  </index>

  <appendix id="license">
    <title>License</title>
    <para>
<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
    </para>
  </appendix>
</book>