diff options
author | Brian Cameron <brian.cameron@oracle.com> | 2014-10-07 20:25:03 +0300 |
---|---|---|
committer | Eric Koegel <eric.koegel@gmail.com> | 2014-10-07 20:25:03 +0300 |
commit | dfe2c5b6f073cbbe454dd07f78e337a22dc6a213 (patch) | |
tree | a56387a007bb56961f9c601cd89490443834b2fe /doc | |
parent | ce0dc2b4888eb47dceaa434c0f7d34feb9436c1a (diff) | |
download | ConsoleKit2-dfe2c5b6f073cbbe454dd07f78e337a22dc6a213.tar.gz |
ConsoleKit needs manpages
This patch adds man pages for the binaries it ships to /usr/bin
and /usr/sbin.
https://github.com/ConsoleKit2/ConsoleKit2/issues/4
https://bugs.freedesktop.org/show_bug.cgi?id=24824
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 9 | ||||
-rw-r--r-- | doc/ck-history.1 | 140 | ||||
-rw-r--r-- | doc/ck-launch-session.1 | 48 | ||||
-rw-r--r-- | doc/ck-list-sessions.1 | 293 | ||||
-rw-r--r-- | doc/console-kit-daemon.1m | 472 |
5 files changed, 962 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 2b95778..225e344 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1,11 @@ SUBDIRS = dbus +manpagedir = $(mandir)/man1 +manpage_DATA = \ + ck-history.1 \ + ck-launch-session.1 \ + ck-list-sessions.1 \ + console-kit-daemon.1m + +EXTRA_DIST = \ + $(manpage_DATA) diff --git a/doc/ck-history.1 b/doc/ck-history.1 new file mode 100644 index 0000000..05abb89 --- /dev/null +++ b/doc/ck-history.1 @@ -0,0 +1,140 @@ +'\" te +.TH ck-history 1 "22 Oct 2009" "SunOS 5.11" "User Commands" +.SH "NAME" +ck-history \- ConsoleKit history +.SH "SYNOPSIS" +.PP +\fBck-history\fR [-\fB-frequent\fR] [-\fB-help\fR] [-\fB-last\fR] [-\fB-last-compat\fR] [-\fB-log\fR] [-\fB-seat=\fIseat\fR\fR] [-\fB-session-type=\fItype\fR\fR] [-\fB-user=\fIuser\fR\fR] [-\fB-version\fR] +.SH "DESCRIPTION" +.PP +\fBck-history\fR is a utility that provides information from the +ConsoleKit database about what users have logged into the system\&. It supports +options to specify whether to provide information about users who have logged +in most frequently or most recently\&. +.PP +The \fBck-history\fR utility is used by +\fBgdm\fR(1m) +when the GDM Face Browser is enabled to display users in the order of +frequency\&. +.SH "OPTIONS" +.PP +The following options are supported: +.sp +.ne 2 +.mk +\fB-\fB-frequent\fR\fR +.in +32n +.rt +Show listing of logged-in users in the most frequent order\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fBh\fR, -\fB-help\fR\fR +.in +32n +.rt +Display detailed usage message\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fB-last\fR\fR +.in +32n +.rt +Show listing of all user logins since logging began in the most-recent order.\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fB-last-compat\fR\fR +.in +32n +.rt +Show listing of logged-in users in the most-recent order\&. The output is +displayed in +\fBlast\fR(1) +compatible format\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fB-log\fR\fR +.in +32n +.rt +Show full ConsoleKit event log\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fBs\fR, -\fB-seat=\fIseat\fR\fR\fR +.in +32n +.rt +Show entries for the specified \fIseat\fR\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fBt\fR, -\fB-session-type=\fItype\fR\fR\fR +.in +32n +.rt +Show entries for the specified session \fItype\fR\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fBu\fR, -\fB-user=\fIuser\fR\fR\fR +.in +32n +.rt +Show entries for the specified \fIuser\fR\&. +.sp +.sp 1 +.in -32n +.sp +.ne 2 +.mk +\fB-\fBV\fR, -\fB-version\fR\fR +.in +32n +.rt +Display the version of the \fBck-history\fR application\&. +.sp +.sp 1 +.in -32n +.SH "EXAMPLES" +.PP +\fBExample 1: Show most frequently logged in users\fR +.PP +.PP +.nf +example% \fBck-history -\fB-frequent\fR\fR +.fi +.PP +\fBExample 2: Show the entire ConsoleKit log\&.\fR +.PP +.PP +.nf +example% \fBck-history -\fB-log\fR\fR +.fi +.SH "SEE ALSO" +.PP +\fBck-launch-session\fR(1), +\fBck-list-sessions\fR(1), +\fBconsole-kit-daemon\fR(1m) +.SH "NOTES" +.PP +Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&. +Copyright (c) 2009 by Sun Microsystems, Inc\&. +...\" created by instant / solbook-to-man, Sat 24 Oct 2009, 14:10 +...\" LSARC 2009/432 ConsoleKit diff --git a/doc/ck-launch-session.1 b/doc/ck-launch-session.1 new file mode 100644 index 0000000..ad853eb --- /dev/null +++ b/doc/ck-launch-session.1 @@ -0,0 +1,48 @@ +'\" te +.TH ck-launch-session 1 "22 Oct 2009" "SunOS 5.11" "User Commands" +.SH "NAME" +ck-launch-session \- Utility to start a ConsoleKit session from a shell script +.SH "SYNOPSIS" +.PP +\fBck-launch-session\fR \fB\fIcommand\fR\fR +.SH "DESCRIPTION" +.PP +\fBck-launch-session\fR is a utility for starting a command in its own +ConsoleKit session, however the command is optional. If not specified it +launches a shell.\&. This would be useful if a user wanted to start their own +session via a \fBstartx\fR script and have it registered with +ConsoleKit, for example\&. +.SH "OPERANDS" +.PP +The following operands are supported: +.sp +.ne 2 +.mk +\fB\fB\fIcommand\fR\fR\fR +.in +16n +.rt +Start the specified \fIcommand\fR in its own ConsoleKit +session\&. +.sp +.sp 1 +.in -16n +.SH "EXAMPLES" +.PP +\fBExample 1: Launch the \fBstartx\fR command in its own ConsoleKit +session\fR +.PP +.PP +.nf +example% \fBck-launch-session \fBstartx\fR\fR +.fi +.SH "SEE ALSO" +.PP +\fBck-history\fR(1), +\fBck-list-sessions\fR(1), +\fBconsole-kit-daemon\fR(1m) +.SH "NOTES" +.PP +Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&. +Copyright (c) 2009 by Sun Microsystems, Inc\&. +...\" created by instant / solbook-to-man, Sat 24 Oct 2009, 14:10 +...\" LSARC 2009/432 ConsoleKit diff --git a/doc/ck-list-sessions.1 b/doc/ck-list-sessions.1 new file mode 100644 index 0000000..6c4d3d0 --- /dev/null +++ b/doc/ck-list-sessions.1 @@ -0,0 +1,293 @@ +'\" te +.TH ck-list-sessions 1 "22 Oct 2009" "SunOS 5.11" "User Commands" +.SH "NAME" +ck-list-sessions \- Show ConsoleKit Session Information +.SH "SYNOPSIS" +.PP +\fBck-list-sessions\fR [-\fB-all\fR] [-\fB-format=\fIformat\fR\fR] [-\fB-help\fR] [-\fB-version\fR] +.SH "DESCRIPTION" +.PP +\fBck-list-sessions\fR is a utility that displays information from the +ConsoleKit database\&. By default, only open sessions are shown\&. The +-\fB-all\fR option can be used to display all existing sessions on +the system\&. \fBck-list-sessions\fR returns information about each ConsoleKit +session\&. Users can specify which properties to display via the +-\fB-format\fR option\&. +.PP +The following properties can be displayed for each session: +.SH "OPTIONS" +.PP +The following options are supported: +.sp +.ne 2 +.mk +\fB-\fBa\fR, -\fB-all\fR\fR +.in +24n +.rt +Show all ConsoleKit sessions\&. If this option is not provided, only open +sessions are shown\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fBf\fR, -\fB-format=\fIformat\fR\fR\fR +.in +24n +.rt +Display information using the specified \fIformat\fR\&. The +\fIformat\fR value is a list of properties to display +separated by commas\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fBh\fR, -\fB-help\fR\fR +.in +24n +.rt +Display detailed usage message\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fBV\fR, -\fB-version\fR\fR +.in +24n +.rt +Display the version of the \fBck-list-sessions\fR application\&. +.sp +.sp 1 +.in -24n +.SH "EXTENDED DESCRIPTION" +.SS "ConsoleKit session properties" +.PP +For each session, the following session properties are displayed: +.sp +.ne 2 +.mk +\fBunix-user\fR +.in +24n +.rt +The user id value associated with the session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBrealname\fR +.in +24n +.rt +The name of the user associated with the session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBseat\fR +.in +24n +.rt +The ID for the ConsoleKit Seat associated with the session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBsession-type\fR +.in +24n +.rt +The ConsoleKit session type\&. This value is specified by the "Type" +key in the ConsoleKit session configuration file associated with this session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBdisplay-type\fR +.in +24n +.rt +The ConsoleKit display type\&. This value is specified by the +"DisplayTemplate" key in the ConsoleKit session configuration file +associated with this session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBopen\fR +.in +24n +.rt +The value is "TRUE" if the session is open, and "FALSE" +otherwise\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBactive\fR +.in +24n +.rt +The value is "TRUE" if the session is active on the seat to which it +is attached, and "FALSE" otherwise\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBx11-display\fR +.in +24n +.rt +The value of the X11 DISPLAY environment variable for this session if one is +present\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBx11-display-device\fR +.in +24n +.rt +The value of the display device that the X11 display for the session is +connected to\&. If there is no x11-display set, then this value is undefined\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBdisplay-device\fR +.in +24n +.rt +The display device associated with the session\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBremote-host\fR +.in +24n +.rt +If the session is not local, the value is the host name associated with the +session\&. If the session is local, the value is empty\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBis-local\fR +.in +24n +.rt +The value is "TRUE" if the session is local, and "FALSE" +if remote\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBon-since\fR +.in +24n +.rt +An ISO 8601 date-time string that corresponds to the time the session started\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBlogin-session-id\fR +.in +24n +.rt +The value of the login session ID that the underlying system uses to enforce +session boundaries\&. If there is no login session ID set then this value is an +empty string\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fBidle-since-hint\fR +.in +24n +.rt +An ISO 8601 date-time string that corresponds to the time of the last change of +the idle-hint\&. This is a hint used to indicate that the session may be idle\&. +For sessions with a x11-display set (ie\&. graphical sessions), it is up to each +session to delegate the responsibility for updating this value\&. Typically, the +screensaver will set this\&. +.sp +However, for non-graphical sessions with a display-device set the Session +object itself will periodically update this value based on the activity +detected on the display-device itself\&. +.sp +This should not be considered authoritative\&. +.sp +.sp 1 +.in -24n +.SH "EXAMPLES" +.PP +\fBExample 1: Show running sessions\&.\fR +.PP +.PP +.nf +example% \fBck-list-sessions\fR +.fi +.PP +This command would generate output like the following for each session: +.PP +.PP +.nf +SessionSeat1Local: + unix-user = \&'50\&' + realname = \&'GDM Reserved UID\&' + seat = \&'Seat1\&' + session-type = \&'LoginWindow\&' + display-type = \&'Local\&' + open = \&'TRUE\&' + active = \&'TRUE\&' + x11-display = \&':0\&' + x11-display-device = \&'/dev/console\&' + display-device = \&'/dev/console\&' + remote-host-name = \&'\&' + is-local = \&'TRUE\&' + on-since = \&'2009-08-11T06:46:42\&.941134Z\&' + login-session-id = \&'\&' + idle-since-hint = \&'\&' +.fi +.PP +\fBExample 2: Show only the session-id, unix-user, and display-type properties\&.\fR +.PP +.PP +.nf +example% \fBck-list-sessions -\fB-format="session-id,unix-user,display-type"\fR\fR +.fi +.PP +This command would generate output like the following for each session: +.PP +.PP +.nf +SessionSeat1Local 50 Local +.fi +.SH "SEE ALSO" +.PP +\fBck-history\fR(1), +\fBck-launch-session\fR(1), +\fBconsole-kit-daemon\fR(1m) +.SH "NOTES" +.PP +Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&. +Copyright (c) 2009 by Sun Microsystems, Inc\&. +...\" created by instant / solbook-to-man, Sat 24 Oct 2009, 14:10 +...\" LSARC 2009/432 ConsoleKit diff --git a/doc/console-kit-daemon.1m b/doc/console-kit-daemon.1m new file mode 100644 index 0000000..1e1a618 --- /dev/null +++ b/doc/console-kit-daemon.1m @@ -0,0 +1,472 @@ +'\" te +.TH console-kit-daemon 1m "24 Oct 2009" "SunOS 5.11" "Maintenance Commands" +.SH "NAME" +console-kit-daemon \- ConsoleKit daemon +.SH "SYNOPSIS" +.PP +\fBconsole-kit-daemon\fR [-\fB-debug\fR] [-\fB-help\fR] [-\fB-no-daemon\fR] [-\fB-timed-exit\fR] +.SH "DESCRIPTION" +.PP +\fBconsole-kit-daemon\fR is a service for defining and tracking users, login +sessions and seats\&. It provides interfaces for managing switching sessions +and session migration when using mechanisms such as Virtual Terminals (VT)\&. +ConsoleKit provides a number of interfaces to specify what displays are managed +by the display manager, and how\&. +.PP +ConsoleKit maintains a database of which users are logged into the system\&. +ConsoleKit groups sessions by seats which represent a set of hardware (usually +a keyboard and mouse)\&. Other process communicate with ConsoleKit via D-Bus\&. +.PP +One session leader process is responsible for asking \fBconsole-kit-daemon\fR +to open a new session\&. In the typical case, the session leader would be a +ConsoleKit enabled display manager, such as GDM\&. This leader makes a +connection to the D-Bus system bus and asks \fBconsole-kit-daemon\fR to open a +session when needed\&. +.PP +If the operation succeeds, \fBconsole-kit-daemon\fR will return a cookie to the +session leader\&. The session leader should store this variable in the +environment as XDG_SESSION_COOKIE so that it may be shared with its child +processes\&. The environment variable contains the UUID used to tie processes to +a session\&. +.PP +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\&. +.PP +The Session will remain open until the Session Leader disconnects from the +D-Bus system bus\&. The session will be removed from its seat, and deregistered\&. +.PP +Various other programs need to know information about running user sessions, +such as the Fast User Switch Applet and other mechanisms for switching the +console to use a different VT display\&. Such programs make use of ConsoleKit +interfaces to determine if user switching is supported and to manage the +switching of different sessions on the same seat\&. +.PP +ConsoleKit provides a pam_ck_connector so that non-graphical logins (e\&.g\&. +telnet, ssh, etc\&.) are registered with ConsoleKit\&. This functionality works +if this PAM module is enabled in the +\fBpam\&.conf\fR(4) configuration\&. Thus ConsoleKit can be +used as a utmp/wtmp replacement since it stores a superset of the information +as in the utmp/wtmp database\&. +.PP +The ConsoleKit database is stored in the file +\fB/var/run/ConsoleKit/database\fR\&. It stores information about +active Seats, Sessions, and the current SessionLeader\&. +.SH "OPTIONS" +.PP +The following options are supported: +.sp +.ne 2 +.mk +\fB-\fB-debug\fR\fR +.in +24n +.rt +Enable debug output\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fBh\fR, -\fB-help\fR\fR +.in +24n +.rt +Display detailed usage message\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fB-no-daemon\fR\fR +.in +24n +.rt +Avoid starting \fBconsole-kit-daemon\fR as a daemon\&. Useful for debugging\&. +.sp +.sp 1 +.in -24n +.sp +.ne 2 +.mk +\fB-\fB-timed-exit\fR\fR +.in +24n +.rt +Exit after 30 seconds\&. Useful for debugging\&. +.sp +.sp 1 +.in -24n +.SH "ENVIRONMENT VARIABLES" +.PP +See +\fBenviron\fR(5) +for descriptions of environment variables\&. +.sp +.ne 2 +.mk +\fB\fBDISPLAY\fR\fR +.sp .6 +.in +4 +This environment variable corresponds to the Xserver display value associated +with the ConsoleKit session\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBXDG_SESSION_COOKIE\fR\fR +.sp .6 +.in +4 +ConsoleKit provides this environment variable to the session leader\&. The +session leader is expected to ensure this is set for the session process +started\&. It contains a UUID used to tie the processes to the session\&. This is +used to support user switching on displays that support it (currently only +graphical VT displays on the console)\&. +.sp +.sp 1 +.in -4 +.PP +The following environment variables are set when \fBconsole-kit-daemon\fR +runs the \fBrun-seat\&.d\fR scripts\&. These values correspond to those +values returned by the \fBck-list-session\fR(1) utility\&. +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_SEAT_ID\fR\fR +.sp .6 +.in +4 +The seat ID associated with the session\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_SEAT_UID\fR\fR +.sp .6 +.in +4 +The user id associated with the session +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_DISPLAY_DEVICE\fR\fR +.sp .6 +.in +4 +The display device associated with the session\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_X11_DISPLAY_DEVICE\fR\fR +.sp .6 +.in +4 +The value of the display device that the X11 display for the session is +connected to\&. If there is no x11-display set, then this value is undefined\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_X11_DISPLAY\fR\fR +.sp .6 +.in +4 +The value of the X11 DISPLAY environment variable for this session if one is +present\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_REMOTE_HOST_NAME\fR\fR +.sp .6 +.in +4 +If the session is not local, the value is the host name associated with the +session\&. If the session is local, the value is empty\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_IS_ACTIVE\fR\fR +.sp .6 +.in +4 +The value is "TRUE" if the session is active on the seat to which it +is attached, and "FALSE" otherwise\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_IS_LOCAL\fR\fR +.sp .6 +.in +4 +The value is "TRUE" if the session is local, and "FALSE" +if remote\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fB\fBCK_SESSION_IS_DYNAMIC\fR\fR +.sp .6 +.in +4 +The value is "TRUE" if the session was started with +\fBck-seat-tool\fR, and "FALSE" otherwise\&. +.sp +.sp 1 +.in -4 +.SH "EXTENDED DESCRIPTION" +.SS "ConsoleKit Seat Configuration" +.PP +ConsoleKit seat configuration files are located in the +/etc/ConsoleKit/seats\&.d directory\&. Each seat +configuration file ends with the \fB\&.seat\fR suffix\&. ConsoleKit +provides a default seat file named \fB00-primary\&.seat\fR\&. +Additional seat configuration files may be added\&. These files are in standard +INI format\&. +.PP +The settings below are in +"group/key=\fIdefault_value\fR" format, and show +the default values of the \fB00-primary\&.seat\fR file\&. For +example, to specify a different "Seat Entry/Name" value, you would +modify the this file so it contains these lines: +.PP +.nf +[Seat Entry] +[\&.\&.\&.] +Name=Customized seat name +.fi +.PP +The following keys are supported for configuring ConsoleKit seats: +.sp +.ne 2 +.mk +\fBSeat Entry/Version=1\&.0\fR +.sp .6 +.in +4 +Version number of the seat file\&. This specifies the version number of the +configuration file format used\&. Currently only the value "1\&.0" is +supported\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSeat Entry/Name=Primary seat\fR +.sp .6 +.in +4 +Name of the seat\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSeat Entry/ID=StaticSeat\fR +.sp .6 +.in +4 +Specifies the unique ID of the seat\&. If the value is NULL, then +\fBconsole-kit-daemon\fR will provide a value\&. The ID may only contain the +ASCII characters [A-Z][a=z][0-9]_"\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSeat Entry/Hidden=false\fR +.sp .6 +.in +4 +If this value is set to "false", then ConsoleKit will create this +seat\&. Otherwise, the seat will not be created\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSeat Entry/Devices\fR +.sp .6 +.in +4 +This value is not currently supported\&. In the future, it is planned that +ConsoleKit will provide the ability to manage how device permissions are +managed, and this key is a placeholder\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSeat Entry/Sessions=Local\fR +.sp .6 +.in +4 +List of sessions to start on the seat, separated by the ";" +character\&. Each session must be defined in a ConsoleKit session configuration +file named +\fB/etc/ConsoleKit/sessions\&.d/\fIsessions\fR\&.session\fR where \fIsessions\fR is the value of this key\&. +.sp +.sp 1 +.in -4 +.SS "ConsoleKit Session Configuration" +.PP +ConsoleKit session configuration files are located in the +/etc/ConsoleKit/sessions\&.d directory\&. Each session +configuration file ends with the \fB\&.session\fR suffix\&. +Additional seat configuration files may be added\&. These files are in standard +INI format\&. +.PP +The settings below are in +"group/key" format, so to specify the "Session Entry/Name" +value, the file shoulld contain these lines: +.PP +.nf +[Session Entry] +[\&.\&.\&.] +Name=Customized Session +.fi +.PP +The following keys are supported for configuring ConsoleKit sessions: +.sp +.ne 2 +.mk +\fBSession Entry/Name\fR +.sp .6 +.in +4 +Unique name of the session\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSession Entry/Type\fR +.sp .6 +.in +4 +Type of the session +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSession Entry/Description\fR +.sp .6 +.in +4 +Description of the session\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBSession Entry/DisplayTemplate\fR +.sp .6 +.in +4 +This specifies the display type to be used with the session\&. This corresponds +to the file +\fB/etc/ConsoleKit/displays\&.d/\fIdisplay_template\fR\&.display\fR +where \fIdisplay_template\fR is the value of this key\&. +.sp +.sp 1 +.in -4 +.sp +.ne 2 +.mk +\fBLocal/\fIvariable\fR\fR +.sp .6 +.in +4 +The ConsoleKit display configuration file associated with the +"Entry/DisplayTemplate" key specifies the command to run to launch +the display\&. This command is defined in the ConsoleKit display configuration +file in the key "X11/Exec"\&. This command can include variables that +begin with the "$" character, such as "$display"\&. The +values to be used for these variables can be defined in this section\&. So if +the session configuration file contains the value +"Local/display=:0", this will cause the variable used when launching +the command to be replaced with the value "0"\&. +.sp +.sp 1 +.in -4 +.SS "ConsoleKit System Restart and Stop" +.PP +\fBconsole-kit-daemon\fR provides D-Bus interfaces that will restart or stop +the system\&. When \fBconsole-kit-daemon\fR receives a D-Bus request to restart +the system, it will run the +\fB/usr/lib/ConsoleKit/scripts/ck-system-restart\fR script if +the user has privilege to do this operation\&. When \fBconsole-kit-daemon\fR +receives a D-Bus request to stop the system, it will run the +\fB/usr/lib/ConsoleKit/scripts/ck-system-stop\fR script if the +user has privilege to do this operation\&. +.SH "EXAMPLES" +.PP +\fBExample 1: To start the ConsoleKit daemon\fR +.PP +.PP +.nf +example% \fBconsole-kit-daemon\fR +.fi +.PP +\fBExample 2: To configure ConsoleKit to start multiple sessions on a single seat\fR +.PP +To start two local displays: DISPLAY ":0" on vt7 and DISPLAY +":1" on "vt8", +edit the \fB00-primary\&.seat\fR file as follows: +.PP +.nf +[Seat Entry] +Version=1\&.0 +Name=Primary seat +Description=start static displays :0 on vt7 and :1 on vt8 +Hidden=false +Devices= +Sessions=Local;Local2; +.fi +.PP +Then, in addition to the original +\fB/etc/ConsoleKit/sessions\&.d/Local\&.session\fR file, add the +following \fB/etc/ConsoleKit/sessions\&.d/Local2\&.session\fR file: +.PP +.nf +[Session Entry] +Name=Local +Type=LoginWindow +Description=Local Login Screen +DisplayTemplate=Local + +[Local] +display=:1 +vt=/dev/vt/8 +.fi +.PP +.SH "SEE ALSO" +.PP +More information can be found at: +.PP +\fBhttps://github\&.com/ConsoleKit2/ConsoleKit2\fR +.PP +\fBck-history\fR(1), +\fBck-launch-session\fR(1), +\fBck-list-sessions\fR(1), +\fBsvcadm\fR(1m), +\fBenviron\fR(5), +\fBsmf\fR(5), +\fBconsole\fR(4) +.SH "NOTES" +.PP +Brian Cameron, Sun Microsystems Inc\&., 2009\&. +Copyright (c) 2009 by Sun Microsystems, Inc\&. +.PP +Some of the documentation in this manpage is from the ConsoleKit documentation +written by William Jon McCann\&. +...\" created by instant / solbook-to-man, Sat 24 Oct 2009, 14:10 +...\" LSARC 2009/432 ConsoleKit |