summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2012-04-12 13:54:27 -0400
committerDavid Zeuthen <davidz@redhat.com>2012-04-12 14:00:26 -0400
commit2dd284eb425535445f0be6e9dd7d45e8ccd3ffa6 (patch)
tree2df3f5169bde212bb49890e3b145fef3f927f1bd /docs
parentbda0fc1de3361fc6f377d041ce2088118048fdf7 (diff)
downloadpolkit-2dd284eb425535445f0be6e9dd7d45e8ccd3ffa6.tar.gz
Make it possible to influence agent registration with an a{sv} parameter
Additionally, add a "fallback" option. Also add support in this in the pkttyagent(1) program. This slightly breaks libpolkit-backend API by adding a GVariant* param to one of the class vfuncs... but that API is already declared unstable so that's fine. Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/man/pkttyagent.xml11
-rw-r--r--docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml18
-rw-r--r--docs/polkit/polkit-1-sections.txt4
3 files changed, 33 insertions, 0 deletions
diff --git a/docs/man/pkttyagent.xml b/docs/man/pkttyagent.xml
index f0f328e..a5bab8a 100644
--- a/docs/man/pkttyagent.xml
+++ b/docs/man/pkttyagent.xml
@@ -56,6 +56,12 @@
</arg>
</group>
+ <group>
+ <arg choice="plain">
+ <option>--fallback</option>
+ </arg>
+ </group>
+
</cmdsynopsis>
</refsynopsisdiv>
@@ -78,6 +84,11 @@
program. This file descriptor will then be closed when the
authentication agent has been successfully registered.
</para>
+ <para>
+ If <option>--fallback</option> is used, the textual
+ authentication agent will not replace an existing authentication
+ agent.
+ </para>
</refsect1>
<refsect1 id="pkttyagent-return-value">
diff --git a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
index d4894f5..49173f8 100644
--- a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
+++ b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
@@ -34,6 +34,10 @@ Structure <link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuth
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent</link> (IN <link linkend="eggdbus-struct-Subject">Subject</link> subject,
IN String locale,
IN String object_path)
+<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgentWithOptions">RegisterAuthenticationAgentWithOptions</link> (IN <link linkend="eggdbus-struct-Subject">Subject</link> subject,
+ IN String locale,
+ IN String object_path,
+ IN Dict&lt;String,Variant&gt; options)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent">UnregisterAuthenticationAgent</link> (IN <link linkend="eggdbus-struct-Subject">Subject</link> subject,
IN String object_path)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse">AuthenticationAgentResponse</link> (IN String cookie,
@@ -724,6 +728,20 @@ The object path of authentication agent object on the unique name of the caller.
</varlistentry>
</variablelist>
</refsect2>
+
+ <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgentWithOptions">
+ <title>RegisterAuthenticationAgentWithOptions ()</title>
+ <programlisting>
+RegisterAuthenticationAgent (IN <link linkend="eggdbus-struct-Subject">Subject</link> subject,
+ IN String locale,
+ IN String object_path,
+ IN Dict&lt;String,Variant&gt; options)
+ </programlisting>
+ <para>
+<para>Like <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent</link> but takes additional options. If the option <literal>fallback</literal> (of type <literal>Boolean</literal>) is TRUE, then the authentcation agent will only be used as a fallback, e.g. if another agent (without the <literal>fallback</literal> option set TRUE) is available, it will be used instead.</para>
+ </para>
+ </refsect2>
+
<refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent">
<title>UnregisterAuthenticationAgent ()</title>
<programlisting>
diff --git a/docs/polkit/polkit-1-sections.txt b/docs/polkit/polkit-1-sections.txt
index ff6a301..3881004 100644
--- a/docs/polkit/polkit-1-sections.txt
+++ b/docs/polkit/polkit-1-sections.txt
@@ -38,6 +38,9 @@ polkit_authority_enumerate_actions_sync
polkit_authority_register_authentication_agent
polkit_authority_register_authentication_agent_finish
polkit_authority_register_authentication_agent_sync
+polkit_authority_register_authentication_agent_with_options
+polkit_authority_register_authentication_agent_with_options_finish
+polkit_authority_register_authentication_agent_with_options_sync
polkit_authority_unregister_authentication_agent
polkit_authority_unregister_authentication_agent_finish
polkit_authority_unregister_authentication_agent_sync
@@ -394,6 +397,7 @@ polkit_agent_listener_initiate_authentication
polkit_agent_listener_initiate_authentication_finish
PolkitAgentRegisterFlags
polkit_agent_listener_register
+polkit_agent_listener_register_with_options
polkit_agent_listener_unregister
<SUBSECTION Standard>
POLKIT_AGENT_LISTENER