diff options
author | Michael Biebl <biebl@debian.org> | 2009-07-14 17:41:06 +0200 |
---|---|---|
committer | Michael Biebl <biebl@debian.org> | 2009-07-14 17:41:06 +0200 |
commit | 1f223c41689bbbd64f8749ff7c09967a49407022 (patch) | |
tree | 940cfec56674c79c9a00820529f9c98f7dd6f48a /doc | |
parent | 517ae9bab3e1aeda58ef4f042fa1346d411a9a4c (diff) | |
download | consolekit-1f223c41689bbbd64f8749ff7c09967a49407022.tar.gz |
Imported Upstream version 0.2.10upstream/0.2.10
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ConsoleKit.xml | 4 | ||||
-rw-r--r-- | doc/Makefile.in | 107 | ||||
-rw-r--r-- | doc/xml/ref-ck-manager.xml | 20 |
3 files changed, 71 insertions, 60 deletions
diff --git a/doc/ConsoleKit.xml b/doc/ConsoleKit.xml index b3e1ce3..856202b 100644 --- a/doc/ConsoleKit.xml +++ b/doc/ConsoleKit.xml @@ -10,8 +10,8 @@ <book id="index"> <bookinfo> - <title>ConsoleKit 0.2.3 Documentation</title> - <releaseinfo>Version 0.2.3</releaseinfo> + <title>ConsoleKit 0.2.10 Documentation</title> + <releaseinfo>Version 0.2.10</releaseinfo> <date>8 March, 2007</date> <authorgroup> <author> diff --git a/doc/Makefile.in b/doc/Makefile.in index 0e72c4a..97182af 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.9.6 from Makefile.am. +# Makefile.in generated by automake 1.10 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006 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. @@ -14,15 +14,11 @@ @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 @@ -60,8 +56,6 @@ 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@ @@ -74,12 +68,6 @@ 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@ @@ -96,17 +84,11 @@ 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@ @@ -116,8 +98,10 @@ GMOFILES = @GMOFILES@ GMSGFMT = @GMSGFMT@ GREP = @GREP@ HAVE_PAM = @HAVE_PAM@ -HAVE_PAM_FALSE = @HAVE_PAM_FALSE@ -HAVE_PAM_TRUE = @HAVE_PAM_TRUE@ +HAVE_POLKIT = @HAVE_POLKIT@ +HISTORY_CFLAGS = @HISTORY_CFLAGS@ +HISTORY_LIBS = @HISTORY_LIBS@ +INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ @@ -134,9 +118,8 @@ LIBTOOL = @LIBTOOL@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ MAINT = @MAINT@ -MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@ -MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@ MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGFMT_OPTS = @MSGFMT_OPTS@ @@ -152,10 +135,13 @@ PAM_MODULE_DIR = @PAM_MODULE_DIR@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKG_CONFIG = @PKG_CONFIG@ POFILES = @POFILES@ +POLKIT_CFLAGS = @POLKIT_CFLAGS@ +POLKIT_LIBS = @POLKIT_LIBS@ POSUB = @POSUB@ PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ RANLIB = @RANLIB@ +RBAC_LIBS = @RBAC_LIBS@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ @@ -166,13 +152,14 @@ VERSION = @VERSION@ WARN_CFLAGS = @WARN_CFLAGS@ XGETTEXT = @XGETTEXT@ XMLTO = @XMLTO@ +Z_LIBS = @Z_LIBS@ +abs_builddir = @abs_builddir@ +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@ -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@ @@ -184,6 +171,7 @@ build_alias = @build_alias@ build_cpu = @build_cpu@ build_os = @build_os@ build_vendor = @build_vendor@ +builddir = @builddir@ datadir = @datadir@ datarootdir = @datarootdir@ docdir = @docdir@ @@ -211,8 +199,11 @@ program_transform_name = @program_transform_name@ psdir = @psdir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ NULL = SPEC_XML_FILES = \ ConsoleKit.xml \ @@ -277,13 +268,9 @@ mostlyclean-libtool: 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)" + 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) \ @@ -306,23 +293,21 @@ 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; \ + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ 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 \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ fi; \ @@ -338,7 +323,7 @@ check: check-am all-am: Makefile $(DATA) installdirs: for dir in "$(DESTDIR)$(htmldocdir)"; do \ - test -z "$$dir" || $(mkdir_p) "$$dir"; \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am install-exec: install-exec-am @@ -371,7 +356,7 @@ clean-am: clean-generic clean-libtool clean-local mostlyclean-am distclean: distclean-am -rm -f Makefile -distclean-am: clean-am distclean-generic distclean-libtool +distclean-am: clean-am distclean-generic dvi: dvi-am @@ -385,12 +370,20 @@ info-am: install-data-am: install-htmldocDATA +install-dvi: install-dvi-am + install-exec-am: +install-html: install-html-am + install-info: install-info-am install-man: +install-pdf: install-pdf-am + +install-ps: install-ps-am + installcheck-am: maintainer-clean: maintainer-clean-am @@ -409,18 +402,22 @@ ps: ps-am ps-am: -uninstall-am: uninstall-htmldocDATA uninstall-info-am +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-exec \ - install-exec-am install-htmldocDATA install-info \ - install-info-am install-man install-strip installcheck \ + 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 \ + install-ps install-ps-am 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 + uninstall-htmldocDATA @DOCBOOK_DOCS_ENABLED_TRUE@ConsoleKit.html : $(SPEC_XML_FILES) diff --git a/doc/xml/ref-ck-manager.xml b/doc/xml/ref-ck-manager.xml index 2aceef8..3eb3a92 100644 --- a/doc/xml/ref-ck-manager.xml +++ b/doc/xml/ref-ck-manager.xml @@ -8,12 +8,15 @@ </refnamediv> <refsynopsisdiv role="synopsis"> <title role="synopsis.title">Methods</title> - <synopsis><link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie) + <synopsis><link linkend="Manager.Restart">Restart</link> () +<link linkend="Manager.Stop">Stop</link> () +<link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie) <link linkend="Manager.OpenSessionWithParameters">OpenSessionWithParameters</link> (in 'a(sv)' parameters, out 's' cookie) <link linkend="Manager.CloseSession">CloseSession</link> (in 's' cookie, out 'b' result) <link linkend="Manager.GetSeats">GetSeats</link> (out 'ao' seats) +<link linkend="Manager.GetSessions">GetSessions</link> (out 'ao' sessions) <link linkend="Manager.GetSessionForCookie">GetSessionForCookie</link> (in 's' cookie, out 'o' ssid) <link linkend="Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</link> (in 'u' pid, @@ -49,7 +52,11 @@ <title role="desc.title">Description</title> <para/> </refsect1> - <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2> + <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.Restart"/>Restart ()</title><indexterm><primary>Restart</primary><secondary>Manager</secondary></indexterm><programlisting>Restart ()</programlisting></refsect2> + <para>This method initiates a request to restart (ie. reboot) the computer system.</para> + <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.Stop"/>Stop ()</title><indexterm><primary>Stop</primary><secondary>Manager</secondary></indexterm><programlisting>Stop ()</programlisting></refsect2> + <para>This method initiates a request to stop (ie. shutdown) the computer system.</para> + <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2> <para>This method requests that a new <link linkend="Session">Session</link> be created for the calling process. The properties of this new Session are set automatically from information collected about the calling process. @@ -126,7 +133,14 @@ See also: <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, +<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para><refsect2><title><anchor role="function" id="Manager.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting></refsect2> + <para>This gets a list of all the <link linkend="Sessions">Sessions</link> + that are currently present on the system.</para> + <para>Each Session ID is an D-Bus object path for the object that implements the + <link linkend="Session">Session</link> interface.</para> + <variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><para> +See also: +<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para><refsect2><title><anchor role="function" id="Manager.GetSessionForCookie"/>GetSessionForCookie ()</title><indexterm><primary>GetSessionForCookie</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionForCookie (in 's' cookie, out 'o' ssid)</programlisting></refsect2> <para>Returns the session ID that is associated with the specified cookie. </para> |