summaryrefslogtreecommitdiff
path: root/docs/polkit/polkit-1-docs.xml
blob: 06510ca37f44352626fbd3d6820abba0cdcf7147 (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
<?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">
<!ENTITY extensiondir SYSTEM "../extensiondir.xml">
]>
<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>
      <year>2008-2009</year>
      <holder>The PolicyKit Authors</holder>
    </copyright>

    <legalnotice id="polkit-legal-notice">
      <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
        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.
      </para>
    </legalnotice>
  </bookinfo>

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

  <part id="ref-dbus-api">
    <title>D-Bus API Reference</title>
    <xi:include href="docbook-interface-org.freedesktop.PolicyKit1.Authority.xml"/>
    <xi:include href="docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml"/>
  </part>

  <part id="ref-api">
    <title>Client API Reference</title>
    <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"/>
    <xi:include href="xml/polkittemporaryauthorization.xml"/>
    <xi:include href="xml/polkitpermission.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"/>
    </chapter>
    <chapter id="Identities">
      <title>Identities</title>
      <xi:include href="xml/polkitidentity.xml"/>
      <xi:include href="xml/polkitunixuser.xml"/>
      <xi:include href="xml/polkitunixgroup.xml"/>
    </chapter>
  </part>

  <part id="ref-backend-api">
    <title>Backend API Reference</title>
    <xi:include href="xml/polkitbackendauthority.xml"/>
    <xi:include href="xml/polkitbackendinteractiveauthority.xml"/>
    <xi:include href="xml/polkitbackendlocalauthority.xml"/>
    <xi:include href="xml/polkitbackendactionlookup.xml"/>
  </part>

  <part id="ref-authentication-agent-api">
    <title>Authentication Agent API Reference</title>
    <xi:include href="xml/polkitagentlistener.xml"/>
    <xi:include href="xml/polkitagenttextlistener.xml"/>
    <xi:include href="xml/polkitagentsession.xml"/>
  </part>

  <part id="manpages">
    <title>Manual Pages</title>
    <xi:include href="../man/polkit.xml"/>
    <xi:include href="../man/polkitd.xml"/>
    <xi:include href="../man/pkcheck.xml"/>
    <xi:include href="../man/pkaction.xml"/>
    <xi:include href="../man/pkexec.xml"/>
    <xi:include href="../man/pklocalauthority.xml"/>
  </part>

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

  <index id="polit-index">
    <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>