17597N/A<!
DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
17597N/A<!--ArborText, Inc., 1988-1999, v.4002-->
17597N/A<!
ENTITY cmd "console-kit-daemon">
17597N/A<!
ENTITY suncopy "Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.">
17597N/A<
refentry id="console-kit-daemon-1m">
17597N/A<
refmeta><
refentrytitle>&cmd;</
refentrytitle><
manvolnum>1m</
manvolnum>
17598N/A<
refmiscinfo class="date">24 Oct 2009</
refmiscinfo>
17597N/A<
refmiscinfo class="sectdesc">&man1m;</
refmiscinfo>
17597N/A<
refmiscinfo class="software">&release;</
refmiscinfo>
17597N/A<
refmiscinfo class="arch">generic</
refmiscinfo>
17597N/A<
refmiscinfo class="copyright">&suncopy;</
refmiscinfo>
17597N/A<
refnamediv id="console-kit-daemon-1m-name">
17597N/A<
refsynopsisdiv id="console-kit-daemon-1m-synp"><
title>&synp-tt;</
title>
17597N/A<
cmdsynopsis><
command>&cmd;</
command>
17597N/A<
arg choice="opt"><
option>-debug</
option></
arg>
17597N/A<
arg choice="opt"><
option>-help</
option></
arg>
17597N/A<
arg choice="opt"><
option>-no-daemon</
option></
arg>
17597N/A<
arg choice="opt"><
option>-timed-exit</
option></
arg>
17597N/A<
refsect1 id="console-kit-daemon-1m-desc"><
title>&desc-tt;</
title>
17647N/A<
command>&cmd;</
command> is a service for defining and tracking users, login
17597N/Asessions and seats. It provides interfaces for managing switching sessions
17597N/Aand session migration when using mechanisms such as Virtual Terminals (VT).
17597N/AConsoleKit provides a number of interfaces to specify what displays are managed
17597N/Aby the display manager, and how.
17647N/AConsoleKit maintains a database of which users are logged into the system and
17647N/Aa history of all user logins. ConsoleKit groups sessions by seats which
17647N/Arepresent a set of hardware (usually a keyboard and mouse). Other process
17647N/Acommunicate with ConsoleKit via D-Bus.
17597N/AOne session leader process is responsible for asking <
command>&cmd;</
command>
17597N/Ato open a new session. In the typical case, the session leader would be a
17597N/AConsoleKit enabled display manager, such as GDM. This leader makes a
17597N/Aconnection to the D-Bus system bus and asks <
command>&cmd;</
command> to open a
17597N/AIf the operation succeeds, <
command>&cmd;</
command> will return a cookie to the
17597N/Asession leader. The session leader should store this variable in the
17597N/Aenvironment as XDG_SESSION_COOKIE so that it may be shared with its child
17597N/Aprocesses. The environment variable contains the UUID used to tie processes to
17597N/AAt this point the session will be registered with ConsoleKit and a particular
17597N/Aset of information about the session will be stored along with it.
17597N/AThe Session will remain open until the Session Leader disconnects from the
17597N/AD-Bus system bus. The session will be removed from its seat, and deregistered.
17597N/AVarious other programs need to know information about running user sessions,
17597N/Asuch as the Fast User Switch Applet and other mechanisms for switching the
17597N/Aconsole to use a different VT display. Such programs make use of ConsoleKit
17597N/Ainterfaces to determine if user switching is supported and to manage the
17597N/Aswitching of different sessions on the same seat.
17598N/AOn Solaris, the ConsoleKit service is managed by the
17598N/A<
citerefentry><
refentrytitle>smf</
refentrytitle>
17598N/A<
manvolnum>5</
manvolnum></
citerefentry>
17598N/Aservice management facility under the service identifier
17598N/A<
citerefentry><
refentrytitle>svcadm</
refentrytitle>
17598N/A<
manvolnum>1m</
manvolnum></
citerefentry> utility to start and stop the
17597N/AConsoleKit provides a pam_ck_connector so that non-graphical logins (
e.g. 17597N/Atelnet, ssh, etc.) are registered with ConsoleKit. This functionality works
17597N/Aif this PAM module is enabled in the
17597N/A<
manvolnum>4</
manvolnum></
citerefentry> configuration. Thus ConsoleKit can be
17597N/Aused as a
utmp/
wtmp replacement since it stores a superset of the information
17597N/AThe ConsoleKit database is stored in the file
17597N/Aactive Seats, Sessions, and the current SessionLeader.
17597N/A<
refsect1 id="console-kit-daemon-1m-opts">
17597N/AThe following options are supported:
17597N/A<
variablelist termlength="medium">
17597N/A<
term><
option>-debug</
option></
term>
17597N/A<
term><
option>h</
option>, <
option>-help</
option></
term>
17597N/A<
term><
option>-no-daemon</
option></
term>
17598N/AAvoid starting <
command>&cmd;</
command> as a daemon. Useful for debugging.
17597N/A<
term><
option>-timed-exit</
option></
term>
17597N/AExit after 30 seconds. Useful for debugging.
17597N/A<
refsect1 id="pkg-config-1-envr"><
title>&envr-tt;</
title>
17597N/A<
citerefentry><
refentrytitle>environ</
refentrytitle>
17597N/A<
manvolnum>5</
manvolnum></
citerefentry>
17597N/Afor descriptions of environment variables.
17597N/A<
variablelist termlength="wholeline">
17597N/A<
term><
envar>DISPLAY</
envar></
term>
17597N/AThis environment variable corresponds to the Xserver display value associated
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>XDG_SESSION_COOKIE</
envar></
term>
17597N/AConsoleKit provides this environment variable to the session leader. The
17597N/Asession leader is expected to ensure this is set for the session process
17597N/Astarted. It contains a UUID used to tie the processes to the session. This is
17597N/Aused to support user switching on displays that support it (currently only
17597N/Agraphical VT displays on the console).
17597N/A</
para></
listitem></
varlistentry>
17597N/AThe following environment variables are set when <
command>&cmd;</
command>
17599N/Ascripts. These values correspond to those values returned by the
17597N/A<
citerefentry><
refentrytitle>ck-list-session</
refentrytitle>
17597N/A<
manvolnum>1</
manvolnum></
citerefentry> utility.
17597N/A<
variablelist termlength="wholeline">
17597N/A<
term><
envar>CK_SESSION_SEAT_ID</
envar></
term>
17597N/AThe seat ID associated with the session.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_SEAT_UID</
envar></
term>
17597N/AThe user id associated with the session
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_DISPLAY_DEVICE</
envar></
term>
17597N/AThe display device associated with the session.
17597N/A</
para></
listitem></
varlistentry>
17677N/A<
term><
envar>CK_SESSION_DISPLAY_TYPE</
envar></
term>
17677N/AThe display configuration file associated with the session. This is a file
17677N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_X11_DISPLAY_DEVICE</
envar></
term>
17597N/AThe value of the display device that the X11 display for the session is
17597N/Aconnected to. If there is no x11-display set, then this value is undefined.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_X11_DISPLAY</
envar></
term>
17597N/AThe value of the X11 DISPLAY environment variable for this session if one is
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_REMOTE_HOST_NAME</
envar></
term>
17597N/AIf the session is not local, the value is the host name associated with the
17597N/Asession. If the session is local, the value is empty.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_IS_ACTIVE</
envar></
term>
17597N/AThe value is "TRUE" if the session is active on the seat to which it
17597N/Ais attached, and "FALSE" otherwise.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term><
envar>CK_SESSION_IS_LOCAL</
envar></
term>
17597N/AThe value is "TRUE" if the session is local, and "FALSE"
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
refsect1 id="console-kit-daemon-1m-exde"><
title>&exde-tt;</
title>
17597N/A<
refsect2 id="console-kit-daemon-1m-exde-seatconfig">
17597N/A<
title>ConsoleKit Seat Configuration</
title>
17597N/AConsoleKit seat configuration files are located in the
17597N/Aconfiguration file ends with the <
filename>.seat</
filename> suffix. ConsoleKit
17597N/AAdditional seat configuration files may be added. These files are in standard
17597N/A"
group/
key=<
replaceable>default_value</
replaceable>" format, and show
17597N/Amodify the this file so it contains these lines:
17597N/AThe following keys are supported for configuring ConsoleKit seats:
17597N/A<
variablelist termlength="wholeline">
17597N/AVersion number of the seat file. This specifies the version number of the
17597N/Aconfiguration file format used. Currently only the value "1.0" is
17597N/A</
para></
listitem></
varlistentry>
17597N/A</
para></
listitem></
varlistentry>
17597N/ASpecifies the unique ID of the seat. If the value is NULL, then
17597N/A<
command>&cmd;</
command> will provide a value. The ID may only contain the
17597N/AASCII characters [A-Z][a=z][0-9]_".
17597N/A</
para></
listitem></
varlistentry>
17597N/AIf this value is set to "false", then ConsoleKit will create this
17597N/Aseat. Otherwise, the seat will not be created.
17597N/A</
para></
listitem></
varlistentry>
17597N/AThis value is not currently supported. In the future, it is planned that
17597N/AConsoleKit will provide the ability to manage how device permissions are
17597N/Amanaged, and this key is a placeholder.
17597N/A</
para></
listitem></
varlistentry>
17597N/AList of sessions to start on the seat, separated by the ";"
17597N/Acharacter. Each session must be defined in a ConsoleKit session configuration
17597N/A<
filename>/
etc/
ConsoleKit/
sessions.d/<
replaceable>sessions</
replaceable>.session</
filename> where <
replaceable>sessions</
replaceable> is the value of this key.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
refsect2 id="console-kit-daemon-1m-exde-dislayconfig">
17597N/A<
title>ConsoleKit Display Configuration</
title>
17597N/AConsoleKit display configuration files are located in the
17597N/Aconfiguration file ends with the <
filename>.display</
filename> suffix.
17597N/AAdditional seat configuration files may be added. These files are in standard
17647N/Avalue, the file should contain these lines:
17597N/AThe following keys are supported for configuring ConsoleKit displays:
17597N/A<
variablelist termlength="wholeline">
17597N/AThe type of the display. Currently only the value "X11" is
17597N/Asupported. This indicates that the display will be managed by an Xserver
17597N/Athat sends a SIGUSR1 signal to its parent pid when it is ready. This is
17597N/Astandard for all Xservers, such as the
17597N/A<
citerefentry><
refentrytitle>Xorg</
refentrytitle>
17597N/A<
manvolnum>1</
manvolnum></
citerefentry> Xserver.
17597N/A</
para></
listitem></
varlistentry>
17597N/AThe command to run to launch the session. This command supports variables
17597N/Athat start with the "$" character, like "$display".
17597N/AThe values to use for these variables can either be specified in the
17597N/AConsoleKit session configuration file in the "[Local]" section, or
17597N/Avia the <
citerefentry><
refentrytitle>ck-seat-tool</
refentrytitle>
17597N/A<
manvolnum>1</
manvolnum></
citerefentry> application.
17597N/A<
refsect2 id="console-kit-daemon-1m-exde-sessionconfig">
17597N/A<
title>ConsoleKit Session Configuration</
title>
17597N/AConsoleKit session configuration files are located in the
17597N/Aconfiguration file ends with the <
filename>.session</
filename> suffix.
17597N/AAdditional seat configuration files may be added. These files are in standard
17647N/Avalue, the file should contain these lines:
17597N/AThe following keys are supported for configuring ConsoleKit sessions:
17597N/A<
variablelist termlength="wholeline">
17597N/A</
para></
listitem></
varlistentry>
17597N/A</
para></
listitem></
varlistentry>
17597N/A</
para></
listitem></
varlistentry>
17597N/AThis specifies the display type to be used with the session. This corresponds
17597N/Awhere <
replaceable>display_template</
replaceable> is the value of this key.
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
term>Local/<
replaceable>variable</
replaceable></
term>
17597N/AThe ConsoleKit display configuration file associated with the
17597N/Athe display. This command is defined in the ConsoleKit display configuration
17597N/Afile in the key "
X11/
Exec". This command can include variables that
17597N/Abegin with the "$" character, such as "$display". The
17597N/Avalues to be used for these variables can be defined in this section. So if
17597N/Athe session configuration file contains the value
17620N/Athe command to be replaced with the value ":0".
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
refsect2 id="console-kit-daemon-1m-exde-scripts">
17597N/A<
title>ConsoleKit Session Script Interfaces</
title>
17597N/AThe following interfaces are provided so that system administrators can
17597N/Aconfigure that certain actions happen when ConsoleKit responds to certain
17597N/AWhen a ConsoleKit session is started or removed, then <
command>&cmd;</
command>
17597N/Awill first run any scripts found in the
17597N/AWhen certain seat events, such as "seat_added",
17597N/A"seat_removed" or "seat_active_session_changed" occur,
17597N/Athen <
command>&cmd;</
command> will first run any script in the
17597N/A<
refsect2 id="console-kit-daemon-1m-exde-system">
17597N/A<
title>ConsoleKit System Restart and Stop</
title>
17597N/A<
command>&cmd;</
command> provides D-Bus interfaces that will restart or stop
17597N/Athe system. When <
command>&cmd;</
command> receives a D-Bus request to restart
17597N/Athe user has privilege to do this operation. When <
command>&cmd;</
command>
17597N/Areceives a D-Bus request to stop the system, it will run the
17597N/Auser has privilege to do this operation.
17597N/A<
refsect1 id="ck-seat-tool-1m-exam"><
title>&exam-tt;</
title>
17597N/A<
title>To start the ConsoleKit daemon</
title>
17597N/Aexample% <
userinput>&cmd;</
userinput>
18202N/A<
title>To configure ConsoleKit to not start a seat</
title>
18202N/ATo disable a seat, the administrator can set Hidden=true in the .seat file.
18202N/Athe default primary seat which normally runs on the system console.
18202N/AFor example, disabling the primary seat on the console is useful if the
18202N/Aadministrator wishes to run GDM in headless mode. This can be
18202N/Auseful if the administrator wants GDM to accept XDMCP remote displays
18202N/Abut the server does not actually have a console.
18202N/ADescription=start one static local display at :0
17597N/A<
title>To configure ConsoleKit to start multiple sessions on a single seat</
title>
17597N/ATo start two local displays: DISPLAY ":0" on vt7 and DISPLAY
17597N/A":1" on "vt8",
17597N/ADescription=start static displays :0 on vt7 and :1 on vt8
17597N/AThen, in addition to the original
17597N/A<
title>To configure ConsoleKit to start multiple seat</
title>
17597N/ATo start two seats: a local session on DISPLAY ":0" using
17597N/A"vt7" and another seat using a VNC session on DISPLAY ":64",
17597N/ADescription=start one VNC display on :64
17597N/ADescription=Connect to local VNC server running on same machine
17597N/A<
refsect1 id="console-kit-daemon-1m-file"><
title>&file-tt;</
title>
17597N/AThe following files are used by this application:
17597N/A<
variablelist termlength="wholeline">
17597N/AExecutable for the ConsoleKit daemon.
17597N/A</
para></
listitem></
varlistentry>
17597N/AAny scripts in this directory are run when a ConsoleKit seat event happens.
17597N/A</
para></
listitem></
varlistentry>
17597N/AAny scripts in this directory are run when a ConsoleKit session event happens.
17597N/A</
para></
listitem></
varlistentry>
17597N/AScript to run when ConsoleKit receives a D-Bus request to restart the system.
17597N/A</
para></
listitem></
varlistentry>
17597N/AScript to run when ConsoleKit receives a D-Bus request to stop the system.
17597N/A</
para></
listitem></
varlistentry>
17597N/AConsoleKit seat configuration files.
17597N/A</
para></
listitem></
varlistentry>
17597N/AConsoleKit session configuration files.
17597N/A</
para></
listitem></
varlistentry>
17597N/AAny scripts in this directory are run when a ConsoleKit seat event happens.
17597N/A</
para></
listitem></
varlistentry>
17597N/AAny scripts in this directory are run when a ConsoleKit seat event happens.
17597N/A</
para></
listitem></
varlistentry>
17597N/A</
para></
listitem></
varlistentry>
17597N/A<
refsect1 id="console-kit-daemon-1m-attr"><
title>&attr-tt;</
title>
17597N/A<
olink targetdocent="REFMAN5" localinfo="attributes-5">
17597N/A<
citerefentry><
refentrytitle>attributes</
refentrytitle>
17597N/A<
manvolnum>5</
manvolnum></
citerefentry></
olink>
17597N/Afor descriptions of the following attributes:
17597N/A<
tgroup cols="2" colsep="1" rowsep="1">
17597N/A<
colspec colname="COLSPEC0" colwidth="1*">
17597N/A<
colspec colname="COLSPEC1" colwidth="1*">
17597N/A<
entry align="center" valign="middle">ATTRIBUTE TYPE</
entry>
17597N/A<
entry align="center" valign="middle">ATTRIBUTE VALUE</
entry></
row>
17597N/A<
entry><
para>Availability</
para></
entry>
17597N/A<
entry colname="COLSPEC0"><
para>Interface stability</
para></
entry>
17597N/A<
entry colname="COLSPEC1"><
para>Volatile</
para></
entry>
17597N/A<
refsect1 id="console-kit-daemon-1m-also"><
title>&also-tt;</
title>
17597N/A<!--Reference to another man page--> 17597N/A<!--Reference to a Help manual--> 17598N/AMore information can be found at:
17597N/A<
citerefentry><
refentrytitle>ck-history</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>,
17597N/A<
citerefentry><
refentrytitle>ck-launch-session</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>,
17597N/A<
citerefentry><
refentrytitle>ck-list-sessions</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>,
17647N/A<
citerefentry><
refentrytitle>dbus-daemon</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>,
17597N/A<
citerefentry><
refentrytitle>ck-seat-tool</
refentrytitle><
manvolnum>1m</
manvolnum></
citerefentry>,
17597N/A<
citerefentry><
refentrytitle>gdm</
refentrytitle><
manvolnum>1m</
manvolnum></
citerefentry>,
17598N/A<
citerefentry><
refentrytitle>svcadm</
refentrytitle><
manvolnum>1m</
manvolnum></
citerefentry>,
17597N/A<
citerefentry><
refentrytitle>attributes</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
17598N/A<
citerefentry><
refentrytitle>environ</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
17598N/A<
citerefentry><
refentrytitle>smf</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
17597N/A<
refsect1 id="console-kit-daemon-1m-note"><
title>¬e-tt;</
title>
17598N/ABrian Cameron, Sun Microsystems Inc., 2009.
17597N/ACopyright (c) 2009 by Sun Microsystems, Inc.
17598N/ASome of the documentation in this manpage is from the ConsoleKit documentation