| blob | 5748fc089e9014f44ca53d35a6ef4be7269a177e |
1 '\" te
2 .TH ck-list-sessions 1 "22 Oct 2009" "SunOS 5.11" "User Commands"
3 .SH "NAME"
4 ck-list-sessions \- Show ConsoleKit Session Information
5 .SH "SYNOPSIS"
6 .PP
7 \fBck-list-sessions\fR [-\fB-all\fR] [-\fB-sid=\fIsid\fR\fR] [-\fB-format=\fIformat\fR\fR] [-\fB-help\fR] [-\fB-version\fR]
8 .SH "DESCRIPTION"
9 .PP
10 \fBck-list-sessions\fR is a utility that displays information from the
11 ConsoleKit database\&. By default, only open sessions are shown\&. The
12 -\fB-all\fR option can be used to display all existing sessions on
13 the system\&. \fBck-list-sessions\fR returns information about each ConsoleKit
14 session\&. Users can specify which properties to display via the
15 -\fB-format\fR option\&.
16 .PP
17 The following properties can be displayed for each session:
18 .SH "OPTIONS"
19 .PP
20 The following options are supported:
21 .sp
22 .ne 2
23 .mk
24 \fB-\fBa\fR, -\fB-all\fR\fR
25 .in +24n
26 .rt
27 Show all ConsoleKit sessions\&. If this option is not provided, only open
28 sessions are shown\&.
29 .sp
30 .sp 1
31 .in -24n
32 .sp
33 .ne 2
34 .mk
35 \fB-\fBs\fR, -\fB-sid=\fIsid\fR\fR\fR
36 .in +24n
37 .rt
38 Show one ConsoleKit session with session id \fIsid\fR\&.
39 .sp
40 .sp 1
41 .in -24n
42 .sp
43 .ne 2
44 .mk
45 \fB-\fBf\fR, -\fB-format=\fIformat\fR\fR\fR
46 .in +24n
47 .rt
48 Display information using the specified \fIformat\fR\&. The
49 \fIformat\fR value is a list of properties to display
50 separated by commas\&.
51 .sp
52 .sp 1
53 .in -24n
54 .sp
55 .ne 2
56 .mk
57 \fB-\fBh\fR, -\fB-help\fR\fR
58 .in +24n
59 .rt
60 Display detailed usage message\&.
61 .sp
62 .sp 1
63 .in -24n
64 .sp
65 .ne 2
66 .mk
67 \fB-\fBV\fR, -\fB-version\fR\fR
68 .in +24n
69 .rt
70 Display the version of the \fBck-list-sessions\fR application\&.
71 .sp
72 .sp 1
73 .in -24n
74 .SH "EXTENDED DESCRIPTION"
75 .SS "ConsoleKit session properties"
76 .PP
77 For each session, the following session properties are displayed:
78 .sp
79 .ne 2
80 .mk
81 \fBunix-user\fR
82 .in +24n
83 .rt
84 The user id value associated with the session\&.
85 .sp
86 .sp 1
87 .in -24n
88 .sp
89 .ne 2
90 .mk
91 \fBrealname\fR
92 .in +24n
93 .rt
94 The name of the user associated with the session\&.
95 .sp
96 .sp 1
97 .in -24n
98 .sp
99 .ne 2
100 .mk
101 \fBseat\fR
102 .in +24n
103 .rt
104 The ID for the ConsoleKit Seat associated with the session\&.
105 .sp
106 .sp 1
107 .in -24n
108 .sp
109 .ne 2
110 .mk
111 \fBsession-type\fR
112 .in +24n
113 .rt
114 The ConsoleKit session type\&. This value is specified by the "Type"
115 key in the ConsoleKit session configuration file associated with this session\&.
116 .sp
117 .sp 1
118 .in -24n
119 .sp
120 .ne 2
121 .mk
122 \fBdisplay-type\fR
123 .in +24n
124 .rt
125 The ConsoleKit display type\&. This value is specified by the
126 "DisplayTemplate" key in the ConsoleKit session configuration file
127 associated with this session\&.
128 .sp
129 .sp 1
130 .in -24n
131 .sp
132 .ne 2
133 .mk
134 \fBopen\fR
135 .in +24n
136 .rt
137 The value is "TRUE" if the session is open, and "FALSE"
138 otherwise\&.
139 .sp
140 .sp 1
141 .in -24n
142 .sp
143 .ne 2
144 .mk
145 \fBactive\fR
146 .in +24n
147 .rt
148 The value is "TRUE" if the session is active on the seat to which it
149 is attached, and "FALSE" otherwise\&.
150 .sp
151 .sp 1
152 .in -24n
153 .sp
154 .ne 2
155 .mk
156 \fBx11-display\fR
157 .in +24n
158 .rt
159 The value of the X11 DISPLAY environment variable for this session if one is
160 present\&.
161 .sp
162 .sp 1
163 .in -24n
164 .sp
165 .ne 2
166 .mk
167 \fBx11-display-device\fR
168 .in +24n
169 .rt
170 The value of the display device that the X11 display for the session is
171 connected to\&. If there is no x11-display set, then this value is undefined\&.
172 .sp
173 .sp 1
174 .in -24n
175 .sp
176 .ne 2
177 .mk
178 \fBdisplay-device\fR
179 .in +24n
180 .rt
181 The display device associated with the session\&.
182 .sp
183 .sp 1
184 .in -24n
185 .sp
186 .ne 2
187 .mk
188 \fBremote-host\fR
189 .in +24n
190 .rt
191 If the session is not local, the value is the host name associated with the
192 session\&. If the session is local, the value is empty\&.
193 .sp
194 .sp 1
195 .in -24n
196 .sp
197 .ne 2
198 .mk
199 \fBis-local\fR
200 .in +24n
201 .rt
202 The value is "TRUE" if the session is local, and "FALSE"
203 if remote\&.
204 .sp
205 .sp 1
206 .in -24n
207 .sp
208 .ne 2
209 .mk
210 \fBon-since\fR
211 .in +24n
212 .rt
213 An ISO 8601 date-time string that corresponds to the time the session started\&.
214 .sp
215 .sp 1
216 .in -24n
217 .sp
218 .ne 2
219 .mk
220 \fBlogin-session-id\fR
221 .in +24n
222 .rt
223 The value of the login session ID that the underlying system uses to enforce
224 session boundaries\&. If there is no login session ID set then this value is an
225 empty string\&.
226 .sp
227 .sp 1
228 .in -24n
229 .sp
230 .ne 2
231 .mk
232 \fBidle-since-hint\fR
233 .in +24n
234 .rt
235 An ISO 8601 date-time string that corresponds to the time of the last change of
236 the idle-hint\&. This is a hint used to indicate that the session may be idle\&.
237 For sessions with a x11-display set (ie\&. graphical sessions), it is up to each
238 session to delegate the responsibility for updating this value\&. Typically, the
239 screensaver will set this\&.
240 .sp
241 However, for non-graphical sessions with a display-device set the Session
242 object itself will periodically update this value based on the activity
243 detected on the display-device itself\&.
244 .sp
245 This should not be considered authoritative\&.
246 .sp
247 .sp 1
248 .in -24n
249 .SH "EXAMPLES"
250 .PP
251 \fBExample 1: Show running sessions\&.\fR
252 .PP
253 .PP
254 .nf
255 example% \fBck-list-sessions\fR
256 .fi
257 .PP
258 This command would generate output like the following for each session:
259 .PP
260 .PP
261 .nf
262 SessionSeat1Local:
263 unix-user = \&'50\&'
264 realname = \&'GDM Reserved UID\&'
265 seat = \&'Seat1\&'
266 session-type = \&'LoginWindow\&'
267 display-type = \&'Local\&'
268 open = \&'TRUE\&'
269 active = \&'TRUE\&'
270 x11-display = \&':0\&'
271 x11-display-device = \&'/dev/console\&'
272 display-device = \&'/dev/console\&'
273 remote-host-name = \&'\&'
274 is-local = \&'TRUE\&'
275 on-since = \&'2009-08-11T06:46:42\&.941134Z\&'
276 login-session-id = \&'\&'
277 idle-since-hint = \&'\&'
278 .fi
279 .PP
280 \fBExample 2: Show only the session-id, unix-user, and display-type properties\&.\fR
281 .PP
282 .PP
283 .nf
284 example% \fBck-list-sessions -\fB-format="session-id,unix-user,display-type"\fR\fR
285 .fi
286 .PP
287 This command would generate output like the following for each session:
288 .PP
289 .PP
290 .nf
291 SessionSeat1Local 50 Local
292 .fi
293 .SH "FILES"
294 .PP
295 The following files are used by this application:
296 .sp
297 .ne 2
298 .mk
299 \fB\fB/usr/bin/ck-list-sessions\fR\fR
300 .sp .6
301 .in +4
302 Executable for Show ConsoleKit Session Information\&.
303 .sp
304 .sp 1
305 .in -4
306 .sp
307 .ne 2
308 .mk
309 \fB\fB/etc/ConsoleKit/session\&.d\fR\fR
310 .sp .6
311 .in +4
312 ConsoleKit session configuration files\&.
313 .sp
314 .sp 1
315 .in -4
316 .SH "ATTRIBUTES"
317 .PP
318 See
319 \fBattributes\fR(5)
320 for descriptions of the following attributes:
321 .sp
322 .TS
323 tab(\a) allbox;
324 cw(2.750000i)| cw(2.750000i)
325 lw(2.750000i)| lw(2.750000i).
326 ATTRIBUTE TYPE\aATTRIBUTE VALUE
327 Availability\alibrary/xdg/consolekit
328 Interface stability\aVolatile
329 .TE
330 .sp
331 .SH "SEE ALSO"
332 .PP
333 \fBck-history\fR(1),
334 \fBck-launch-session\fR(1),
335 \fBck-seat-tool\fR(1m),
336 \fBconsole-kit-daemon\fR(1m),
337 \fBattributes\fR(5)
338 .SH "NOTES"
339 .PP
340 Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&.
341 Copyright (c) 2009 by Sun Microsystems, Inc\&.
342 ...\" created by instant / solbook-to-man, Tue 27 Jan 2015, 17:22
343 ...\" LSARC 2009/432 ConsoleKit