diff options
author | William Jon McCann <mccann@jhu.edu> | 2008-01-22 17:03:46 -0500 |
---|---|---|
committer | William Jon McCann <mccann@jhu.edu> | 2008-01-22 17:43:22 -0500 |
commit | 5ce97e6f22fd25279793fbc75211d2e86413ae73 (patch) | |
tree | 5de0565516b1d90ed382dc5f0ed969c8e512706c /doc | |
parent | 2fba24e67597bf59ae00db2867df7a348c81b094 (diff) | |
download | ConsoleKit2-5ce97e6f22fd25279793fbc75211d2e86413ae73.tar.gz |
initial stop/restart support
Add Stop and Restart methods to the Manager object. We'll rename the
Manager object to System in the near future. Use libpolkit to
determine authorization.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/spec/ck-manager.xml | 18 | ||||
-rw-r--r-- | doc/xml/ref-ck-manager.xml | 10 |
2 files changed, 26 insertions, 2 deletions
diff --git a/doc/spec/ck-manager.xml b/doc/spec/ck-manager.xml index 077782f..acc065b 100644 --- a/doc/spec/ck-manager.xml +++ b/doc/spec/ck-manager.xml @@ -4,6 +4,24 @@ > <interface name="org.freedesktop.ConsoleKit.Manager"> + <method name="Restart"> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <doc:doc> + <doc:description> + <doc:para>This method initiates a request to restart (ie. reboot) the computer system.</doc:para> + </doc:description> + </doc:doc> + </method> + + <method name="Stop"> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <doc:doc> + <doc:description> + <doc:para>This method initiates a request to stop (ie. shutdown) the computer system.</doc:para> + </doc:description> + </doc:doc> + </method> + <method name="OpenSession"> <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> <arg name="cookie" direction="out" type="s"> diff --git a/doc/xml/ref-ck-manager.xml b/doc/xml/ref-ck-manager.xml index 2aceef8..f964295 100644 --- a/doc/xml/ref-ck-manager.xml +++ b/doc/xml/ref-ck-manager.xml @@ -8,7 +8,9 @@ </refnamediv> <refsynopsisdiv role="synopsis"> <title role="synopsis.title">Methods</title> - <synopsis><link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie) + <synopsis><link linkend="Manager.Restart">Restart</link> () +<link linkend="Manager.Stop">Stop</link> () +<link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie) <link linkend="Manager.OpenSessionWithParameters">OpenSessionWithParameters</link> (in 'a(sv)' parameters, out 's' cookie) <link linkend="Manager.CloseSession">CloseSession</link> (in 's' cookie, @@ -49,7 +51,11 @@ <title role="desc.title">Description</title> <para/> </refsect1> - <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2> + <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.Restart"/>Restart ()</title><indexterm><primary>Restart</primary><secondary>Manager</secondary></indexterm><programlisting>Restart ()</programlisting></refsect2> + <para>This method initiates a request to restart (ie. reboot) the computer system.</para> + <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.Stop"/>Stop ()</title><indexterm><primary>Stop</primary><secondary>Manager</secondary></indexterm><programlisting>Stop ()</programlisting></refsect2> + <para>This method initiates a request to stop (ie. shutdown) the computer system.</para> + <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2> <para>This method requests that a new <link linkend="Session">Session</link> be created for the calling process. The properties of this new Session are set automatically from information collected about the calling process. |