diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ConsoleKit.xml | 74 | ||||
| -rw-r--r-- | doc/ConsoleKit.xml.in | 74 | ||||
| -rw-r--r-- | doc/Makefile.am | 38 | ||||
| -rw-r--r-- | doc/Makefile.in | 434 | ||||
| -rw-r--r-- | doc/config.xsl | 6 | ||||
| -rw-r--r-- | doc/docbook.css | 78 | ||||
| -rw-r--r-- | doc/xml/ck-design.xml | 180 | ||||
| -rw-r--r-- | doc/xml/ck-introduction.xml | 28 | ||||
| -rw-r--r-- | doc/xml/ck-terms.xml | 67 | ||||
| -rw-r--r-- | doc/xml/ref-ck-manager.xml | 185 | ||||
| -rw-r--r-- | doc/xml/ref-ck-seat.xml | 74 | ||||
| -rw-r--r-- | doc/xml/ref-ck-session.xml | 254 |
12 files changed, 1492 insertions, 0 deletions
diff --git a/doc/ConsoleKit.xml b/doc/ConsoleKit.xml new file mode 100644 index 0000000..36869ca --- /dev/null +++ b/doc/ConsoleKit.xml @@ -0,0 +1,74 @@ +<?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 "xml/ref-ck-manager.xml"> +<!ENTITY dbus-Seat SYSTEM "xml/ref-ck-seat.xml"> +<!ENTITY dbus-Session SYSTEM "xml/ref-ck-session.xml"> +<!ENTITY Intro SYSTEM "xml/ck-introduction.xml"> +<!ENTITY Terms SYSTEM "xml/ck-terms.xml"> +<!ENTITY Design SYSTEM "xml/ck-design.xml"> +]> + +<book id="index"> + <bookinfo> + <title>ConsoleKit 0.2.1 Documentation</title> + <releaseinfo>Version 0.2.1</releaseinfo> + <date>8 March, 2007</date> + <authorgroup> + <author> + <firstname>William Jon</firstname> + <surname>McCann</surname> + <affiliation> + <address> + <email>mccann@jhu.edu</email> + </address> + </affiliation> + </author> + </authorgroup> + </bookinfo> + + <preface> + <title>Introduction</title> + <para> + </para> + </preface> + + <part> + <title>Concepts</title> + + &Intro; + &Terms; + &Design; + </part> + + <part> + <title>Reference</title> + + <reference id="dbus-reference"> + <title>D-Bus API Reference</title> + + <partintro> + <para> + ConsoleKit provides a D-Bus API for programs to obtain information about the + users, sessions, and seats that are present on a system. + </para> + <para> + Please see the other sections of this manual for an introduction to + these concepts. + </para> + <para> + This API is not yet stable and is likely to change in the future. + </para> + </partintro> + + &dbus-Manager; + &dbus-Seat; + &dbus-Session; + + </reference> + </part> + + <index> + <title>Index</title> + </index> + +</book> diff --git a/doc/ConsoleKit.xml.in b/doc/ConsoleKit.xml.in new file mode 100644 index 0000000..294c34c --- /dev/null +++ b/doc/ConsoleKit.xml.in @@ -0,0 +1,74 @@ +<?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 "xml/ref-ck-manager.xml"> +<!ENTITY dbus-Seat SYSTEM "xml/ref-ck-seat.xml"> +<!ENTITY dbus-Session SYSTEM "xml/ref-ck-session.xml"> +<!ENTITY Intro SYSTEM "xml/ck-introduction.xml"> +<!ENTITY Terms SYSTEM "xml/ck-terms.xml"> +<!ENTITY Design SYSTEM "xml/ck-design.xml"> +]> + +<book id="index"> + <bookinfo> + <title>ConsoleKit @VERSION@ Documentation</title> + <releaseinfo>Version @VERSION@</releaseinfo> + <date>8 March, 2007</date> + <authorgroup> + <author> + <firstname>William Jon</firstname> + <surname>McCann</surname> + <affiliation> + <address> + <email>mccann@jhu.edu</email> + </address> + </affiliation> + </author> + </authorgroup> + </bookinfo> + + <preface> + <title>Introduction</title> + <para> + </para> + </preface> + + <part> + <title>Concepts</title> + + &Intro; + &Terms; + &Design; + </part> + + <part> + <title>Reference</title> + + <reference id="dbus-reference"> + <title>D-Bus API Reference</title> + + <partintro> + <para> + ConsoleKit provides a D-Bus API for programs to obtain information about the + users, sessions, and seats that are present on a system. + </para> + <para> + Please see the other sections of this manual for an introduction to + these concepts. + </para> + <para> + This API is not yet stable and is likely to change in the future. + </para> + </partintro> + + &dbus-Manager; + &dbus-Seat; + &dbus-Session; + + </reference> + </part> + + <index> + <title>Index</title> + </index> + +</book> diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..43802fe --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,38 @@ +NULL = + +SPEC_XML_FILES = \ + ConsoleKit.xml \ + 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 \ + $(NULL) + +if DOCBOOK_DOCS_ENABLED + +htmldocdir = $(docdir)/spec +htmldoc_DATA = ConsoleKit.html + +ConsoleKit.html : $(SPEC_XML_FILES) + $(XMLTO) xhtml-nochunks -m config.xsl ConsoleKit.xml + +endif # DOCBOOK_DOCS_ENABLED + +EXTRA_DIST = \ + ConsoleKit.xml.in \ + config.xsl \ + docbook.css \ + $(SPEC_XML_FILES) + $(NULL) + + +MAINTAINERCLEANFILES = \ + *~ \ + Makefile.in \ + $(NULL) + +clean-local: + rm -f *~ + rm -f ConsoleKit.html diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..f12529c --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,434 @@ +# Makefile.in generated by automake 1.9.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = .. +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = doc +DIST_COMMON = $(srcdir)/ConsoleKit.xml.in $(srcdir)/Makefile.am \ + $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = ConsoleKit.xml +SOURCES = +DIST_SOURCES = +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; +am__installdirs = "$(DESTDIR)$(htmldocdir)" +htmldocDATA_INSTALL = $(INSTALL_DATA) +DATA = $(htmldoc_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMDEP_FALSE = @AMDEP_FALSE@ +AMDEP_TRUE = @AMDEP_TRUE@ +AMTAR = @AMTAR@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CK_BACKEND = @CK_BACKEND@ +CK_COMPILE_FREEBSD_FALSE = @CK_COMPILE_FREEBSD_FALSE@ +CK_COMPILE_FREEBSD_TRUE = @CK_COMPILE_FREEBSD_TRUE@ +CK_COMPILE_LINUX_FALSE = @CK_COMPILE_LINUX_FALSE@ +CK_COMPILE_LINUX_TRUE = @CK_COMPILE_LINUX_TRUE@ +CK_COMPILE_SOLARIS_FALSE = @CK_COMPILE_SOLARIS_FALSE@ +CK_COMPILE_SOLARIS_TRUE = @CK_COMPILE_SOLARIS_TRUE@ +CONSOLE_KIT_CFLAGS = @CONSOLE_KIT_CFLAGS@ +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@ +DBUS_SYS_DIR = @DBUS_SYS_DIR@ +DEBUG_CFLAGS = @DEBUG_CFLAGS@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DOCBOOK_DOCS_ENABLED_FALSE = @DOCBOOK_DOCS_ENABLED_FALSE@ +DOCBOOK_DOCS_ENABLED_TRUE = @DOCBOOK_DOCS_ENABLED_TRUE@ +ECHO = @ECHO@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +ENABLE_INOTIFY_FALSE = @ENABLE_INOTIFY_FALSE@ +ENABLE_INOTIFY_TRUE = @ENABLE_INOTIFY_TRUE@ +ENABLE_PAM_MODULE_FALSE = @ENABLE_PAM_MODULE_FALSE@ +ENABLE_PAM_MODULE_TRUE = @ENABLE_PAM_MODULE_TRUE@ +EXEEXT = @EXEEXT@ +F77 = @F77@ +FFLAGS = @FFLAGS@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +HAVE_PAM = @HAVE_PAM@ +HAVE_PAM_FALSE = @HAVE_PAM_FALSE@ +HAVE_PAM_TRUE = @HAVE_PAM_TRUE@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBDBUS_CFLAGS = @LIBDBUS_CFLAGS@ +LIBDBUS_LIBS = @LIBDBUS_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@ +MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@ +MAKEINFO = @MAKEINFO@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PAM_LIBS = @PAM_LIBS@ +PAM_MODULE_DIR = @PAM_MODULE_DIR@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +RANLIB = @RANLIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TOOLS_CFLAGS = @TOOLS_CFLAGS@ +TOOLS_LIBS = @TOOLS_LIBS@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +XGETTEXT = @XGETTEXT@ +XMLTO = @XMLTO@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_F77 = @ac_ct_F77@ +am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ +am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ +am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@ +am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +NULL = +SPEC_XML_FILES = \ + ConsoleKit.xml \ + 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 \ + $(NULL) + +@DOCBOOK_DOCS_ENABLED_TRUE@htmldocdir = $(docdir)/spec +@DOCBOOK_DOCS_ENABLED_TRUE@htmldoc_DATA = ConsoleKit.html +EXTRA_DIST = \ + ConsoleKit.xml.in \ + config.xsl \ + docbook.css \ + $(SPEC_XML_FILES) + +MAINTAINERCLEANFILES = \ + *~ \ + Makefile.in \ + $(NULL) + +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +ConsoleKit.xml: $(top_builddir)/config.status $(srcdir)/ConsoleKit.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +distclean-libtool: + -rm -f libtool +uninstall-info-am: +install-htmldocDATA: $(htmldoc_DATA) + @$(NORMAL_INSTALL) + test -z "$(htmldocdir)" || $(mkdir_p) "$(DESTDIR)$(htmldocdir)" + @list='$(htmldoc_DATA)'; for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + f=$(am__strip_dir) \ + echo " $(htmldocDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(htmldocdir)/$$f'"; \ + $(htmldocDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(htmldocdir)/$$f"; \ + done + +uninstall-htmldocDATA: + @$(NORMAL_UNINSTALL) + @list='$(htmldoc_DATA)'; for p in $$list; do \ + f=$(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(htmldocdir)/$$f'"; \ + rm -f "$(DESTDIR)$(htmldocdir)/$$f"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + $(mkdir_p) $(distdir)/xml + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkdir_p) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(htmldocdir)"; do \ + test -z "$$dir" || $(mkdir_p) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(MAINTAINERCLEANFILES)" || rm -f $(MAINTAINERCLEANFILES) +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-libtool + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-htmldocDATA + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-htmldocDATA uninstall-info-am + +.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-exec \ + install-exec-am install-htmldocDATA install-info \ + install-info-am install-man install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-htmldocDATA uninstall-info-am + + +@DOCBOOK_DOCS_ENABLED_TRUE@ConsoleKit.html : $(SPEC_XML_FILES) +@DOCBOOK_DOCS_ENABLED_TRUE@ $(XMLTO) xhtml-nochunks -m config.xsl ConsoleKit.xml + $(NULL) + +clean-local: + rm -f *~ + rm -f ConsoleKit.html +# 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/config.xsl b/doc/config.xsl new file mode 100644 index 0000000..7aa9def --- /dev/null +++ b/doc/config.xsl @@ -0,0 +1,6 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:fo="http://www.w3.org/1999/XSL/Format" + version="1.0"> + <xsl:param name="html.stylesheet" select="'docbook.css'"/> +</xsl:stylesheet> diff --git a/doc/docbook.css b/doc/docbook.css new file mode 100644 index 0000000..6a7373e --- /dev/null +++ b/doc/docbook.css @@ -0,0 +1,78 @@ +body +{ + font-family: sans-serif; +} +h1.title +{ +} +.permission +{ + color: #ee0000; + text-decoration: underline; +} +.synopsis, .classsynopsis +{ + background: #eeeeee; + border: solid 1px #aaaaaa; + padding: 0.5em; +} +.programlisting +{ + background: #eeeeff; + border: solid 1px #aaaaff; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} +td.shortcuts +{ + color: #770000; + font-size: 80%; +} +div.refnamediv +{ + margin-top: 2em; +} +div.toc +{ + border: 2em; +} +a +{ + text-decoration: none; +} +a:hover +{ + text-decoration: underline; + color: #FF0000; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + border-style: solid; + border-color: #777777; + border-width: 1px; +} + +div.table table td, div.table table th +{ + border-style: solid; + border-color: #777777; + border-width: 1px; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + background-color: #eeeeee; +} diff --git a/doc/xml/ck-design.xml b/doc/xml/ck-design.xml new file mode 100644 index 0000000..1148773 --- /dev/null +++ b/doc/xml/ck-design.xml @@ -0,0 +1,180 @@ +<chapter id="design"> + <title>Design</title> + + <sect1> + <title>Session Lifecycle</title> + <para> +The session leader process is responsible for asking +ConsoleKit to open a new session. In this respect, it is +similar to the traditional POSIX user login accounting framework. +In the typical case, the session leader is either an immediate descendant of +a login manager or the login manager itself. The leader makes a connection to the D-Bus system bus and asks ConsoleKit to open a session. There are two methods available for opening a session: org.freedesktop.ConsoleKit.Manager.OpenSession() and org.freedesktop.ConsoleKit.Manager.OpenSessionWithParameters(). + </para> + <para> +If the operation succeeds, a secret cookie will be returned to the session leader. The session leader should store this secret in the environment as XDG_SESSION_COOKIE so that it may be shared with its child processes. + </para> + <para> +At this point the session will be registered with ConsoleKit and a particular +set of information about the session will be stored along with it. + </para> + <para> +ConsoleKit will decide, based on the information associated with the session, what Seat the session will be added to. + </para> + <para> +It will also be determined, based on the same set of information, whether the Session will control the hardware associated with the Seat. In other words, whether the Session will be active for the Seat it is attached to. The exact mechanism for this determination depends on the type of Seat and the capabilities of the host system. + </para> + <para> +The Session will remain open until the Session Leader disconnects from the D-Bus system bus or calls org.freedesktop.ConsoleKit.Manager.CloseSession(). The session will be removed from its Seat, and deregistered. + </para> + </sect1> + + <sect1> + <title>Expected Usage</title> + <para>Use of this service will usually follow one of the following patterns:</para> + + <sect2> + <title>Text Login Manager</title> + <para>This pattern operates as the Session Leader for a new Session. This pattern needs: + </para> + <orderedlist> + <listitem> + To open a new Session. + </listitem> + <listitem> + To set properties for the Session. + </listitem> + <listitem> + To maintain a connection to the D-Bus system bus. + </listitem> + <listitem> + To close the Session at logout. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>Graphical Login Manager</title> + <para>In addition to the requirements for the Text Graphical Login Manager, this pattern is typically used to show information about currently open sessions. It needs: + </para> + <orderedlist> + <listitem> + To determine which Seat it is running on. + </listitem> + <listitem> + To know if the current seat supports session switching. + </listitem> + <listitem> + A list of all sessions on the current Seat. + </listitem> + <listitem> + To know which session is active for the current Seat. + </listitem> + <listitem> + To know when the session active state changes. + </listitem> + <listitem> + To know when sessions are added or removed. + </listitem> + <listitem> + Access to the metadata for any open Session. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>System Daemon</title> + <para>This is generally a daemon process running outside of a user session as a special user. This pattern needs: + </para> + <orderedlist> + <listitem> + To know if any user sessions are open. + </listitem> + <listitem> + To know if the system is currently being used. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>Hardware Abstraction Layer</title> + <para>This is a special case of System Daemon that provides catalogs and control mechanisms for hardware devices. In addition to the requirements of System Daemon, this pattern needs: + </para> + <orderedlist> + <listitem> + To determine what hardware is associated with a Seat. + </listitem> + <listitem> + To determine what Session is active and inactive on a particular Seat. + </listitem> + <listitem> + To know when the session active state changes. + </listitem> + <listitem> + To determine what Session a process belongs to. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>Fast User Switching Agent</title> + <para>This is related to the Graphical Login Manager and provides a shortcut to similar functionality. It is usually a tool available in the user session that allows one to quickly switch to another user session. This pattern needs: + </para> + <orderedlist> + <listitem> + To determine which session it is running in. + </listitem> + <listitem> + To determine which Seat it is running on. + </listitem> + <listitem> + To know if the current seat supports session switching. + </listitem> + <listitem> + A list of all sessions on the current Seat. + </listitem> + <listitem> + Which session is active for the current Seat. + </listitem> + <listitem> + To know when the session active state changes. + </listitem> + <listitem> + Access to the metadata for any open Session. + </listitem> + <listitem> + To know when sessions are added or removed. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>Session Daemon (aka Policy Agent)</title> + <para>This is typically a daemon running in a user session that acts on policy only when the session is active. This pattern needs: + </para> + <orderedlist> + <listitem> + To determine which session it is running in. + </listitem> + <listitem> + To know when the session active state changes. + </listitem> + </orderedlist> + </sect2> + + <sect2> + <title>Session Application</title> + <para>This is typically an application running in a user session that may alter its behavior when the session active state changes. This pattern needs: + </para> + <orderedlist> + <listitem> + To determine which session it is running in. + </listitem> + <listitem> + To know when the session active state changes. + </listitem> + </orderedlist> + </sect2> + + </sect1> + +</chapter> diff --git a/doc/xml/ck-introduction.xml b/doc/xml/ck-introduction.xml new file mode 100644 index 0000000..b38adf5 --- /dev/null +++ b/doc/xml/ck-introduction.xml @@ -0,0 +1,28 @@ +<chapter id="introduction"> + <title>Introduction</title> + + <sect1> + <title>About</title> + <para> + ConsoleKit is a framework for keeping track of the various + users, sessions, and seats present on a system. It + provides a mechanism for software to react to changes of any of + these items or of any of the metadata associated with them. + </para> + </sect1> + + <sect1> + <title>Defining the Problem</title> + <para> + To be written. + </para> + </sect1> + + <sect1> + <title>Relevant art</title> + <para> + To be written. + </para> + </sect1> + +</chapter> diff --git a/doc/xml/ck-terms.xml b/doc/xml/ck-terms.xml new file mode 100644 index 0000000..d3d544d --- /dev/null +++ b/doc/xml/ck-terms.xml @@ -0,0 +1,67 @@ +<chapter id="terms"> + <title>Terminology</title> + + <sect1> + <title>Session</title> + <para> +A session is a collection of all processes that share knowledge of a +secret. In the typical (or ideal) case, these processes all originate +from a single common ancestor. + </para> + <para> +As an implementation detail, for now, this secret should be stored in +the process environment by the session leader under the name +XDG_SESSION_COOKIE. When and if we are able to take advantage of a +mechanism in the underlying system to store session registration +information - we will. However, such a mechanism is not known at the +present time. + </para> + <para> +Using an environment variable does have certain advantages. For one, +it is quite easy for a process to opt-out of a Session by simply +unsetting the XDG_SESSION_COOKIE variable. + </para> + <para> +Limitations of using an environment variable implementation include +not being able to strictly limit visibility of the secret to a particular +process ancestry. So, it is not possible to enforce session boundaries +other than on a per-user basis. For example, we don't yet have a way +to prevent a process from moving between sessions owned by the same +user. + </para> + </sect1> + + <sect1> + <title>Session leader</title> + <para> +The session leader is the process that requests that a new session be +opened. It does this by connecting to the D-Bus system bus and using +either org.freedesktop.ConsoleKit.Manager.OpenSession() or +org.freedesktop.ConsoleKit.Manager.OpenSessionWithParameters(). The session +that it registers will remain open until the connection to the system +bus is lost or it calls org.freedesktop.ConsoleKit.Manager.CloseSession(). + </para> + <para> +The session leader is the only process for which CloseSession() will +be allowed. + </para> + </sect1> + + <sect1> + <title>Seat</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> +At the present time, all Sessions that are considered "local" to +a system will be added the the first Seat and every other Session +will be added to its own Seat. + </para> + <para> +True, hardware, multi-seat capabilities will be added in a later release. + </para> + </sect1> + +</chapter> diff --git a/doc/xml/ref-ck-manager.xml b/doc/xml/ref-ck-manager.xml new file mode 100644 index 0000000..2aceef8 --- /dev/null +++ b/doc/xml/ref-ck-manager.xml @@ -0,0 +1,185 @@ +<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.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.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.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 (&error); + reply = dbus_connection_send_with_reply_and_block (connector->connection, + message, + -1, + &error); + if (reply == NULL) { + goto out; + } + + dbus_error_init (&error); + if (! dbus_message_get_args (reply, + &error, + DBUS_TYPE_STRING, &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.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 new file mode 100644 index 0000000..03f4176 --- /dev/null +++ b/doc/xml/ref-ck-seat.xml @@ -0,0 +1,74 @@ +<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.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) +</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.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></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 new file mode 100644 index 0000000..2d58625 --- /dev/null +++ b/doc/xml/ref-ck-session.xml @@ -0,0 +1,254 @@ +<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 'i' uid) +<link linkend="Session.GetUnixUser">GetUnixUser</link> (out 'i' 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.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 'i' 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 'i' 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.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> |