| blob | b7918205b82e4ba51cb2a2353aec0611b62f33a3 |
1 '\" te
2 .TH ck-seat-tool 1m "24 Oct 2009" "SunOS 5.11" "Maintenance Commands"
3 .SH "NAME"
4 ck-seat-tool \- ConsoleKit seat tool
5 .SH "SYNOPSIS"
6 .PP
7 \fBck-seat-tool\fR -\fB-add\fR -\fB-display-type=\fItype\fR\fR [-\fB-seat-id=\fIid\fR\fR] [-\fB-session-type=\fItype\fR\fR] [\fB\fIvariable\fR \fIvariable\fR\fR\&...]
8 .PP
9 \fBck-seat-tool\fR -\fB-delete\fR -\fB-session-id=\fIid\fR\fR
10 .PP
11 \fBck-seat-tool\fR [-\fB-help\fR] [-\fB-version\fR]
12 .SH "DESCRIPTION"
13 .PP
14 \fBck-seat-tool\fR is a utility that causes ConsoleKit to add or delete
15 a ConsoleKit session in a dymanic fashion\&. When adding a session, the
16 -\fB-display-type\fR option must be specified\&. When deleting a
17 session, the -\fB-session-id\fR option must be specified\&.
18 .PP
19 To use \fBck-seat-tool\fR, it must be run as the same user which is
20 running the main ConsoleKit daemon, which is normally the root user\&. Otherwise
21 the request is ignored\&.
22 .PP
23 When adding a session, the -\fB-seat-id\fR option works as follows:
24 .sp
25 .in +2
26 \(bu
27 .mk
28 .in +3
29 .rt
30 If -\fB-seat-id=\fIid\fR\fR is provided and this
31 seat exists, then a new session will be added to that seat\&.
32 .sp
33 .in -3
34 \(bu
35 .mk
36 .in +3
37 .rt
38 If -\fB-seat-id=\fIid\fR\fR is provided, but
39 this seat does not exist, then a new seat with the specified seat\&.
40 \fIid\fR is created, and a new session added to that seat\&.
41 .sp
42 .in -3
43 \(bu
44 .mk
45 .in +3
46 .rt
47 If -\fB-seat-id=\fIid\fR\fR is not given, a new
48 seat \fIid\fR (Seat#) will be generated, and a new session
49 added to that seat\&.
50 .sp
51 .in -3
52 .in -2
53 .PP
54 When adding a session, if session is successfully added, the session ID is
55 printed in the standard output\&.
56 .PP
57 Note that to delete a session which is running on a particular DISPLAY, it
58 may be necessary to run the
59 \fBck\-list\-sessions\fR(1)
60 command to find the corresponding session ID for a given DISPLAY\&.
61 .SH "OPTIONS"
62 .PP
63 The following options are supported:
64 .sp
65 .ne 2
66 .mk
67 \fB-\fBa\fR, -\fB-add\fR\fR
68 .in +24n
69 .rt
70 Add the specified session\&.
71 .sp
72 .sp 1
73 .in -24n
74 .sp
75 .ne 2
76 .mk
77 \fB-\fBd\fR, -\fB-delete\fR\fR
78 .in +24n
79 .rt
80 Delete the specified session\&.
81 .sp
82 .sp 1
83 .in -24n
84 .sp
85 .ne 2
86 .mk
87 \fB-\fB-display-type=\fItype\fR\fR\fR
88 .in +24n
89 .rt
90 This option is only available when adding a session\&. Specifies the display
91 \fItype\fR in the ConsoleKit display configuration that
92 will be associated with the session\&.
93 .sp
94 .sp 1
95 .in -24n
96 .sp
97 .ne 2
98 .mk
99 \fB-\fBh\fR, -\fB-help\fR\fR
100 .in +24n
101 .rt
102 Display detailed usage message\&.
103 .sp
104 .sp 1
105 .in -24n
106 .sp
107 .ne 2
108 .mk
109 \fB-\fB-seat-id=\fIid\fR\fR\fR
110 .in +24n
111 .rt
112 This option is only available when adding a session\&. Specifies the seat
113 \fIid\fR that will be associated with the session\&.
114 .sp
115 .sp 1
116 .in -24n
117 .sp
118 .ne 2
119 .mk
120 \fB-\fB-session-id=\fIid\fR\fR\fR
121 .in +24n
122 .rt
123 This option is only available when deleting a session\&. Specifies the session
124 \fIid\fR associated with session that will be deleted\&.
125 .sp
126 .sp 1
127 .in -24n
128 .sp
129 .ne 2
130 .mk
131 \fB-\fB-session-type=\fItype\fR\fR\fR
132 .in +24n
133 .rt
134 This option is only available when adding a session\&. Specifies the session
135 \fItype\fR that will be associated with the session\&. The
136 default value is "LoginWindow"\&.
137 .sp
138 .sp 1
139 .in -24n
140 .sp
141 .ne 2
142 .mk
143 \fB-\fBV\fR, -\fB-version\fR\fR
144 .in +24n
145 .rt
146 Display the version of the \fBck-seat-tool\fR application\&.
147 .sp
148 .sp 1
149 .in -24n
150 .SH "OPERANDS"
151 .PP
152 The following operand is supported only when adding a session:
153 .sp
154 .ne 2
155 .mk
156 \fB\fB\fIvariable\fR\fR\fR
157 .sp .6
158 .in +4
159 The \fIvariable\fR operand is only available when adding a
160 sesssion\&. The command to run when starting a session is specified in a
161 ConsoleKit display configuration file named
162 \fB/etc/ConsoleKit/displays\&.d/\fIdisplay_type\fR\&.display\fR,
163 where \fIdisplay_type\fR is specified by the
164 -\fB-display-type\fR option\&. This file is in standard INI format\&.
165 The command is specified by the key "X11/Exec"\&. For example:
166 .sp
167 .nf
168 .sp
169 [X11]
170 Exec=/usr/X11/bin/Xorg $display -br -verbose $vt
171 .fi
172 .sp
173 Arguments that start with the "$" sign are variables\&. The values
174 for these variables can be specified with the
175 \fIvariable\fR operand\&. For example, if this value is
176 "display=:0 vt=vt9", this would set the "$display"
177 argument to ":0" and the "$vt" argument to "vt9"\&.
178 .sp
179 .sp 1
180 .in -4
181 .SH "EXAMPLES"
182 .PP
183 \fBExample 1: To add a session to the next available seat with a display type of
184 "Local" and start it on display ":20"\fR
185 .PP
186 .PP
187 .nf
188 example% \fBck-seat-tool -\fBa\fR -\fB-display-type=Local\fR display=:20\fR
189 .fi
190 .PP
191 \fBExample 2: To add a session to Seat10 with a session type of
192 "LoginWindow", a display type of "Local", and
193 start it on display ":20"\fR
194 .PP
195 .PP
196 .nf
197 example% \fBck-seat-tool -\fBa\fR -\fB-session-type=LoginWindow\fR -\fB-display-type=Local\fR -\fB-seat-id=Seat10\fR display=:20\fR
198 .fi
199 .PP
200 \fBExample 3: To remove the session with session ID
201 "/org/freedesktop/ConsoleKit/Session2"\fR
202 .PP
203 .PP
204 .nf
205 example% \fBck-seat-tool -\fB-d\fR -\fB-session-id=/org/freedesktop/ConsoleKit/Session2\fR\fR
206 .fi
207 .SH "EXIT STATUS"
208 .PP
209 The following exit values are returned:
210 .sp
211 .ne 2
212 .mk
213 \fB\fB0\fR\fR
214 .in +9n
215 .rt
216 Application exited successfully
217 .sp
218 .sp 1
219 .in -9n
220 .sp
221 .ne 2
222 .mk
223 \fB\fB1\fR\fR
224 .in +9n
225 .rt
226 Application exited with failure
227 .sp
228 .sp 1
229 .in -9n
230 .SH "FILES"
231 .PP
232 The following files are used by this application:
233 .sp
234 .ne 2
235 .mk
236 \fB\fB/usr/sbin/ck-seat-tool\fR\fR
237 .sp .6
238 .in +4
239 Executable for ConsoleKit seat tool\&.
240 .sp
241 .sp 1
242 .in -4
243 .sp
244 .ne 2
245 .mk
246 \fB\fB/etc/ConsoleKit/displays\&.d\fR\fR
247 .sp .6
248 .in +4
249 ConsoleKit display configuration files\&.
250 .sp
251 .sp 1
252 .in -4
253 .SH "ATTRIBUTES"
254 .PP
255 See
256 \fBattributes\fR(5)
257 for descriptions of the following attributes:
258 .sp
259 .TS
260 tab(\a) allbox;
261 cw(2.750000i)| cw(2.750000i)
262 lw(2.750000i)| lw(2.750000i).
263 ATTRIBUTE TYPE\aATTRIBUTE VALUE
264 Availability\alibrary/xdg/consolekit
265 Interface stability\aVolatile
266 .TE
267 .sp
268 .SH "SEE ALSO"
269 .PP
270 \fBck-history\fR(1),
271 \fBck-launch-session\fR(1),
272 \fBck-list-sessions\fR(1),
273 \fBconsole-kit-daemon\fR(1m),
274 \fBattributes\fR(5)
275 .SH "NOTES"
276 .PP
277 Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&.
278 Copyright (c) 2009 by Sun Microsystems, Inc\&.
279 ...\" created by instant / solbook-to-man, Tue 27 Jan 2015, 17:22
280 ...\" LSARC 2009/432 ConsoleKit