summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Jon McCann <jmccann@redhat.com>2008-07-23 23:22:36 -0400
committerWilliam Jon McCann <jmccann@redhat.com>2008-07-23 23:22:36 -0400
commite54095996b9066120ebf20011eba199d25422c2f (patch)
tree6d88da2ce0137fed1ece3bf610690e66809f76b0
parent34cefc96f7661ed92927bffa1cf7cbc79a84e5ab (diff)
use spec files directly as introspection xml and try to generate docs on the fly
At one point we had to strip out the docs because dbus-glib didn't support unknown tags. Apparently this is now fixed. Also install the xml to /usr/share/dbus-1/interfaces.
-rw-r--r--configure.ac6
-rw-r--r--doc/Makefile.am6
-rwxr-xr-xdoc/tools/spec-strip-docs34
-rw-r--r--doc/tools/spec-strip-docs.xsl36
-rwxr-xr-xdoc/tools/spec-to-docbook34
-rwxr-xr-xdoc/tools/update-from-spec25
-rw-r--r--doc/xml/dbus-introspect-docs.dtd (renamed from doc/dbus-introspect-docs.dtd)0
-rw-r--r--doc/xml/ref-ck-manager.xml199
-rw-r--r--doc/xml/ref-ck-seat.xml87
-rw-r--r--doc/xml/ref-ck-session.xml258
-rw-r--r--doc/xml/spec-to-docbook.xsl (renamed from doc/tools/spec-to-docbook.xsl)0
-rw-r--r--src/Makefile.am23
-rw-r--r--src/ck-manager.xml70
-rw-r--r--src/ck-seat.xml39
-rw-r--r--src/ck-session.xml81
-rw-r--r--src/org.freedesktop.ConsoleKit.Manager.xml (renamed from doc/spec/ck-manager.xml)0
-rw-r--r--src/org.freedesktop.ConsoleKit.Seat.xml (renamed from doc/spec/ck-seat.xml)0
-rw-r--r--src/org.freedesktop.ConsoleKit.Session.xml (renamed from doc/spec/ck-session.xml)0
18 files changed, 23 insertions, 875 deletions
diff --git a/configure.ac b/configure.ac
index e9fe6be..b55a3d5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -275,6 +275,11 @@ AM_CONDITIONAL(DOCBOOK_DOCS_ENABLED, test x$enable_docbook_docs = xyes)
AC_MSG_RESULT(yes)
dnl ---------------------------------------------------------------------------
+dnl Check for xsltproc
+dnl ---------------------------------------------------------------------------
+AC_PATH_PROG([XSLTPROC], [xsltproc])
+
+dnl ---------------------------------------------------------------------------
dnl check for inotify
dnl ---------------------------------------------------------------------------
@@ -392,6 +397,7 @@ tools/solaris/Makefile
data/Makefile
doc/Makefile
doc/ConsoleKit.xml
+doc/xml/Makefile
libck-connector/Makefile
libck-connector/ck-connector.pc
pam-ck-connector/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 43802fe..a222ece 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,9 +5,9 @@ SPEC_XML_FILES = \
xml/ck-introduction.xml \
xml/ck-terms.xml \
xml/ck-design.xml \
- xml/ref-ck-manager.xml \
- xml/ref-ck-seat.xml \
- xml/ref-ck-session.xml \
+ xml/org.freedesktop.ConsoleKit.Manager.ref.xml \
+ xml/org.freedesktop.ConsoleKit.Seat.ref.xml \
+ xml/org.freedesktop.ConsoleKit.Session.ref.xml \
$(NULL)
if DOCBOOK_DOCS_ENABLED
diff --git a/doc/tools/spec-strip-docs b/doc/tools/spec-strip-docs
deleted file mode 100755
index 52d84bc..0000000
--- a/doc/tools/spec-strip-docs
+++ /dev/null
@@ -1,34 +0,0 @@
-#!/bin/sh
-
-DIST_BIN=`dirname "$0"`
-
-CMD=xsltproc
-XSL=${DIST_BIN}/spec-strip-docs.xsl
-
-if test "x$1" = "x" -o "x$1" = "x-h" -o "x$1" = "x--help"; then
- echo "usage: $0 [file] ..."
- exit 1
-fi
-
-if [ ! -r ${XSL} ]; then
- echo "Cannot find XSLT file"
- exit 1
-fi
-
-FILES="$@"
-for FILE in $FILES; do
- echo "${FILE}" | grep ".xml$" > /dev/null
- if [ $? -ne 0 ]; then
- echo "Skipping non-xml file: ${FILE}"
- continue
- fi
-
- d=`dirname ${FILE}`
- b=`basename ${FILE} .xml`
-
- outfile="${b}-no-docs.xml"
- echo "Creating: ${outfile}"
- ${CMD} ${XSL} ${FILE} | tail -n +2 > ${outfile}
-done
-
-exit 0
diff --git a/doc/tools/spec-strip-docs.xsl b/doc/tools/spec-strip-docs.xsl
deleted file mode 100644
index 21ad558..0000000
--- a/doc/tools/spec-strip-docs.xsl
+++ /dev/null
@@ -1,36 +0,0 @@
-<?xml version='1.0'?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
- exclude-result-prefixes="doc">
-
- <xsl:output method="xml" indent="yes" encoding="UTF-8"
- omit-xml-declaration="no"
- doctype-system="http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
- doctype-public="-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" />
-
- <xsl:template match="*">
- <xsl:copy>
- <xsl:for-each select="@*">
- <xsl:if test="not(starts-with(name(.), 'doc:'))">
- <xsl:copy/>
- </xsl:if>
- </xsl:for-each>
- <xsl:apply-templates/>
- </xsl:copy>
- </xsl:template>
-
- <xsl:template match="node">
- <node>
- <xsl:for-each select="@*">
- <xsl:if test="not(starts-with(name(.), 'xmlns'))">
- <xsl:copy/>
- </xsl:if>
- </xsl:for-each>
- <xsl:apply-templates/>
- </node>
- </xsl:template>
-
- <xsl:template match="doc:*"/>
- <xsl:template match="text()"/>
-
-</xsl:stylesheet>
diff --git a/doc/tools/spec-to-docbook b/doc/tools/spec-to-docbook
deleted file mode 100755
index 883e2ba..0000000
--- a/doc/tools/spec-to-docbook
+++ /dev/null
@@ -1,34 +0,0 @@
-#!/bin/sh
-
-DIST_BIN=`dirname "$0"`
-
-CMD=xsltproc
-XSL=${DIST_BIN}/spec-to-docbook.xsl
-
-if test "x$1" = "x" -o "x$1" = "x-h" -o "x$1" = "x--help"; then
- echo "usage: $0 [file] ..."
- exit 1
-fi
-
-if [ ! -r ${XSL} ]; then
- echo "Cannot find XSLT file"
- exit 1
-fi
-
-FILES="$@"
-for FILE in $FILES; do
- echo "${FILE}" | grep ".xml$" > /dev/null
- if [ $? -ne 0 ]; then
- echo "Skipping non-xml file: ${FILE}"
- continue
- fi
-
- d=`dirname ${FILE}`
- b=`basename ${FILE} .xml`
-
- outfile="ref-${b}.xml"
- echo "Creating: ${outfile}"
- ${CMD} ${XSL} ${FILE} | tail -n +2 > ${outfile}
-done
-
-exit 0
diff --git a/doc/tools/update-from-spec b/doc/tools/update-from-spec
deleted file mode 100755
index b20e875..0000000
--- a/doc/tools/update-from-spec
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/bin/sh
-
-DIST_BIN=`dirname "$0"`
-
-cd ${DIST_BIN}
-cd ../xml
-../tools/spec-to-docbook ../spec/*.xml
-if [ $? -ne 0 ]; then
- exit 1
-fi
-
-cd ../../src
-../doc/tools/spec-strip-docs ../doc/spec/*.xml
-if [ $? -ne 0 ]; then
- exit 1
-fi
-
-for name in session seat manager; do
- mv ck-${name}-no-docs.xml ck-${name}.xml
- if [ $? -ne 0 ]; then
- exit 1
- fi
-done
-
-exit 0
diff --git a/doc/dbus-introspect-docs.dtd b/doc/xml/dbus-introspect-docs.dtd
index 5fe508e..5fe508e 100644
--- a/doc/dbus-introspect-docs.dtd
+++ b/doc/xml/dbus-introspect-docs.dtd
diff --git a/doc/xml/ref-ck-manager.xml b/doc/xml/ref-ck-manager.xml
deleted file mode 100644
index 3eb3a92..0000000
--- a/doc/xml/ref-ck-manager.xml
+++ /dev/null
@@ -1,199 +0,0 @@
-<refentry id="Manager">
- <refmeta>
- <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Manager</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>org.freedesktop.ConsoleKit.Manager</refname>
- <refpurpose>Manager interface</refpurpose>
- </refnamediv>
- <refsynopsisdiv role="synopsis">
- <title role="synopsis.title">Methods</title>
- <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,
- out 'b' result)
-<link linkend="Manager.GetSeats">GetSeats</link> (out 'ao' seats)
-<link linkend="Manager.GetSessions">GetSessions</link> (out 'ao' sessions)
-<link linkend="Manager.GetSessionForCookie">GetSessionForCookie</link> (in 's' cookie,
- out 'o' ssid)
-<link linkend="Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</link> (in 'u' pid,
- out 'o' ssid)
-<link linkend="Manager.GetCurrentSession">GetCurrentSession</link> (out 'o' ssid)
-<link linkend="Manager.GetSessionsForUnixUser">GetSessionsForUnixUser</link> (in 'u' uid,
- out 'ao' sessions)
-<link linkend="Manager.GetSessionsForUser">GetSessionsForUser</link> (in 'u' uid,
- out 'ao' sessions)
-<link linkend="Manager.GetSystemIdleHint">GetSystemIdleHint</link> (out 'b' idle_hint)
-<link linkend="Manager.GetSystemIdleSinceHint">GetSystemIdleSinceHint</link> (out 's' iso8601_datetime)
-</synopsis>
- </refsynopsisdiv>
- <refsect1 role="signal_proto">
- <title role="signal_proto.title">Signals</title>
- <synopsis><link linkend="Manager::SeatAdded">SeatAdded</link> ('o' sid)
-<link linkend="Manager::SeatRemoved">SeatRemoved</link> ('o' sid)
-<link linkend="Manager::SystemIdleHintChanged">SystemIdleHintChanged</link> ('b' hint)
-</synopsis>
- </refsect1>
- <refsect1 role="impl_interfaces">
- <title role="impl_interfaces.title">Implemented Interfaces</title>
- <para>org.freedesktop.ConsoleKit.Manager implements
- org.freedesktop.DBus.Introspectable,
- org.freedesktop.DBus.Properties
- </para>
- </refsect1>
- <refsect1 role="properties">
- <title role="properties.title">Properties</title>
- <synopsis/>
- </refsect1>
- <refsect1 role="desc">
- <title role="desc.title">Description</title>
- <para/>
- </refsect1>
- <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.
- </para>
- <para>This new session exists until the calling process disconnects from the system bus or
- calls <link linkend="Manager.CloseSession"><function>CloseSession()</function></link>.
- </para>
- <para>It is the responsibility of the calling process to set the environment variable
- XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
- be made available to child processes of the caller so that they may be identified
- as members of this session.
- </para>
- <para>See this simple example:
- <informalexample><programlisting>
- DBusError error;
- DBusMessage *message;
- DBusMessage *reply;
-
- message = dbus_message_new_method_call ("org.freedesktop.ConsoleKit",
- "/org/freedesktop/ConsoleKit/Manager",
- "org.freedesktop.ConsoleKit.Manager",
- "OpenSession");
- if (message == NULL) {
- goto out;
- }
-
- dbus_error_init (&amp;error);
- reply = dbus_connection_send_with_reply_and_block (connector-&gt;connection,
- message,
- -1,
- &amp;error);
- if (reply == NULL) {
- goto out;
- }
-
- dbus_error_init (&amp;error);
- if (! dbus_message_get_args (reply,
- &amp;error,
- DBUS_TYPE_STRING, &amp;cookie,
- DBUS_TYPE_INVALID)) {
- goto out;
- }
-
- </programlisting></informalexample></para>
- <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>The secret cookie that is used to identify the new session</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Manager.OpenSessionWithParameters"><function>OpenSessionWithParameters()</function></link></para><refsect2><title><anchor role="function" id="Manager.OpenSessionWithParameters"/>OpenSessionWithParameters ()</title><indexterm><primary>OpenSessionWithParameters</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSessionWithParameters (in 'a(sv)' parameters,
- 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 from the
- parameters provided.
- </para>
- <para>This new session exists until the calling process disconnects from the system bus or
- calls <link linkend="Manager.CloseSession"><function>CloseSession()</function></link>.
- </para>
- <para>It is the responsibility of the calling process to set the environment variable
- XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
- be made available to child processes of the caller so that they may be identified
- as members of this session.
- </para>
- <para>See the <link linkend="Session">Session</link> properties for a list of valid parameters.</para>
- <variablelist role="params"><varlistentry><term><parameter>parameters</parameter>:</term><listitem><simpara>An array of sets of property names and values</simpara></listitem></varlistentry><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>The secret cookie that is used to identify the new session</simpara></listitem></varlistentry></variablelist><para role="permission">This method is restricted to privileged users by D-Bus policy.</para><para>
-See also:
-<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para><refsect2><title><anchor role="function" id="Manager.CloseSession"/>CloseSession ()</title><indexterm><primary>CloseSession</primary><secondary>Manager</secondary></indexterm><programlisting>CloseSession (in 's' cookie,
- out 'b' result)</programlisting></refsect2>
- <para>This method is used to close the session identified by the supplied cookie.
- </para>
- <para>The session can only be closed by the same process that opened the session.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>The secret cookie that is used to identify the session</simpara></listitem></varlistentry><varlistentry><term><parameter>result</parameter>:</term><listitem><simpara>Whether the session was successfully closed</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetSeats"/>GetSeats ()</title><indexterm><primary>GetSeats</primary><secondary>Manager</secondary></indexterm><programlisting>GetSeats (out 'ao' seats)</programlisting></refsect2>
- <para>This gets a list of all the <link linkend="Seat">Seats</link>
- that are currently present on the system.</para>
- <para>Each Seat ID is an D-Bus object path for the object that implements the
- <link linkend="Seat">Seat</link> interface.</para>
- <variablelist role="params"><varlistentry><term><parameter>seats</parameter>:</term><listitem><simpara>an array of Seat IDs</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para><refsect2><title><anchor role="function" id="Manager.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting></refsect2>
- <para>This gets a list of all the <link linkend="Sessions">Sessions</link>
- that are currently present on the system.</para>
- <para>Each Session ID is an D-Bus object path for the object that implements the
- <link linkend="Session">Session</link> interface.</para>
- <variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para><refsect2><title><anchor role="function" id="Manager.GetSessionForCookie"/>GetSessionForCookie ()</title><indexterm><primary>GetSessionForCookie</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionForCookie (in 's' cookie,
- out 'o' ssid)</programlisting></refsect2>
- <para>Returns the session ID that is associated with the specified cookie.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>The secret cookie that is used to identify the session</simpara></listitem></varlistentry><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>The object identifier for the current session</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetSessionForUnixProcess"/>GetSessionForUnixProcess ()</title><indexterm><primary>GetSessionForUnixProcess</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionForUnixProcess (in 'u' pid,
- out 'o' ssid)</programlisting></refsect2>
- <para>Attempts to determine the session ID for the specified
- POSIX process ID (pid).
- </para>
- <variablelist role="params"><varlistentry><term><parameter>pid</parameter>:</term><listitem><simpara>The POSIX process ID</simpara></listitem></varlistentry><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>The object identifier for the current session</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetCurrentSession"/>GetCurrentSession ()</title><indexterm><primary>GetCurrentSession</primary><secondary>Manager</secondary></indexterm><programlisting>GetCurrentSession (out 'o' ssid)</programlisting></refsect2>
- <para>Attempts to determine the session ID that the caller belongs to.
- </para>
- <para>See this example of using dbus-send:
- <informalexample><programlisting>
- dbus-send --system --dest=org.freedesktop.ConsoleKit \
- --type=method_call --print-reply --reply-timeout=2000 \
- /org/freedesktop/ConsoleKit/Manager \
- org.freedesktop.ConsoleKit.Manager.GetCurrentSession
- </programlisting></informalexample></para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>The object identifier for the current session</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetSessionsForUnixUser"/>GetSessionsForUnixUser ()</title><indexterm><primary>GetSessionsForUnixUser</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionsForUnixUser (in 'u' uid,
- out 'ao' sessions)</programlisting></refsect2>
- <para>This gets a list of all the <link linkend="Session">Sessions</link>
- that are currently open for the specified user.</para>
- <para>Each Session ID is an D-Bus object path for the object that implements the
- <link linkend="Session">Session</link> interface.</para>
- <variablelist role="params"><varlistentry><term><parameter>uid</parameter>:</term><listitem><simpara>POSIX User identification</simpara></listitem></varlistentry><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetSessionsForUser"/>GetSessionsForUser ()</title><indexterm><primary>GetSessionsForUser</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionsForUser (in 'u' uid,
- out 'ao' sessions)</programlisting></refsect2>
- <para>This gets a list of all the <link linkend="Session">Sessions</link>
- that are currently open for the specified user.</para>
- <para>Each Session ID is an D-Bus object path for the object that implements the
- <link linkend="Session">Session</link> interface.</para>
- <variablelist role="params"><varlistentry><term><parameter>uid</parameter>:</term><listitem><simpara>User identification</simpara></listitem></varlistentry><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><para role="deprecated"><warning><para><literal>GetSessionsForUser</literal> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
-
- <link linkend="Manager.GetSessionsForUnixUser"><function>GetSessionsForUnixUser</function></link>
-instead.</para></warning></para><refsect2><title><anchor role="function" id="Manager.GetSystemIdleHint"/>GetSystemIdleHint ()</title><indexterm><primary>GetSystemIdleHint</primary><secondary>Manager</secondary></indexterm><programlisting>GetSystemIdleHint (out 'b' idle_hint)</programlisting></refsect2>
- <para>Returns TRUE if the <link linkend="Session:idle-hint"><literal>idle-hint</literal></link>
- property of every open session is TRUE or if there are no open sessions.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>idle_hint</parameter>:</term><listitem><simpara>The value of the system-idle-hint</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager.GetSystemIdleSinceHint"/>GetSystemIdleSinceHint ()</title><indexterm><primary>GetSystemIdleSinceHint</primary><secondary>Manager</secondary></indexterm><programlisting>GetSystemIdleSinceHint (out 's' iso8601_datetime)</programlisting></refsect2>
- <para>Returns an ISO 8601 date-time string that corresponds to
- the time of the last change of the system-idle-hint.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist></refsect1>
- <refsect1 role="signals"><title role="signals.title">Signal Details</title><refsect2><title><anchor role="function" id="Manager::SeatAdded"/>The SeatAdded signal</title><indexterm><primary>SeatAdded</primary><secondary>Manager</secondary></indexterm><programlisting>SeatAdded ('o' sid)</programlisting></refsect2>
- <para>Emitted when a Seat has been added to the system.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>The Seat ID for the added seat</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager::SeatRemoved"/>The SeatRemoved signal</title><indexterm><primary>SeatRemoved</primary><secondary>Manager</secondary></indexterm><programlisting>SeatRemoved ('o' sid)</programlisting></refsect2>
- <para>Emitted when a Seat has been removed from the system.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>The Seat ID for the removed seat</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Manager::SystemIdleHintChanged"/>The SystemIdleHintChanged signal</title><indexterm><primary>SystemIdleHintChanged</primary><secondary>Manager</secondary></indexterm><programlisting>SystemIdleHintChanged ('b' hint)</programlisting></refsect2>
- <para>Emitted when the value of the system-idle-hint has changed.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>hint</parameter>:</term><listitem><simpara>The value of the system-idle-hint</simpara></listitem></varlistentry></variablelist></refsect1>
- <refsect1 role="property_details">
- <title role="property_details.title">Property Details</title>
- </refsect1>
-</refentry>
diff --git a/doc/xml/ref-ck-seat.xml b/doc/xml/ref-ck-seat.xml
deleted file mode 100644
index 16d86b2..0000000
--- a/doc/xml/ref-ck-seat.xml
+++ /dev/null
@@ -1,87 +0,0 @@
-<refentry id="Seat">
- <refmeta>
- <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Seat</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>org.freedesktop.ConsoleKit.Seat</refname>
- <refpurpose>Seat interface</refpurpose>
- </refnamediv>
- <refsynopsisdiv role="synopsis">
- <title role="synopsis.title">Methods</title>
- <synopsis><link linkend="Seat.GetId">GetId</link> (out 'o' sid)
-<link linkend="Seat.GetSessions">GetSessions</link> (out 'ao' sessions)
-<link linkend="Seat.GetDevices">GetDevices</link> (out 'a(ss)' devices)
-<link linkend="Seat.GetActiveSession">GetActiveSession</link> (out 'o' ssid)
-<link linkend="Seat.CanActivateSessions">CanActivateSessions</link> (out 'b' can_activate)
-<link linkend="Seat.ActivateSession">ActivateSession</link> (in 'o' ssid)
-</synopsis>
- </refsynopsisdiv>
- <refsect1 role="signal_proto">
- <title role="signal_proto.title">Signals</title>
- <synopsis><link linkend="Seat::ActiveSessionChanged">ActiveSessionChanged</link> ('o' ssid)
-<link linkend="Seat::SessionAdded">SessionAdded</link> ('o' ssid)
-<link linkend="Seat::SessionRemoved">SessionRemoved</link> ('o' ssid)
-<link linkend="Seat::DeviceAdded">DeviceAdded</link> ('(ss)' device)
-<link linkend="Seat::DeviceRemoved">DeviceRemoved</link> ('(ss)' device)
-</synopsis>
- </refsect1>
- <refsect1 role="impl_interfaces">
- <title role="impl_interfaces.title">Implemented Interfaces</title>
- <para>org.freedesktop.ConsoleKit.Seat implements
- org.freedesktop.DBus.Introspectable,
- org.freedesktop.DBus.Properties
- </para>
- </refsect1>
- <refsect1 role="properties">
- <title role="properties.title">Properties</title>
- <synopsis/>
- </refsect1>
- <refsect1 role="desc">
- <title role="desc.title">Description</title>
- <para>
-
- <para>A seat is a collection of sessions and a set of hardware (usually at
-least a keyboard and mouse). Only one session may be active on a
-seat at a time.</para>
-
- </para>
- </refsect1>
- <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Seat.GetId"/>GetId ()</title><indexterm><primary>GetId</primary><secondary>Seat</secondary></indexterm><programlisting>GetId (out 'o' sid)</programlisting></refsect2>Returns the ID for Seat.
- <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>Seat ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Seat</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting></refsect2>
- <para>This gets a list of all the <link linkend="Session">Sessions</link>
- that are currently attached to this seat.</para>
- <para>Each Session ID is an D-Bus object path for the object that implements the
- <link linkend="Session">Session</link> interface.</para>
- <variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.GetDevices"/>GetDevices ()</title><indexterm><primary>GetDevices</primary><secondary>Seat</secondary></indexterm><programlisting>GetDevices (out 'a(ss)' devices)</programlisting></refsect2>
- <para>This gets a list of all the devices
- that are currently associated with this seat.</para>
- <para>Each device is an D-Bus structure that represents
- the device type and the device id.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>devices</parameter>:</term><listitem><simpara>an array of devices</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.GetActiveSession"/>GetActiveSession ()</title><indexterm><primary>GetActiveSession</primary><secondary>Seat</secondary></indexterm><programlisting>GetActiveSession (out 'o' ssid)</programlisting></refsect2>
- <para>Gets the Session ID that is currently active on this Seat.</para>
- <para>Returns NULL if there is no active session.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.CanActivateSessions"/>CanActivateSessions ()</title><indexterm><primary>CanActivateSessions</primary><secondary>Seat</secondary></indexterm><programlisting>CanActivateSessions (out 'b' can_activate)</programlisting></refsect2>Used to determine whether the seat supports session activation.
- <variablelist role="params"><varlistentry><term><parameter>can_activate</parameter>:</term><listitem><simpara>TRUE if seat supports session activation</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.ActivateSession"/>ActivateSession ()</title><indexterm><primary>ActivateSession</primary><secondary>Seat</secondary></indexterm><programlisting>ActivateSession (in 'o' ssid)</programlisting></refsect2>
- <para>Attempt to activate the specified session. In most
- cases, if successful, this will cause the session to
- become visible and take control of the hardware that is
- associated with this seat.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session.Activate"><function>Activate()</function></link></para></refsect1>
- <refsect1 role="signals"><title role="signals.title">Signal Details</title><refsect2><title><anchor role="function" id="Seat::ActiveSessionChanged"/>The ActiveSessionChanged signal</title><indexterm><primary>ActiveSessionChanged</primary><secondary>Seat</secondary></indexterm><programlisting>ActiveSessionChanged ('o' ssid)</programlisting></refsect2>
- <para>Emitted when the active session has changed.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat::SessionAdded"/>The SessionAdded signal</title><indexterm><primary>SessionAdded</primary><secondary>Seat</secondary></indexterm><programlisting>SessionAdded ('o' ssid)</programlisting></refsect2>
- <para>Emitted when a session has been added to the seat.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat::SessionRemoved"/>The SessionRemoved signal</title><indexterm><primary>SessionRemoved</primary><secondary>Seat</secondary></indexterm><programlisting>SessionRemoved ('o' ssid)</programlisting></refsect2>
- <para>Emitted when a session has been removed from the seat.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat::DeviceAdded"/>The DeviceAdded signal</title><indexterm><primary>DeviceAdded</primary><secondary>Seat</secondary></indexterm><programlisting>DeviceAdded ('(ss)' device)</programlisting></refsect2>
- <para>Emitted when a device has been associated with the seat.</para>
- <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Device structure</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat::DeviceRemoved"/>The DeviceRemoved signal</title><indexterm><primary>DeviceRemoved</primary><secondary>Seat</secondary></indexterm><programlisting>DeviceRemoved ('(ss)' device)</programlisting></refsect2>
- <para>Emitted when a device has been dissociated from the seat.</para>
- <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Device structure</simpara></listitem></varlistentry></variablelist></refsect1>
- <refsect1 role="property_details">
- <title role="property_details.title">Property Details</title>
- </refsect1>
-</refentry>
diff --git a/doc/xml/ref-ck-session.xml b/doc/xml/ref-ck-session.xml
deleted file mode 100644
index 2b50ed2..0000000
--- a/doc/xml/ref-ck-session.xml
+++ /dev/null
@@ -1,258 +0,0 @@
-<refentry id="Session">
- <refmeta>
- <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Session</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>org.freedesktop.ConsoleKit.Session</refname>
- <refpurpose>Session interface</refpurpose>
- </refnamediv>
- <refsynopsisdiv role="synopsis">
- <title role="synopsis.title">Methods</title>
- <synopsis><link linkend="Session.GetId">GetId</link> (out 'o' ssid)
-<link linkend="Session.GetSeatId">GetSeatId</link> (out 'o' sid)
-<link linkend="Session.GetSessionType">GetSessionType</link> (out 's' type)
-<link linkend="Session.GetUser">GetUser</link> (out 'u' uid)
-<link linkend="Session.GetUnixUser">GetUnixUser</link> (out 'u' uid)
-<link linkend="Session.GetX11Display">GetX11Display</link> (out 's' display)
-<link linkend="Session.GetX11DisplayDevice">GetX11DisplayDevice</link> (out 's' x11_display_device)
-<link linkend="Session.GetDisplayDevice">GetDisplayDevice</link> (out 's' display_device)
-<link linkend="Session.GetRemoteHostName">GetRemoteHostName</link> (out 's' remote_host_name)
-<link linkend="Session.GetLoginSessionId">GetLoginSessionId</link> (out 's' login_session_id)
-<link linkend="Session.IsActive">IsActive</link> (out 'b' active)
-<link linkend="Session.IsLocal">IsLocal</link> (out 'b' local)
-<link linkend="Session.GetCreationTime">GetCreationTime</link> (out 's' iso8601_datetime)
-<link linkend="Session.Activate">Activate</link> ()
-<link linkend="Session.Lock">Lock</link> ()
-<link linkend="Session.Unlock">Unlock</link> ()
-<link linkend="Session.GetIdleHint">GetIdleHint</link> (out 'b' idle_hint)
-<link linkend="Session.GetIdleSinceHint">GetIdleSinceHint</link> (out 's' iso8601_datetime)
-<link linkend="Session.SetIdleHint">SetIdleHint</link> (in 'b' idle_hint)
-</synopsis>
- </refsynopsisdiv>
- <refsect1 role="signal_proto">
- <title role="signal_proto.title">Signals</title>
- <synopsis><link linkend="Session::ActiveChanged">ActiveChanged</link> ('b' is_active)
-<link linkend="Session::IdleHintChanged">IdleHintChanged</link> ('b' hint)
-<link linkend="Session::Lock">Lock</link> ()
-<link linkend="Session::Unlock">Unlock</link> ()
-</synopsis>
- </refsect1>
- <refsect1 role="impl_interfaces">
- <title role="impl_interfaces.title">Implemented Interfaces</title>
- <para>org.freedesktop.ConsoleKit.Session implements
- org.freedesktop.DBus.Introspectable,
- org.freedesktop.DBus.Properties
- </para>
- </refsect1>
- <refsect1 role="properties">
- <title role="properties.title">Properties</title>
- <synopsis><link linkend="Session:unix-user">'unix-user'</link> readwrite 'u'
-<link linkend="Session:user">'user'</link> readwrite 'u'
-<link linkend="Session:session-type">'session-type'</link> readwrite 's'
-<link linkend="Session:remote-host-name">'remote-host-name'</link> readwrite 's'
-<link linkend="Session:display-device">'display-device'</link> readwrite 's'
-<link linkend="Session:x11-display">'x11-display'</link> readwrite 's'
-<link linkend="Session:x11-display-device">'x11-display-device'</link> readwrite 's'
-<link linkend="Session:active">'active'</link> readwrite 'b'
-<link linkend="Session:is-local">'is-local'</link> readwrite 'b'
-<link linkend="Session:idle-hint">'idle-hint'</link> readwrite 'b'
-</synopsis>
- </refsect1>
- <refsect1 role="desc">
- <title role="desc.title">Description</title>
- <para>
-
- <para>Session objects represent and store information
- related to a user session.
- </para>
- <para>The properties associated with the Session
- specifically refer to the properties of the "session leader".
- </para>
-
- </para>
- </refsect1>
- <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Session.GetId"/>GetId ()</title><indexterm><primary>GetId</primary><secondary>Session</secondary></indexterm><programlisting>GetId (out 'o' ssid)</programlisting></refsect2><para>Returns the ID for Session.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session.GetSeatId"/>GetSeatId ()</title><indexterm><primary>GetSeatId</primary><secondary>Session</secondary></indexterm><programlisting>GetSeatId (out 'o' sid)</programlisting></refsect2><para>Returns the ID for the Seat the Session is
- attached to.</para>
- <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>Seat ID</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para><refsect2><title><anchor role="function" id="Session.GetSessionType"/>GetSessionType ()</title><indexterm><primary>GetSessionType</primary><secondary>Session</secondary></indexterm><programlisting>GetSessionType (out 's' type)</programlisting></refsect2>
- <para>Returns the type of the session.</para>
- <para>Warning: we haven't yet defined the allowed values for this property.
- It is probably best to avoid this until we do.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>type</parameter>:</term><listitem><simpara>Session type</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:session-type"><literal>session-type</literal></link></para><refsect2><title><anchor role="function" id="Session.GetUser"/>GetUser ()</title><indexterm><primary>GetUser</primary><secondary>Session</secondary></indexterm><programlisting>GetUser (out 'u' uid)</programlisting></refsect2><para>Returns the user that the session belongs to.</para>
- <variablelist role="params"><varlistentry><term><parameter>uid</parameter>:</term><listitem><simpara>User ID</simpara></listitem></varlistentry></variablelist><para role="deprecated"><warning><para><literal>GetUser</literal> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
-
- <link linkend="Session.GetUnixUser"><function>GetUnixUser</function></link>
-instead.</para></warning></para><para>
-See also:
-<link linkend="Session:user"><literal>user</literal></link></para><refsect2><title><anchor role="function" id="Session.GetUnixUser"/>GetUnixUser ()</title><indexterm><primary>GetUnixUser</primary><secondary>Session</secondary></indexterm><programlisting>GetUnixUser (out 'u' uid)</programlisting></refsect2><para>Returns the POSIX user ID that the session belongs to.</para>
- <variablelist role="params"><varlistentry><term><parameter>uid</parameter>:</term><listitem><simpara>POSIX User ID</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:unix-user"><literal>unix-user</literal></link></para><refsect2><title><anchor role="function" id="Session.GetX11Display"/>GetX11Display ()</title><indexterm><primary>GetX11Display</primary><secondary>Session</secondary></indexterm><programlisting>GetX11Display (out 's' display)</programlisting></refsect2><para>Returns the value of the X11 DISPLAY for this session
- if one is present.</para>
- <variablelist role="params"><varlistentry><term><parameter>display</parameter>:</term><listitem><simpara>The value of the X11 display</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:x11-display"><literal>x11-display</literal></link></para><refsect2><title><anchor role="function" id="Session.GetX11DisplayDevice"/>GetX11DisplayDevice ()</title><indexterm><primary>GetX11DisplayDevice</primary><secondary>Session</secondary></indexterm><programlisting>GetX11DisplayDevice (out 's' x11_display_device)</programlisting></refsect2><para>Returns the value of the display device (aka TTY) that the
- X11 display for the session is connected to. If there is no x11-display set then this value
- is undefined.</para>
- <variablelist role="params"><varlistentry><term><parameter>x11_display_device</parameter>:</term><listitem><simpara>The value of the X11 display device</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:x11-display-device"><literal>x11-display-device</literal></link></para><refsect2><title><anchor role="function" id="Session.GetDisplayDevice"/>GetDisplayDevice ()</title><indexterm><primary>GetDisplayDevice</primary><secondary>Session</secondary></indexterm><programlisting>GetDisplayDevice (out 's' display_device)</programlisting></refsect2><para>Returns the value of the display device (aka TTY) that the
- session is connected to.</para>
- <variablelist role="params"><varlistentry><term><parameter>display_device</parameter>:</term><listitem><simpara>The value of the display device</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:display-device"><literal>display-device</literal></link></para><refsect2><title><anchor role="function" id="Session.GetRemoteHostName"/>GetRemoteHostName ()</title><indexterm><primary>GetRemoteHostName</primary><secondary>Session</secondary></indexterm><programlisting>GetRemoteHostName (out 's' remote_host_name)</programlisting></refsect2><para>Returns the value of the remote host name for the session.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>remote_host_name</parameter>:</term><listitem><simpara>The remote host name</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:remote-host-name"><literal>remote-host-name</literal></link></para><refsect2><title><anchor role="function" id="Session.GetLoginSessionId"/>GetLoginSessionId ()</title><indexterm><primary>GetLoginSessionId</primary><secondary>Session</secondary></indexterm><programlisting>GetLoginSessionId (out 's' login_session_id)</programlisting></refsect2><para>Returns the value of the login session ID that the
- underlying system uses to enforce session boundaries. If there is no login session ID
- set then this value is an empty string.</para>
- <variablelist role="params"><varlistentry><term><parameter>login_session_id</parameter>:</term><listitem><simpara>The value of the native system login session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session.IsActive"/>IsActive ()</title><indexterm><primary>IsActive</primary><secondary>Session</secondary></indexterm><programlisting>IsActive (out 'b' active)</programlisting></refsect2><para>Returns whether the session is active on the Seat that
- it is attached to.</para>
- <para>If the session is not attached to a seat this value is undefined.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>active</parameter>:</term><listitem><simpara>TRUE if the session is active, otherwise FALSE</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:active"><literal>active</literal></link></para><refsect2><title><anchor role="function" id="Session.IsLocal"/>IsLocal ()</title><indexterm><primary>IsLocal</primary><secondary>Session</secondary></indexterm><programlisting>IsLocal (out 'b' local)</programlisting></refsect2><para>Returns whether the session is local</para>
- <para>FIXME: we need to come up with a concrete definition for this value.
- It was originally used as a way to identify XDMCP sessions that originate
- from a remote system.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>local</parameter>:</term><listitem><simpara>TRUE if the session is local, otherwise FALSE</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:is-local"><literal>is-local</literal></link></para><refsect2><title><anchor role="function" id="Session.GetCreationTime"/>GetCreationTime ()</title><indexterm><primary>GetCreationTime</primary><secondary>Session</secondary></indexterm><programlisting>GetCreationTime (out 's' iso8601_datetime)</programlisting></refsect2>
- <para>Returns an ISO 8601 date-time string that corresponds to
- the time that the session was opened.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session.Activate"/>Activate ()</title><indexterm><primary>Activate</primary><secondary>Session</secondary></indexterm><programlisting>Activate ()</programlisting></refsect2>
- <para>Attempt to activate the this session. In most
- cases, if successful, this will cause the session to
- become visible and become active on the seat that it
- is attached to.</para>
- <variablelist role="params"/><para>
-See also:
-<link linkend="Seat.ActivateSession"><function>Seat.ActivateSession()</function></link></para><refsect2><title><anchor role="function" id="Session.Lock"/>Lock ()</title><indexterm><primary>Lock</primary><secondary>Session</secondary></indexterm><programlisting>Lock ()</programlisting></refsect2>
- <para>This will cause a <link linkend="Session::Lock"><literal>Lock</literal></link>
- signal to be emitted for this session.
- </para>
- <variablelist role="params"/><para role="permission">This method is restricted to privileged users by D-Bus policy.</para><para>
-See also:
-<link linkend="Session::Lock"><literal>Lock signal</literal></link></para><refsect2><title><anchor role="function" id="Session.Unlock"/>Unlock ()</title><indexterm><primary>Unlock</primary><secondary>Session</secondary></indexterm><programlisting>Unlock ()</programlisting></refsect2>
- <para>This will cause an <link linkend="Session::Unlock"><literal>Unlock</literal></link>
- signal to be emitted for this session.
- </para>
- <para>This can be used by login managers to unlock a session before it is
- re-activated during fast-user-switching.
- </para>
- <variablelist role="params"/><para role="permission">This method is restricted to privileged users by D-Bus policy.</para><para>
-See also:
-<link linkend="Session::Unlock"><literal>Unlock signal</literal></link></para><refsect2><title><anchor role="function" id="Session.GetIdleHint"/>GetIdleHint ()</title><indexterm><primary>GetIdleHint</primary><secondary>Session</secondary></indexterm><programlisting>GetIdleHint (out 'b' idle_hint)</programlisting></refsect2>
- <para>Gets the value of the <link linkend="Session:idle-hint"><literal>idle-hint</literal></link>
- property.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>idle_hint</parameter>:</term><listitem><simpara>The value of the idle-hint</simpara></listitem></varlistentry></variablelist><para>
-See also:
-<link linkend="Session:idle-hint"><literal>idle-hint</literal></link></para><refsect2><title><anchor role="function" id="Session.GetIdleSinceHint"/>GetIdleSinceHint ()</title><indexterm><primary>GetIdleSinceHint</primary><secondary>Session</secondary></indexterm><programlisting>GetIdleSinceHint (out 's' iso8601_datetime)</programlisting></refsect2>
- <para>Returns an ISO 8601 date-time string that corresponds to
- the time of the last change of the idle-hint.
- </para>
- <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session.SetIdleHint"/>SetIdleHint ()</title><indexterm><primary>SetIdleHint</primary><secondary>Session</secondary></indexterm><programlisting>SetIdleHint (in 'b' idle_hint)</programlisting></refsect2>
- <para>This may be used by the session to indicate that
- it is idle.
- </para>
- <para>Use of this method is restricted to the user
- that owns the session.</para>
- <variablelist role="params"><varlistentry><term><parameter>idle_hint</parameter>:</term><listitem><simpara>boolean value to set the idle-hint to</simpara></listitem></varlistentry></variablelist></refsect1>
- <refsect1 role="signals"><title role="signals.title">Signal Details</title><refsect2><title><anchor role="function" id="Session::ActiveChanged"/>The ActiveChanged signal</title><indexterm><primary>ActiveChanged</primary><secondary>Session</secondary></indexterm><programlisting>ActiveChanged ('b' is_active)</programlisting></refsect2>
- <para>Emitted when the active property has changed.</para>
- <variablelist role="params"><varlistentry><term><parameter>is_active</parameter>:</term><listitem><simpara>TRUE if the session is active, otherwise FALSE</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session::IdleHintChanged"/>The IdleHintChanged signal</title><indexterm><primary>IdleHintChanged</primary><secondary>Session</secondary></indexterm><programlisting>IdleHintChanged ('b' hint)</programlisting></refsect2>
- <para>Emitted when the idle-hint property has changed.</para>
- <variablelist role="params"><varlistentry><term><parameter>hint</parameter>:</term><listitem><simpara>the new value of idle-hint</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Session::Lock"/>The Lock signal</title><indexterm><primary>Lock</primary><secondary>Session</secondary></indexterm><programlisting>Lock ()</programlisting></refsect2>
- <para>Emitted in response to a call to the <link linkend="Session.Lock"><function>Lock()</function></link> method.</para>
- <para>It is intended that the screensaver for the session should lock the screen in response to this signal.</para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session::Unlock"/>The Unlock signal</title><indexterm><primary>Unlock</primary><secondary>Session</secondary></indexterm><programlisting>Unlock ()</programlisting></refsect2>
- <para>Emitted in response to a call to the <link linkend="Session.Unlock"><function>Unlock()</function></link> method.</para>
- <para>It is intended that the screensaver for the session should unlock the screen in response to this signal.</para>
- <variablelist role="params"/></refsect1>
- <refsect1 role="property_details"><title role="property_details.title">Property Details</title><refsect2><title><anchor role="function" id="Session:unix-user"/>The "unix-user" property</title><indexterm><primary>unix-user</primary><secondary>Session</secondary></indexterm><programlisting>'unix-user' readwrite 'u'
-</programlisting></refsect2>
- <para>The user assigned to the session.</para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:user"/>The "user" property</title><indexterm><primary>user</primary><secondary>Session</secondary></indexterm><programlisting>'user' readwrite 'u'
-</programlisting></refsect2>
- <para>The user assigned to the session.</para>
- <variablelist role="params"/><para role="deprecated"><warning><para><literal>user</literal> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
-
- <link linkend="Session:unix-user"><literal>unix-user</literal></link>
-instead.</para></warning></para><refsect2><title><anchor role="function" id="Session:session-type"/>The "session-type" property</title><indexterm><primary>session-type</primary><secondary>Session</secondary></indexterm><programlisting>'session-type' readwrite 's'
-</programlisting></refsect2>
- <para>The type of the session.</para>
- <para>Warning: we haven't yet defined the allowed values for this property.
- It is probably best to avoid this until we do.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:remote-host-name"/>The "remote-host-name" property</title><indexterm><primary>remote-host-name</primary><secondary>Session</secondary></indexterm><programlisting>'remote-host-name' readwrite 's'
-</programlisting></refsect2>
- <para>The remote host name for the session.
- </para>
- <para>This will be set in situations where the session is
- opened and controlled from a remote system.
- </para>
- <para>For example, this value will be set when the
- session is created from an SSH or XDMCP connection.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:display-device"/>The "display-device" property</title><indexterm><primary>display-device</primary><secondary>Session</secondary></indexterm><programlisting>'display-device' readwrite 's'
-</programlisting></refsect2>
- <para>The display device (aka TTY) that the
- session is connected to.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:x11-display"/>The "x11-display" property</title><indexterm><primary>x11-display</primary><secondary>Session</secondary></indexterm><programlisting>'x11-display' readwrite 's'
-</programlisting></refsect2>
- <para>Value of the X11 DISPLAY for this session
- if one is present.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:x11-display-device"/>The "x11-display-device" property</title><indexterm><primary>x11-display-device</primary><secondary>Session</secondary></indexterm><programlisting>'x11-display-device' readwrite 's'
-</programlisting></refsect2>
- <para>
- The display device (aka TTY) that the X11 display for the
- session is connected to. If there is no x11-display set then
- this value is undefined.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:active"/>The "active" property</title><indexterm><primary>active</primary><secondary>Session</secondary></indexterm><programlisting>'active' readwrite 'b'
-</programlisting></refsect2>
- <para>
- Whether the session is active on the Seat that
- it is attached to.</para>
- <para>If the session is not attached to a seat this value is undefined.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:is-local"/>The "is-local" property</title><indexterm><primary>is-local</primary><secondary>Session</secondary></indexterm><programlisting>'is-local' readwrite 'b'
-</programlisting></refsect2>
- <para>
- Whether the session is local</para>
- <para>FIXME: we need to come up with a concrete definition for this value.
- It was originally used as a way to identify XDMCP sessions that originate
- from a remote system.
- </para>
- <variablelist role="params"/><refsect2><title><anchor role="function" id="Session:idle-hint"/>The "idle-hint" property</title><indexterm><primary>idle-hint</primary><secondary>Session</secondary></indexterm><programlisting>'idle-hint' readwrite 'b'
-</programlisting></refsect2>
- <para>
- This is a hint used to indicate that the session may be idle.
- </para>
- <para>
- For sessions with a <link linkend="Session:x11-display"><literal>x11-display</literal></link> set (ie. graphical
- sessions), it is up to each session to delegate the
- responsibility for updating this value. Typically, the
- screensaver will set this.
- </para>
- <para>However, for non-graphical sessions with a <link linkend="Session:display-device"><literal>display-device</literal></link> set
- the Session object itself will periodically update this value based
- on the activity detected on the display-device itself.
- </para>
- <para>
- This should not be considered authoritative.
- </para>
- <variablelist role="params"/></refsect1>
-</refentry>
diff --git a/doc/tools/spec-to-docbook.xsl b/doc/xml/spec-to-docbook.xsl
index fccf887..fccf887 100644
--- a/doc/tools/spec-to-docbook.xsl
+++ b/doc/xml/spec-to-docbook.xsl
diff --git a/src/Makefile.am b/src/Makefile.am
index b5b8f08..cbe8a09 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -75,12 +75,19 @@ BUILT_SOURCES = \
ck-marshal.h \
$(NULL)
-ck-manager-glue.h: ck-manager.xml Makefile.am
- dbus-binding-tool --prefix=ck_manager --mode=glib-server --output=ck-manager-glue.h ck-manager.xml
-ck-seat-glue.h: ck-seat.xml Makefile.am
- dbus-binding-tool --prefix=ck_seat --mode=glib-server --output=ck-seat-glue.h ck-seat.xml
-ck-session-glue.h: ck-session.xml Makefile.am
- dbus-binding-tool --prefix=ck_session --mode=glib-server --output=ck-session-glue.h ck-session.xml
+dbusifdir = $(datadir)/dbus-1/interfaces
+dbusif_DATA = \
+ org.freedesktop.ConsoleKit.Manager.xml \
+ org.freedesktop.ConsoleKit.Seat.xml \
+ org.freedesktop.ConsoleKit.Session.xml \
+ $(NULL)
+
+ck-manager-glue.h: org.freedesktop.ConsoleKit.Manager.xml Makefile.am
+ dbus-binding-tool --prefix=ck_manager --mode=glib-server --output=ck-manager-glue.h org.freedesktop.ConsoleKit.Manager.xml
+ck-seat-glue.h: org.freedesktop.ConsoleKit.Seat.xml Makefile.am
+ dbus-binding-tool --prefix=ck_seat --mode=glib-server --output=ck-seat-glue.h org.freedesktop.ConsoleKit.Seat.xml
+ck-session-glue.h: org.freedesktop.ConsoleKit.Session.xml Makefile.am
+ dbus-binding-tool --prefix=ck_session --mode=glib-server --output=ck-session-glue.h org.freedesktop.ConsoleKit.Session.xml
ck-marshal.c: ck-marshal.list
echo "#include \"ck-marshal.h\"" > $@ && \
@@ -183,9 +190,7 @@ test_tty_idle_monitor_LDADD = \
EXTRA_DIST = \
ck-marshal.list \
- ck-manager.xml \
- ck-seat.xml \
- ck-session.xml \
+ $(dbusif_DATA) \
valgrind.sh \
test-open-session \
test-open-session-with-parameters \
diff --git a/src/ck-manager.xml b/src/ck-manager.xml
deleted file mode 100644
index 0ca74fa..0000000
--- a/src/ck-manager.xml
+++ /dev/null
@@ -1,70 +0,0 @@
-<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<node name="/org/freedesktop/ConsoleKit/Manager">
- <interface name="org.freedesktop.ConsoleKit.Manager">
- <method name="Restart">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- </method>
- <method name="Stop">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- </method>
- <method name="OpenSession">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="cookie" direction="out" type="s"/>
- </method>
- <method name="OpenSessionWithParameters">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="parameters" direction="in" type="a(sv)"/>
- <arg name="cookie" direction="out" type="s"/>
- </method>
- <method name="CloseSession">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="cookie" direction="in" type="s"/>
- <arg name="result" direction="out" type="b"/>
- </method>
- <method name="GetSeats">
- <arg name="seats" direction="out" type="ao"/>
- </method>
- <method name="GetSessions">
- <arg name="sessions" direction="out" type="ao"/>
- </method>
- <method name="GetSessionForCookie">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="cookie" direction="in" type="s"/>
- <arg name="ssid" direction="out" type="o"/>
- </method>
- <method name="GetSessionForUnixProcess">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="pid" direction="in" type="u"/>
- <arg name="ssid" direction="out" type="o"/>
- </method>
- <method name="GetCurrentSession">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="ssid" direction="out" type="o"/>
- </method>
- <method name="GetSessionsForUnixUser">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="uid" direction="in" type="u"/>
- <arg name="sessions" direction="out" type="ao"/>
- </method>
- <method name="GetSessionsForUser">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="uid" direction="in" type="u"/>
- <arg name="sessions" direction="out" type="ao"/>
- </method>
- <method name="GetSystemIdleHint">
- <arg name="idle_hint" type="b" direction="out"/>
- </method>
- <method name="GetSystemIdleSinceHint">
- <arg name="iso8601_datetime" type="s" direction="out"/>
- </method>
- <signal name="SeatAdded">
- <arg name="sid" type="o"/>
- </signal>
- <signal name="SeatRemoved">
- <arg name="sid" type="o"/>
- </signal>
- <signal name="SystemIdleHintChanged">
- <arg name="hint" type="b"/>
- </signal>
- </interface>
-</node>
diff --git a/src/ck-seat.xml b/src/ck-seat.xml
deleted file mode 100644
index b66fcaa..0000000
--- a/src/ck-seat.xml
+++ /dev/null
@@ -1,39 +0,0 @@
-<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<node>
- <interface name="org.freedesktop.ConsoleKit.Seat">
- <method name="GetId">
- <arg name="sid" direction="out" type="o"/>
- </method>
- <method name="GetSessions">
- <arg name="sessions" direction="out" type="ao"/>
- </method>
- <method name="GetDevices">
- <arg name="devices" direction="out" type="a(ss)"/>
- </method>
- <method name="GetActiveSession">
- <arg name="ssid" direction="out" type="o"/>
- </method>
- <method name="CanActivateSessions">
- <arg name="can_activate" direction="out" type="b"/>
- </method>
- <method name="ActivateSession">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="ssid" direction="in" type="o"/>
- </method>
- <signal name="ActiveSessionChanged">
- <arg name="ssid" type="o"/>
- </signal>
- <signal name="SessionAdded">
- <arg name="ssid" type="o"/>
- </signal>
- <signal name="SessionRemoved">
- <arg name="ssid" type="o"/>
- </signal>
- <signal name="DeviceAdded">
- <arg name="device" type="(ss)"/>
- </signal>
- <signal name="DeviceRemoved">
- <arg name="device" type="(ss)"/>
- </signal>
- </interface>
-</node>
diff --git a/src/ck-session.xml b/src/ck-session.xml
deleted file mode 100644
index f2c1ef2..0000000
--- a/src/ck-session.xml
+++ /dev/null
@@ -1,81 +0,0 @@
-<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<node>
- <interface name="org.freedesktop.ConsoleKit.Session">
- <method name="GetId">
- <arg name="ssid" direction="out" type="o"/>
- </method>
- <method name="GetSeatId">
- <arg name="sid" direction="out" type="o"/>
- </method>
- <method name="GetSessionType">
- <arg name="type" direction="out" type="s"/>
- </method>
- <method name="GetUser">
- <arg name="uid" direction="out" type="u"/>
- </method>
- <method name="GetUnixUser">
- <arg name="uid" direction="out" type="u"/>
- </method>
- <method name="GetX11Display">
- <arg name="display" direction="out" type="s"/>
- </method>
- <method name="GetX11DisplayDevice">
- <arg name="x11_display_device" direction="out" type="s"/>
- </method>
- <method name="GetDisplayDevice">
- <arg name="display_device" direction="out" type="s"/>
- </method>
- <method name="GetRemoteHostName">
- <arg name="remote_host_name" direction="out" type="s"/>
- </method>
- <method name="GetLoginSessionId">
- <arg name="login_session_id" direction="out" type="s"/>
- </method>
- <method name="IsActive">
- <arg name="active" direction="out" type="b"/>
- </method>
- <method name="IsLocal">
- <arg name="local" direction="out" type="b"/>
- </method>
- <method name="GetCreationTime">
- <arg name="iso8601_datetime" type="s" direction="out"/>
- </method>
- <method name="Activate">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- </method>
- <method name="Lock">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- </method>
- <method name="Unlock">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- </method>
- <method name="GetIdleHint">
- <arg name="idle_hint" type="b" direction="out"/>
- </method>
- <method name="GetIdleSinceHint">
- <arg name="iso8601_datetime" type="s" direction="out"/>
- </method>
- <method name="SetIdleHint">
- <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
- <arg name="idle_hint" type="b" direction="in"/>
- </method>
- <signal name="ActiveChanged">
- <arg name="is_active" type="b"/>
- </signal>
- <signal name="IdleHintChanged">
- <arg name="hint" type="b"/>
- </signal>
- <signal name="Lock"/>
- <signal name="Unlock"/>
- <property name="unix-user" type="u" access="readwrite"/>
- <property name="user" type="u" access="readwrite"/>
- <property name="session-type" type="s" access="readwrite"/>
- <property name="remote-host-name" type="s" access="readwrite"/>
- <property name="display-device" type="s" access="readwrite"/>
- <property name="x11-display" type="s" access="readwrite"/>
- <property name="x11-display-device" type="s" access="readwrite"/>
- <property name="active" type="b" access="readwrite"/>
- <property name="is-local" type="b" access="readwrite"/>
- <property name="idle-hint" type="b" access="readwrite"/>
- </interface>
-</node>
diff --git a/doc/spec/ck-manager.xml b/src/org.freedesktop.ConsoleKit.Manager.xml
index f405c25..f405c25 100644
--- a/doc/spec/ck-manager.xml
+++ b/src/org.freedesktop.ConsoleKit.Manager.xml
diff --git a/doc/spec/ck-seat.xml b/src/org.freedesktop.ConsoleKit.Seat.xml
index 0e13a0f..0e13a0f 100644
--- a/doc/spec/ck-seat.xml
+++ b/src/org.freedesktop.ConsoleKit.Seat.xml
diff --git a/doc/spec/ck-session.xml b/src/org.freedesktop.ConsoleKit.Session.xml
index b6e1cdb..b6e1cdb 100644
--- a/doc/spec/ck-session.xml
+++ b/src/org.freedesktop.ConsoleKit.Session.xml