summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEric Koegel <eric.koegel@gmail.com>2014-10-12 18:19:33 +0300
committerEric Koegel <eric.koegel@gmail.com>2014-10-12 18:19:50 +0300
commit108517b6de19b04efeb075eb025fcedd11d8577b (patch)
tree15d5ebeed83d8ad8e1b2e5ccc1b9ee1796d8486d /doc
parent3a6f5bdbcd78d797e17e4479368d4edb06a83e6c (diff)
downloadConsoleKit2-108517b6de19b04efeb075eb025fcedd11d8577b.tar.gz
Update docs
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus/ConsoleKit.xml.in13
-rw-r--r--doc/dbus/ck-design.xml8
-rw-r--r--doc/dbus/ck-introduction.xml20
3 files changed, 32 insertions, 9 deletions
diff --git a/doc/dbus/ConsoleKit.xml.in b/doc/dbus/ConsoleKit.xml.in
index 3ce7aec..830f723 100644
--- a/doc/dbus/ConsoleKit.xml.in
+++ b/doc/dbus/ConsoleKit.xml.in
@@ -10,7 +10,7 @@
<book id="index">
<bookinfo>
- <title>ConsoleKit @VERSION@ Documentation</title>
+ <title>ConsoleKit2 @VERSION@ Documentation</title>
<releaseinfo>Version @VERSION@</releaseinfo>
<authorgroup>
<author>
@@ -22,6 +22,15 @@
</address>
</affiliation>
</author>
+ <author>
+ <firstname>Eric</firstname>
+ <surname>Koegel</surname>
+ <affiliation>
+ <address>
+ <email>eric.koegel@gmail.com</email>
+ </address>
+ </affiliation>
+ </author>
</authorgroup>
</bookinfo>
@@ -47,7 +56,7 @@
<partintro>
<para>
- ConsoleKit provides a D-Bus API for programs to obtain information about the
+ ConsoleKit2 provides a D-Bus API for programs to obtain information about the
users, sessions, and seats that are present on a system.
</para>
<para>
diff --git a/doc/dbus/ck-design.xml b/doc/dbus/ck-design.xml
index 8aca968..7e05fb6 100644
--- a/doc/dbus/ck-design.xml
+++ b/doc/dbus/ck-design.xml
@@ -5,20 +5,20 @@
<title>Session Lifecycle</title>
<para>
The session leader process is responsible for asking
-ConsoleKit to open a new session. In this respect, it is
+ConsoleKit2 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().
+a login manager or the login manager itself. The leader makes a connection to the D-Bus system bus and asks ConsoleKit2 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
+At this point the session will be registered with ConsoleKit2 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.
+ConsoleKit2 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.
diff --git a/doc/dbus/ck-introduction.xml b/doc/dbus/ck-introduction.xml
index b38adf5..3f3fcda 100644
--- a/doc/dbus/ck-introduction.xml
+++ b/doc/dbus/ck-introduction.xml
@@ -4,24 +4,38 @@
<sect1>
<title>About</title>
<para>
- ConsoleKit is a framework for keeping track of the various
+ ConsoleKit2 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.
+ ConsoleKit2 also allows fast switching between open sessions on
+ the computer.
+ </para>
+ <para>
+ ConsoleKit2 is a fork of ConsoleKit since it is no longer maintained.
+ Information on ConsoleKit can be found at:
+ http://freedesktop.org/wiki/Software/ConsoleKit/
+ William Jon McCann was the primary maintainer of ConsoleKit and
+ most of this documentation was written by him for ConsoleKit. It
+ has been adapted for ConsoleKit2.
</para>
</sect1>
<sect1>
<title>Defining the Problem</title>
<para>
- To be written.
+ A simple example is two users logging into a computer at the same time.
+ They may be sharing the same set of hardware for their graphical session,
+ such as the monitor, keyboard, and mouse. ConsoleKit2 will keep track of
+ those resouces and which session is active and should have use of that
+ hardware at a given time.
</para>
</sect1>
<sect1>
<title>Relevant art</title>
<para>
- To be written.
+ Logind is a Linux daemon providing the similar functionality to ConsoleKit2.
</para>
</sect1>