diff options
author | Michael Biebl <biebl@debian.org> | 2009-09-29 05:42:35 +0200 |
---|---|---|
committer | Michael Biebl <biebl@debian.org> | 2009-09-29 05:42:35 +0200 |
commit | 6e7c6dfda732880e6feaef53f8ff0aaf23b4d4d4 (patch) | |
tree | 2a1c65a64820b2b51ca96a1c539292613d035b6c /doc | |
parent | b78e497569d2fc75e25c65c3f9f78c8580887c0b (diff) | |
download | consolekit-6e7c6dfda732880e6feaef53f8ff0aaf23b4d4d4.tar.gz |
Imported Upstream version 0.3.1upstream/0.3.1
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.in | 29 | ||||
-rw-r--r-- | doc/dbus/ConsoleKit.xml | 16 | ||||
-rw-r--r-- | doc/dbus/ConsoleKit.xml.in | 12 | ||||
-rw-r--r-- | doc/dbus/Makefile.am | 5 | ||||
-rw-r--r-- | doc/dbus/Makefile.in | 41 | ||||
-rw-r--r-- | doc/dbus/ck-design.xml | 58 | ||||
-rw-r--r-- | doc/dbus/org.freedesktop.ConsoleKit.Manager.ref.xml | 109 | ||||
-rw-r--r-- | doc/dbus/org.freedesktop.ConsoleKit.Seat.ref.xml | 49 | ||||
-rw-r--r-- | doc/dbus/org.freedesktop.ConsoleKit.Session.ref.xml | 146 | ||||
-rw-r--r-- | doc/dbus/spec-to-docbook.xsl | 72 |
10 files changed, 333 insertions, 204 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in index 0715c94..1096b77 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.10.1 from Makefile.am. +# Makefile.in generated by automake 1.10.2 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, @@ -74,10 +74,6 @@ CONSOLE_KIT_LIBS = @CONSOLE_KIT_LIBS@ CONSOLE_KIT_PID_FILE = @CONSOLE_KIT_PID_FILE@ CPP = @CPP@ CPPFLAGS = @CPPFLAGS@ -CXX = @CXX@ -CXXCPP = @CXXCPP@ -CXXDEPMODE = @CXXDEPMODE@ -CXXFLAGS = @CXXFLAGS@ CYGPATH_W = @CYGPATH_W@ DATADIRNAME = @DATADIRNAME@ DBUS_CFLAGS = @DBUS_CFLAGS@ @@ -86,14 +82,13 @@ DEBUG_CFLAGS = @DEBUG_CFLAGS@ DEFS = @DEFS@ DEPDIR = @DEPDIR@ DSYMUTIL = @DSYMUTIL@ -ECHO = @ECHO@ +DUMPBIN = @DUMPBIN@ ECHO_C = @ECHO_C@ ECHO_N = @ECHO_N@ ECHO_T = @ECHO_T@ EGREP = @EGREP@ EXEEXT = @EXEEXT@ -F77 = @F77@ -FFLAGS = @FFLAGS@ +FGREP = @FGREP@ GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ GMOFILES = @GMOFILES@ @@ -111,12 +106,14 @@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ INSTOBJEXT = @INSTOBJEXT@ INTLLIBS = @INTLLIBS@ KVM_LIBS = @KVM_LIBS@ +LD = @LD@ LDFLAGS = @LDFLAGS@ LIBDBUS_CFLAGS = @LIBDBUS_CFLAGS@ LIBDBUS_LIBS = @LIBDBUS_LIBS@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ MAINT = @MAINT@ @@ -125,8 +122,12 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGFMT_OPTS = @MSGFMT_OPTS@ +NM = @NM@ NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ PACKAGE_NAME = @PACKAGE_NAME@ @@ -156,6 +157,7 @@ VERSION = @VERSION@ WARN_CFLAGS = @WARN_CFLAGS@ XGETTEXT = @XGETTEXT@ XMLTO = @XMLTO@ +XMLTO_FLAGS = @XMLTO_FLAGS@ XSLTPROC = @XSLTPROC@ Z_LIBS = @Z_LIBS@ abs_builddir = @abs_builddir@ @@ -163,8 +165,7 @@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ abs_top_srcdir = @abs_top_srcdir@ ac_ct_CC = @ac_ct_CC@ -ac_ct_CXX = @ac_ct_CXX@ -ac_ct_F77 = @ac_ct_F77@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ am__include = @am__include@ am__leading_dot = @am__leading_dot@ am__quote = @am__quote@ @@ -195,6 +196,7 @@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ localstatedir = @localstatedir@ +lt_ECHO = @lt_ECHO@ mandir = @mandir@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ @@ -207,6 +209,7 @@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ SUBDIRS = dbus @@ -217,8 +220,8 @@ $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__confi @for dep in $?; do \ case '$(am__configure_deps)' in \ *$$dep*) \ - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ - && exit 0; \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ exit 1;; \ esac; \ done; \ @@ -324,7 +327,7 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ END { if (nonempty) { for (i in files) print i; }; }'`; \ mkid -fID $$unique tags: TAGS diff --git a/doc/dbus/ConsoleKit.xml b/doc/dbus/ConsoleKit.xml index 49c40b8..d898050 100644 --- a/doc/dbus/ConsoleKit.xml +++ b/doc/dbus/ConsoleKit.xml @@ -1,17 +1,17 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY dbus-Manager SYSTEM "org.freedesktop.ConsoleKit.Manager.ref.xml"> -<!ENTITY dbus-Seat SYSTEM "org.freedesktop.ConsoleKit.Seat.ref.xml"> -<!ENTITY dbus-Session SYSTEM "org.freedesktop.ConsoleKit.Session.ref.xml"> -<!ENTITY Intro SYSTEM "ck-introduction.xml"> -<!ENTITY Terms SYSTEM "ck-terms.xml"> -<!ENTITY Design SYSTEM "ck-design.xml"> +<!ENTITY dbus-Manager SYSTEM "./org.freedesktop.ConsoleKit.Manager.ref.xml"> +<!ENTITY dbus-Seat SYSTEM "./org.freedesktop.ConsoleKit.Seat.ref.xml"> +<!ENTITY dbus-Session SYSTEM "./org.freedesktop.ConsoleKit.Session.ref.xml"> +<!ENTITY Intro SYSTEM "./ck-introduction.xml"> +<!ENTITY Terms SYSTEM "./ck-terms.xml"> +<!ENTITY Design SYSTEM "./ck-design.xml"> ]> <book id="index"> <bookinfo> - <title>ConsoleKit 0.3.0 Documentation</title> - <releaseinfo>Version 0.3.0</releaseinfo> + <title>ConsoleKit 0.3.1 Documentation</title> + <releaseinfo>Version 0.3.1</releaseinfo> <date>8 March, 2007</date> <authorgroup> <author> diff --git a/doc/dbus/ConsoleKit.xml.in b/doc/dbus/ConsoleKit.xml.in index 0f05d02..403e7d0 100644 --- a/doc/dbus/ConsoleKit.xml.in +++ b/doc/dbus/ConsoleKit.xml.in @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY dbus-Manager SYSTEM "org.freedesktop.ConsoleKit.Manager.ref.xml"> -<!ENTITY dbus-Seat SYSTEM "org.freedesktop.ConsoleKit.Seat.ref.xml"> -<!ENTITY dbus-Session SYSTEM "org.freedesktop.ConsoleKit.Session.ref.xml"> -<!ENTITY Intro SYSTEM "ck-introduction.xml"> -<!ENTITY Terms SYSTEM "ck-terms.xml"> -<!ENTITY Design SYSTEM "ck-design.xml"> +<!ENTITY dbus-Manager SYSTEM "@srcdir@/org.freedesktop.ConsoleKit.Manager.ref.xml"> +<!ENTITY dbus-Seat SYSTEM "@srcdir@/org.freedesktop.ConsoleKit.Seat.ref.xml"> +<!ENTITY dbus-Session SYSTEM "@srcdir@/org.freedesktop.ConsoleKit.Session.ref.xml"> +<!ENTITY Intro SYSTEM "@srcdir@/ck-introduction.xml"> +<!ENTITY Terms SYSTEM "@srcdir@/ck-terms.xml"> +<!ENTITY Design SYSTEM "@srcdir@/ck-design.xml"> ]> <book id="index"> diff --git a/doc/dbus/Makefile.am b/doc/dbus/Makefile.am index d8bb0ee..4f8f3e7 100644 --- a/doc/dbus/Makefile.am +++ b/doc/dbus/Makefile.am @@ -16,7 +16,7 @@ htmldocdir = $(docdir)/spec htmldoc_DATA = ConsoleKit.html ConsoleKit.html : $(SPEC_XML_FILES) - $(XMLTO) xhtml-nochunks -m $(top_srcdir)/doc/dbus/config.xsl ConsoleKit.xml + $(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks -m $(top_srcdir)/doc/dbus/config.xsl ConsoleKit.xml endif # DOCBOOK_DOCS_ENABLED @@ -44,3 +44,6 @@ MAINTAINERCLEANFILES = \ clean-local: rm -f *~ *.ref.xml rm -f ConsoleKit.html + +check-local: + xmllint --noout --noent --valid ConsoleKit.xml diff --git a/doc/dbus/Makefile.in b/doc/dbus/Makefile.in index 1d23ae4..795c69f 100644 --- a/doc/dbus/Makefile.in +++ b/doc/dbus/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.10.1 from Makefile.am. +# Makefile.in generated by automake 1.10.2 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, @@ -73,10 +73,6 @@ CONSOLE_KIT_LIBS = @CONSOLE_KIT_LIBS@ CONSOLE_KIT_PID_FILE = @CONSOLE_KIT_PID_FILE@ CPP = @CPP@ CPPFLAGS = @CPPFLAGS@ -CXX = @CXX@ -CXXCPP = @CXXCPP@ -CXXDEPMODE = @CXXDEPMODE@ -CXXFLAGS = @CXXFLAGS@ CYGPATH_W = @CYGPATH_W@ DATADIRNAME = @DATADIRNAME@ DBUS_CFLAGS = @DBUS_CFLAGS@ @@ -85,14 +81,13 @@ DEBUG_CFLAGS = @DEBUG_CFLAGS@ DEFS = @DEFS@ DEPDIR = @DEPDIR@ DSYMUTIL = @DSYMUTIL@ -ECHO = @ECHO@ +DUMPBIN = @DUMPBIN@ ECHO_C = @ECHO_C@ ECHO_N = @ECHO_N@ ECHO_T = @ECHO_T@ EGREP = @EGREP@ EXEEXT = @EXEEXT@ -F77 = @F77@ -FFLAGS = @FFLAGS@ +FGREP = @FGREP@ GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ GMOFILES = @GMOFILES@ @@ -110,12 +105,14 @@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ INSTOBJEXT = @INSTOBJEXT@ INTLLIBS = @INTLLIBS@ KVM_LIBS = @KVM_LIBS@ +LD = @LD@ LDFLAGS = @LDFLAGS@ LIBDBUS_CFLAGS = @LIBDBUS_CFLAGS@ LIBDBUS_LIBS = @LIBDBUS_LIBS@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ MAINT = @MAINT@ @@ -124,8 +121,12 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGFMT_OPTS = @MSGFMT_OPTS@ +NM = @NM@ NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ PACKAGE_NAME = @PACKAGE_NAME@ @@ -155,6 +156,7 @@ VERSION = @VERSION@ WARN_CFLAGS = @WARN_CFLAGS@ XGETTEXT = @XGETTEXT@ XMLTO = @XMLTO@ +XMLTO_FLAGS = @XMLTO_FLAGS@ XSLTPROC = @XSLTPROC@ Z_LIBS = @Z_LIBS@ abs_builddir = @abs_builddir@ @@ -162,8 +164,7 @@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ abs_top_srcdir = @abs_top_srcdir@ ac_ct_CC = @ac_ct_CC@ -ac_ct_CXX = @ac_ct_CXX@ -ac_ct_F77 = @ac_ct_F77@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ am__include = @am__include@ am__leading_dot = @am__leading_dot@ am__quote = @am__quote@ @@ -194,6 +195,7 @@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ localstatedir = @localstatedir@ +lt_ECHO = @lt_ECHO@ mandir = @mandir@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ @@ -206,6 +208,7 @@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ NULL = @@ -241,8 +244,8 @@ $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__confi @for dep in $?; do \ case '$(am__configure_deps)' in \ *$$dep*) \ - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ - && exit 0; \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ exit 1;; \ esac; \ done; \ @@ -325,6 +328,7 @@ distdir: $(DISTFILES) fi; \ done check-am: all-am + $(MAKE) $(AM_MAKEFLAGS) check-local check: check-am all-am: Makefile $(DATA) installdirs: @@ -412,10 +416,10 @@ uninstall-am: uninstall-htmldocDATA .MAKE: install-am install-strip -.PHONY: all all-am check check-am clean clean-generic clean-libtool \ - clean-local distclean distclean-generic distclean-libtool \ - distdir dvi dvi-am html html-am info info-am install \ - install-am install-data install-data-am install-dvi \ +.PHONY: all all-am check check-am check-local clean clean-generic \ + clean-libtool clean-local distclean distclean-generic \ + distclean-libtool distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ install-dvi-am install-exec install-exec-am install-html \ install-html-am install-htmldocDATA install-info \ install-info-am install-man install-pdf install-pdf-am \ @@ -427,7 +431,7 @@ uninstall-am: uninstall-htmldocDATA @DOCBOOK_DOCS_ENABLED_TRUE@ConsoleKit.html : $(SPEC_XML_FILES) -@DOCBOOK_DOCS_ENABLED_TRUE@ $(XMLTO) xhtml-nochunks -m $(top_srcdir)/doc/dbus/config.xsl ConsoleKit.xml +@DOCBOOK_DOCS_ENABLED_TRUE@ $(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks -m $(top_srcdir)/doc/dbus/config.xsl ConsoleKit.xml org.freedesktop.ConsoleKit.Manager.ref.xml : $(top_srcdir)/src/org.freedesktop.ConsoleKit.Manager.xml spec-to-docbook.xsl $(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 > $@ @@ -440,6 +444,9 @@ org.freedesktop.ConsoleKit.Session.ref.xml : $(top_srcdir)/src/org.freedesktop.C clean-local: rm -f *~ *.ref.xml rm -f ConsoleKit.html + +check-local: + xmllint --noout --noent --valid ConsoleKit.xml # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/doc/dbus/ck-design.xml b/doc/dbus/ck-design.xml index 1148773..8aca968 100644 --- a/doc/dbus/ck-design.xml +++ b/doc/dbus/ck-design.xml @@ -38,16 +38,16 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To open a new Session. + <simpara>To open a new Session.</simpara> </listitem> <listitem> - To set properties for the Session. + <simpara>To set properties for the Session.</simpara> </listitem> <listitem> - To maintain a connection to the D-Bus system bus. + <simpara>To maintain a connection to the D-Bus system bus.</simpara> </listitem> <listitem> - To close the Session at logout. + <simpara>To close the Session at logout.</simpara> </listitem> </orderedlist> </sect2> @@ -58,25 +58,25 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To determine which Seat it is running on. + <simpara>To determine which Seat it is running on.</simpara> </listitem> <listitem> - To know if the current seat supports session switching. + <simpara>To know if the current seat supports session switching.</simpara> </listitem> <listitem> - A list of all sessions on the current Seat. + <simpara>A list of all sessions on the current Seat.</simpara> </listitem> <listitem> - To know which session is active for the current Seat. + <simpara>To know which session is active for the current Seat.</simpara> </listitem> <listitem> - To know when the session active state changes. + <simpara>To know when the session active state changes.</simpara> </listitem> <listitem> - To know when sessions are added or removed. + <simpara>To know when sessions are added or removed.</simpara> </listitem> <listitem> - Access to the metadata for any open Session. + <simpara>Access to the metadata for any open Session.</simpara> </listitem> </orderedlist> </sect2> @@ -87,10 +87,10 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To know if any user sessions are open. + <simpara>To know if any user sessions are open.</simpara> </listitem> <listitem> - To know if the system is currently being used. + <simpara>To know if the system is currently being used.</simpara> </listitem> </orderedlist> </sect2> @@ -101,16 +101,16 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To determine what hardware is associated with a Seat. + <simpara>To determine what hardware is associated with a Seat.</simpara> </listitem> <listitem> - To determine what Session is active and inactive on a particular Seat. + <simpara>To determine what Session is active and inactive on a particular Seat.</simpara> </listitem> <listitem> - To know when the session active state changes. + <simpara>To know when the session active state changes.</simpara> </listitem> <listitem> - To determine what Session a process belongs to. + <simpara>To determine what Session a process belongs to.</simpara> </listitem> </orderedlist> </sect2> @@ -121,28 +121,28 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To determine which session it is running in. + <simpara>To determine which session it is running in.</simpara> </listitem> <listitem> - To determine which Seat it is running on. + <simpara>To determine which Seat it is running on.</simpara> </listitem> <listitem> - To know if the current seat supports session switching. + <simpara>To know if the current seat supports session switching.</simpara> </listitem> <listitem> - A list of all sessions on the current Seat. + <simpara>A list of all sessions on the current Seat.</simpara> </listitem> <listitem> - Which session is active for the current Seat. + <simpara>Which session is active for the current Seat.</simpara> </listitem> <listitem> - To know when the session active state changes. + <simpara>To know when the session active state changes.</simpara> </listitem> <listitem> - Access to the metadata for any open Session. + <simpara>Access to the metadata for any open Session.</simpara> </listitem> <listitem> - To know when sessions are added or removed. + <simpara>To know when sessions are added or removed.</simpara> </listitem> </orderedlist> </sect2> @@ -153,10 +153,10 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To determine which session it is running in. + <simpara>To determine which session it is running in.</simpara> </listitem> <listitem> - To know when the session active state changes. + <simpara>To know when the session active state changes.</simpara> </listitem> </orderedlist> </sect2> @@ -167,10 +167,10 @@ The Session will remain open until the Session Leader disconnects from the D-Bus </para> <orderedlist> <listitem> - To determine which session it is running in. + <simpara>To determine which session it is running in.</simpara> </listitem> <listitem> - To know when the session active state changes. + <simpara>To know when the session active state changes.</simpara> </listitem> </orderedlist> </sect2> diff --git a/doc/dbus/org.freedesktop.ConsoleKit.Manager.ref.xml b/doc/dbus/org.freedesktop.ConsoleKit.Manager.ref.xml index d165619..64237a8 100644 --- a/doc/dbus/org.freedesktop.ConsoleKit.Manager.ref.xml +++ b/doc/dbus/org.freedesktop.ConsoleKit.Manager.ref.xml @@ -9,7 +9,9 @@ <refsynopsisdiv role="synopsis"> <title role="synopsis.title">Methods</title> <synopsis><link linkend="Manager.Restart">Restart</link> () +<link linkend="Manager.CanRestart">CanRestart</link> (out 'b' can_restart) <link linkend="Manager.Stop">Stop</link> () +<link linkend="Manager.CanStop">CanStop</link> (out 'b' can_stop) <link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie) <link linkend="Manager.OpenSessionWithParameters">OpenSessionWithParameters</link> (in 'a(sv)' parameters, out 's' cookie) @@ -49,11 +51,47 @@ <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> + <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> <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> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager.CanRestart"/>CanRestart ()</title> + <indexterm> + <primary>CanRestart</primary> + <secondary>Manager</secondary> + </indexterm> + <programlisting>CanRestart (out 'b' can_restart)</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>can_restart</parameter>:</term> + <listitem> + <simpara/> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + <refsect2><title><anchor role="function" id="Manager.Stop"/>Stop ()</title><indexterm><primary>Stop</primary><secondary>Manager</secondary></indexterm><programlisting>Stop ()</programlisting> <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> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager.CanStop"/>CanStop ()</title> + <indexterm> + <primary>CanStop</primary> + <secondary>Manager</secondary> + </indexterm> + <programlisting>CanStop (out 'b' can_stop)</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>can_stop</parameter>:</term> + <listitem> + <simpara/> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + <refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting> <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. @@ -100,8 +138,9 @@ </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> +<link linkend="Manager.OpenSessionWithParameters"><function>OpenSessionWithParameters()</function></link></para></refsect2> + <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> <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. @@ -115,38 +154,44 @@ See also: 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><refsect3><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></refsect3><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><note><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></note><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> +<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para></refsect2> + <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> <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> + <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> + <refsect2><title><anchor role="function" id="Manager.GetSeats"/>GetSeats ()</title><indexterm><primary>GetSeats</primary><secondary>Manager</secondary></indexterm><programlisting>GetSeats (out 'ao' seats)</programlisting> <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> +<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para></refsect2> + <refsect2><title><anchor role="function" id="Manager.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting> + <para>This gets a list of all the <link linkend="Session">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> +<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para></refsect2> + <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> <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> + <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> + <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> <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> + <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> + <refsect2><title><anchor role="function" id="Manager.GetCurrentSession"/>GetCurrentSession ()</title><indexterm><primary>GetCurrentSession</primary><secondary>Manager</secondary></indexterm><programlisting>GetCurrentSession (out 'o' ssid)</programlisting> <para>Attempts to determine the session ID that the caller belongs to. </para> <para>See this example of using dbus-send: @@ -156,14 +201,16 @@ See also: /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> + <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>The object identifier for the current session</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <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> + <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> <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 @@ -171,23 +218,31 @@ See also: <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> +instead.</para></warning></para></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>idle_hint</parameter>:</term><listitem><simpara>The value of the system-idle-hint</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist></refsect2> + </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> <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> + <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>The Seat ID for the added seat</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>The Seat ID for the removed seat</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>hint</parameter>:</term><listitem><simpara>The value of the system-idle-hint</simpara></listitem></varlistentry></variablelist></refsect2> + </refsect1> </refentry> diff --git a/doc/dbus/org.freedesktop.ConsoleKit.Seat.ref.xml b/doc/dbus/org.freedesktop.ConsoleKit.Seat.ref.xml index 6ec0bef..39ce3c6 100644 --- a/doc/dbus/org.freedesktop.ConsoleKit.Seat.ref.xml +++ b/doc/dbus/org.freedesktop.ConsoleKit.Seat.ref.xml @@ -33,49 +33,62 @@ org.freedesktop.DBus.Properties </para> </refsect1> - <refsect1 role="desc"> - <title role="desc.title">Description</title> - <para> + <refsect1 role="desc"><title role="desc.title">Description</title> <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> + </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> + <para>Returns the ID for Seat.</para> + <variablelist role="params"><varlistentry><term><parameter>sid</parameter>:</term><listitem><simpara>Seat ID</simpara></listitem></varlistentry></variablelist></refsect2> + <refsect2><title><anchor role="function" id="Seat.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Seat</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting> <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> + <variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>devices</parameter>:</term><listitem><simpara>an array of devices</simpara></listitem></varlistentry></variablelist></refsect2> + <refsect2><title><anchor role="function" id="Seat.GetActiveSession"/>GetActiveSession ()</title><indexterm><primary>GetActiveSession</primary><secondary>Seat</secondary></indexterm><programlisting>GetActiveSession (out 'o' ssid)</programlisting> <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> + <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist></refsect2> + <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><para>Used to determine whether the seat supports session activation.</para> + <variablelist role="params"><varlistentry><term><parameter>can_activate</parameter>:</term><listitem><simpara>TRUE if seat supports session activation</simpara></listitem></varlistentry></variablelist></refsect2> + <refsect2><title><anchor role="function" id="Seat.ActivateSession"/>ActivateSession ()</title><indexterm><primary>ActivateSession</primary><secondary>Seat</secondary></indexterm><programlisting>ActivateSession (in 'o' ssid)</programlisting> <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> +<link linkend="Session.Activate"><function>Activate()</function></link></para></refsect2> + </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> <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> + <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Device structure</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Device structure</simpara></listitem></varlistentry></variablelist></refsect2> + </refsect1> </refentry> diff --git a/doc/dbus/org.freedesktop.ConsoleKit.Session.ref.xml b/doc/dbus/org.freedesktop.ConsoleKit.Session.ref.xml index 638ab72..59f3c17 100644 --- a/doc/dbus/org.freedesktop.ConsoleKit.Session.ref.xml +++ b/doc/dbus/org.freedesktop.ConsoleKit.Session.ref.xml @@ -59,9 +59,7 @@ <link linkend="Session:idle-hint">'idle-hint'</link> readwrite 'b' </synopsis> </refsect1> - <refsect1 role="desc"> - <title role="desc.title">Description</title> - <para> + <refsect1 role="desc"><title role="desc.title">Description</title> <para>Session objects represent and store information related to a user session. @@ -70,133 +68,164 @@ 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 + </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><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> + <refsect2><title><anchor role="function" id="Session.GetSeatId"/>GetSeatId ()</title><indexterm><primary>GetSeatId</primary><secondary>Session</secondary></indexterm><programlisting>GetSeatId (out 'o' sid)</programlisting><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> +<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.GetSessionType"/>GetSessionType ()</title><indexterm><primary>GetSessionType</primary><secondary>Session</secondary></indexterm><programlisting>GetSessionType (out 's' type)</programlisting> <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> +<link linkend="Session:session-type"><literal>session-type</literal></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.GetUser"/>GetUser ()</title><indexterm><primary>GetUser</primary><secondary>Session</secondary></indexterm><programlisting>GetUser (out 'u' uid)</programlisting><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> +<link linkend="Session:user"><literal>user</literal></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.GetUnixUser"/>GetUnixUser ()</title><indexterm><primary>GetUnixUser</primary><secondary>Session</secondary></indexterm><programlisting>GetUnixUser (out 'u' uid)</programlisting><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 +<link linkend="Session:unix-user"><literal>unix-user</literal></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.GetX11Display"/>GetX11Display ()</title><indexterm><primary>GetX11Display</primary><secondary>Session</secondary></indexterm><programlisting>GetX11Display (out 's' display)</programlisting><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 +<link linkend="Session:x11-display"><literal>x11-display</literal></link></para></refsect2> + <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><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 +<link linkend="Session:x11-display-device"><literal>x11-display-device</literal></link></para></refsect2> + <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><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. +<link linkend="Session:display-device"><literal>display-device</literal></link></para></refsect2> + <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><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 +<link linkend="Session:remote-host-name"><literal>remote-host-name</literal></link></para></refsect2> + <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><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 + <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> + <refsect2><title><anchor role="function" id="Session.IsActive"/>IsActive ()</title><indexterm><primary>IsActive</primary><secondary>Session</secondary></indexterm><programlisting>IsActive (out 'b' active)</programlisting><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> +<link linkend="Session:active"><literal>active</literal></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.IsLocal"/>IsLocal ()</title><indexterm><primary>IsLocal</primary><secondary>Session</secondary></indexterm><programlisting>IsLocal (out 'b' local)</programlisting><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> +<link linkend="Session:is-local"><literal>is-local</literal></link></para></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist></refsect2> + <refsect2><title><anchor role="function" id="Session.Activate"/>Activate ()</title><indexterm><primary>Activate</primary><secondary>Session</secondary></indexterm><programlisting>Activate ()</programlisting> <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> + <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> +<link linkend="Seat.ActivateSession"><function>Seat.ActivateSession()</function></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.Lock"/>Lock ()</title><indexterm><primary>Lock</primary><secondary>Session</secondary></indexterm><programlisting>Lock ()</programlisting> <para>This will cause a <link linkend="Session::Lock"><literal>Lock</literal></link> signal to be emitted for this session. </para> - <variablelist role="params"/><refsect3><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></refsect3><para> + <note><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></note><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> +<link linkend="Session::Lock"><literal>Lock signal</literal></link></para></refsect2> + <refsect2><title><anchor role="function" id="Session.Unlock"/>Unlock ()</title><indexterm><primary>Unlock</primary><secondary>Session</secondary></indexterm><programlisting>Unlock ()</programlisting> <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"/><refsect3><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></refsect3><para> + <note><title>Permissions</title><para role="permission">This method is restricted to privileged users by D-Bus policy.</para></note><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> +<link linkend="Session::Unlock"><literal>Unlock signal</literal></link></para></refsect2> + <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> <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> +<link linkend="Session:idle-hint"><literal>idle-hint</literal></link></para></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>iso8601_datetime</parameter>:</term><listitem><simpara>An ISO 8601 format date-type string</simpara></listitem></varlistentry></variablelist></refsect2> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>idle_hint</parameter>:</term><listitem><simpara>boolean value to set the idle-hint to</simpara></listitem></varlistentry></variablelist></refsect2> + </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> <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> + <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> + <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> <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> + <variablelist role="params"><varlistentry><term><parameter>hint</parameter>:</term><listitem><simpara>the new value of idle-hint</simpara></listitem></varlistentry></variablelist></refsect2> + <refsect2><title><anchor role="function" id="Session::Lock"/>The Lock signal</title><indexterm><primary>Lock</primary><secondary>Session</secondary></indexterm><programlisting>Lock ()</programlisting> <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> + </refsect2> + <refsect2><title><anchor role="function" id="Session::Unlock"/>The Unlock signal</title><indexterm><primary>Unlock</primary><secondary>Session</secondary></indexterm><programlisting>Unlock ()</programlisting> <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> + </refsect2> + </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> <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> + </refsect2> + <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> <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 + <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> +instead.</para></warning></para></refsect2> + <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> <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> + </refsect2> + <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> <para>The remote host name for the session. </para> <para>This will be set in situations where the session is @@ -205,40 +234,46 @@ instead.</para></warning></para><refsect2><title><anchor role="function" id="Ses <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> + </refsect2> + <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> <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> + </refsect2> + <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> <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> + </refsect2> + <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> <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> + </refsect2> + <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> <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> + </refsect2> + <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> <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> + </refsect2> + <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> <para> This is a hint used to indicate that the session may be idle. </para> @@ -255,5 +290,6 @@ instead.</para></warning></para><refsect2><title><anchor role="function" id="Ses <para> This should not be considered authoritative. </para> - <variablelist role="params"/></refsect1> + </refsect2> + </refsect1> </refentry> diff --git a/doc/dbus/spec-to-docbook.xsl b/doc/dbus/spec-to-docbook.xsl index 1864414..f69bebd 100644 --- a/doc/dbus/spec-to-docbook.xsl +++ b/doc/dbus/spec-to-docbook.xsl @@ -74,9 +74,15 @@ <refsect1 role="desc"> <title role="desc.title">Description</title> - <para> - <xsl:apply-templates select="//interface/doc:doc"/> - </para> + <xsl:choose> + <xsl:when test="count(//interface/doc:doc) > 0"> + <xsl:apply-templates select="//interface/doc:doc"/> + </xsl:when> + <xsl:otherwise> + <para> + </para> + </xsl:otherwise> + </xsl:choose> </refsect1> <refsect1 role="details"> @@ -115,13 +121,17 @@ <xsl:template name="property-doc"> <xsl:apply-templates select="doc:doc/doc:description"/> - <variablelist role="params"> - <xsl:for-each select="arg"> + <xsl:choose> + <xsl:when test="count(arg) > 0"> + <variablelist role="params"> + <xsl:for-each select="arg"> <varlistentry><term><parameter><xsl:value-of select="@name"/></parameter>:</term> <listitem><simpara><xsl:value-of select="doc:doc/doc:summary"/></simpara></listitem> </varlistentry> - </xsl:for-each> - </variablelist> + </xsl:for-each> + </variablelist> + </xsl:when> + </xsl:choose> <xsl:apply-templates select="doc:doc/doc:since"/> <xsl:apply-templates select="doc:doc/doc:deprecated"/> @@ -143,23 +153,25 @@ <indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm> <programlisting>'<xsl:value-of select="@name"/>'<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="2"/></xsl:call-template> <xsl:call-template name="property-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/></xsl:call-template></programlisting> - </refsect2> - <xsl:call-template name="property-doc"/> - + </refsect2> </xsl:for-each> </xsl:template> <xsl:template name="signal-doc"> <xsl:apply-templates select="doc:doc/doc:description"/> - <variablelist role="params"> - <xsl:for-each select="arg"> + <xsl:choose> + <xsl:when test="count(arg) > 0"> + <variablelist role="params"> + <xsl:for-each select="arg"> <varlistentry><term><parameter><xsl:value-of select="@name"/></parameter>:</term> <listitem><simpara><xsl:value-of select="doc:doc/doc:summary"/></simpara></listitem> </varlistentry> - </xsl:for-each> - </variablelist> + </xsl:for-each> + </variablelist> + </xsl:when> + </xsl:choose> <xsl:apply-templates select="doc:doc/doc:since"/> <xsl:apply-templates select="doc:doc/doc:deprecated"/> @@ -179,10 +191,8 @@ <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>::<xsl:value-of select="@name"/></xsl:attribute></anchor>The <xsl:value-of select="@name"/> signal</title> <indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm> <programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting> - </refsect2> - <xsl:call-template name="signal-doc"/> - + </refsect2> </xsl:for-each> </xsl:template> @@ -238,10 +248,10 @@ <xsl:template name="do-listitems"> <xsl:for-each select="doc:item"> - <listitem> + <listitem><para> <xsl:call-template name="listitems-do-term"><xsl:with-param name="str" select="doc:term"/></xsl:call-template> <xsl:apply-templates select="doc:definition"/> - </listitem> + </para></listitem> </xsl:for-each> </xsl:template> @@ -371,20 +381,24 @@ See also: <xsl:template name="method-doc"> <xsl:apply-templates select="doc:doc/doc:description"/> - <variablelist role="params"> - <xsl:for-each select="arg"> + <xsl:choose> + <xsl:when test="count(arg) > 0"> + <variablelist role="params"> + <xsl:for-each select="arg"> <varlistentry><term><parameter><xsl:value-of select="@name"/></parameter>:</term> <listitem><simpara><xsl:apply-templates select="doc:doc/doc:summary"/></simpara></listitem> </varlistentry> - </xsl:for-each> - </variablelist> + </xsl:for-each> + </variablelist> + </xsl:when> + </xsl:choose> <xsl:apply-templates select="doc:doc/doc:since"/> <xsl:apply-templates select="doc:doc/doc:deprecated"/> <xsl:choose> <xsl:when test="count(doc:doc/doc:errors) > 0"> - <refsect3> + <note> <title>Errors</title> <variablelist role="errors"> <xsl:for-each select="doc:doc/doc:errors/doc:error"> @@ -394,16 +408,16 @@ See also: </varlistentry> </xsl:for-each> </variablelist> - </refsect3> + </note> </xsl:when> </xsl:choose> <xsl:choose> <xsl:when test="count(doc:doc/doc:permission) > 0"> - <refsect3> + <note> <title>Permissions</title> <xsl:apply-templates select="doc:doc/doc:permission"/> - </refsect3> + </note> </xsl:when> </xsl:choose> @@ -422,10 +436,8 @@ See also: <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>.<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> ()</title> <indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm> <programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="method-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting> - </refsect2> - <xsl:call-template name="method-doc"/> - + </refsect2> </xsl:for-each> </xsl:template> |