]>
Commit | Line | Data |
---|---|---|
b856b346 ZJS |
1 | <?xml version='1.0'?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > | |
4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> | |
5 | ||
6 | <refentry id="org.freedesktop.home1" conditional='ENABLE_HOMED' | |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
8 | <refentryinfo> | |
9 | <title>org.freedesktop.home1</title> | |
10 | <productname>systemd</productname> | |
11 | </refentryinfo> | |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>org.freedesktop.home1</refentrytitle> | |
15 | <manvolnum>5</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>org.freedesktop.home1</refname> | |
20 | <refpurpose>The D-Bus interface of systemd-homed</refpurpose> | |
21 | </refnamediv> | |
22 | ||
23 | <refsect1> | |
24 | <title>Introduction</title> | |
25 | ||
26 | <para> | |
27 | <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
28 | is a system service which may be used to to create, remove, change or inspect home areas. This page | |
29 | describes the D-Bus interface. | |
30 | </para> | |
31 | </refsect1> | |
32 | ||
33 | <refsect1> | |
34 | <title>The Manager Object</title> | |
35 | ||
36 | <para>The service exposes the following interfaces on the Manager object on the bus:</para> | |
37 | ||
38 | <programlisting executable="systemd-homed" node="/org/freedesktop/home1" interface="org.freedesktop.home1.Manager"> | |
39 | node /org/freedesktop/home1 { | |
40 | interface org.freedesktop.home1.Manager { | |
41 | methods: | |
42 | GetHomeByName(in s user_name, | |
43 | out u uid, | |
44 | out s home_state, | |
45 | out u gid, | |
46 | out s real_name, | |
47 | out s home_directory, | |
48 | out s shell, | |
49 | out o bus_path); | |
50 | GetHomeByUID(in u uid, | |
51 | out s user_name, | |
52 | out s home_state, | |
53 | out u gid, | |
54 | out s real_name, | |
55 | out s home_directory, | |
56 | out s shell, | |
57 | out o bus_path); | |
58 | GetUserRecordByName(in s user_name, | |
59 | out s user_record, | |
60 | out b incomplete, | |
61 | out o bus_path); | |
62 | GetUserRecordByUID(in u uid, | |
63 | out s user_record, | |
64 | out b incomplete, | |
65 | out o bus_path); | |
66 | ListHomes(out a(susussso) home_areas); | |
67 | ActivateHome(in s user_name, | |
68 | in s user_record); | |
69 | DeactivateHome(in s user_name); | |
70 | RegisterHome(in s home_record); | |
71 | UnregisterHome(in s user_name); | |
72 | CreateHome(in s home_record); | |
73 | RealizeHome(in s user_name, | |
74 | in s user_record); | |
75 | RemoveHome(in s user_name); | |
76 | FixateHome(in s user_name, | |
77 | in s user_record); | |
78 | AuthenticateHome(in s user_name, | |
79 | in s user_record); | |
80 | UpdateHome(in s user_record); | |
81 | ResizeHome(in s user_name, | |
82 | in t size, | |
83 | in s user_record); | |
84 | ChangePasswordHome(in s user_name, | |
85 | in s new_user_record, | |
86 | in s old_user_record); | |
87 | LockHome(in s user_name); | |
88 | UnlockHome(in s user_name, | |
89 | in s user_record); | |
90 | AcquireHome(in s user_name, | |
91 | in s user_record, | |
92 | in b please_suspend, | |
93 | out h send_fd); | |
94 | RefHome(in s user_name, | |
95 | in b please_suspend, | |
96 | out h send_fd); | |
97 | ReleaseHome(in s user_name); | |
98 | LockAllHomes(); | |
99 | properties: | |
100 | readonly a(sso) AutoLogin = [...]; | |
101 | }; | |
102 | interface org.freedesktop.DBus.Peer { ... }; | |
103 | interface org.freedesktop.DBus.Introspectable { ... }; | |
104 | interface org.freedesktop.DBus.Properties { ... }; | |
105 | }; | |
106 | </programlisting> | |
107 | ||
108 | <!--method GetHomeByName is not documented!--> | |
109 | ||
110 | <!--method GetHomeByUID is not documented!--> | |
111 | ||
112 | <!--method GetUserRecordByName is not documented!--> | |
113 | ||
114 | <!--method GetUserRecordByUID is not documented!--> | |
115 | ||
116 | <!--method ListHomes is not documented!--> | |
117 | ||
118 | <!--method ActivateHome is not documented!--> | |
119 | ||
120 | <!--method DeactivateHome is not documented!--> | |
121 | ||
122 | <!--method RegisterHome is not documented!--> | |
123 | ||
124 | <!--method UnregisterHome is not documented!--> | |
125 | ||
126 | <!--method CreateHome is not documented!--> | |
127 | ||
128 | <!--method RealizeHome is not documented!--> | |
129 | ||
130 | <!--method RemoveHome is not documented!--> | |
131 | ||
132 | <!--method FixateHome is not documented!--> | |
133 | ||
134 | <!--method AuthenticateHome is not documented!--> | |
135 | ||
136 | <!--method UpdateHome is not documented!--> | |
137 | ||
138 | <!--method ResizeHome is not documented!--> | |
139 | ||
140 | <!--method ChangePasswordHome is not documented!--> | |
141 | ||
142 | <!--method LockHome is not documented!--> | |
143 | ||
144 | <!--method UnlockHome is not documented!--> | |
145 | ||
146 | <!--method AcquireHome is not documented!--> | |
147 | ||
148 | <!--method RefHome is not documented!--> | |
149 | ||
150 | <!--method ReleaseHome is not documented!--> | |
151 | ||
152 | <!--method LockAllHomes is not documented!--> | |
153 | ||
154 | <!--property AutoLogin is not documented!--> | |
155 | ||
156 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
157 | ||
158 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.home1.Manager"/> | |
159 | ||
160 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.home1.Manager"/> | |
161 | ||
162 | <variablelist class="dbus-method" generated="True" extra-ref="GetHomeByName()"/> | |
163 | ||
164 | <variablelist class="dbus-method" generated="True" extra-ref="GetHomeByUID()"/> | |
165 | ||
166 | <variablelist class="dbus-method" generated="True" extra-ref="GetUserRecordByName()"/> | |
167 | ||
168 | <variablelist class="dbus-method" generated="True" extra-ref="GetUserRecordByUID()"/> | |
169 | ||
170 | <variablelist class="dbus-method" generated="True" extra-ref="ListHomes()"/> | |
171 | ||
172 | <variablelist class="dbus-method" generated="True" extra-ref="ActivateHome()"/> | |
173 | ||
174 | <variablelist class="dbus-method" generated="True" extra-ref="DeactivateHome()"/> | |
175 | ||
176 | <variablelist class="dbus-method" generated="True" extra-ref="RegisterHome()"/> | |
177 | ||
178 | <variablelist class="dbus-method" generated="True" extra-ref="UnregisterHome()"/> | |
179 | ||
180 | <variablelist class="dbus-method" generated="True" extra-ref="CreateHome()"/> | |
181 | ||
182 | <variablelist class="dbus-method" generated="True" extra-ref="RealizeHome()"/> | |
183 | ||
184 | <variablelist class="dbus-method" generated="True" extra-ref="RemoveHome()"/> | |
185 | ||
186 | <variablelist class="dbus-method" generated="True" extra-ref="FixateHome()"/> | |
187 | ||
188 | <variablelist class="dbus-method" generated="True" extra-ref="AuthenticateHome()"/> | |
189 | ||
190 | <variablelist class="dbus-method" generated="True" extra-ref="UpdateHome()"/> | |
191 | ||
192 | <variablelist class="dbus-method" generated="True" extra-ref="ResizeHome()"/> | |
193 | ||
194 | <variablelist class="dbus-method" generated="True" extra-ref="ChangePasswordHome()"/> | |
195 | ||
196 | <variablelist class="dbus-method" generated="True" extra-ref="LockHome()"/> | |
197 | ||
198 | <variablelist class="dbus-method" generated="True" extra-ref="UnlockHome()"/> | |
199 | ||
200 | <variablelist class="dbus-method" generated="True" extra-ref="AcquireHome()"/> | |
201 | ||
202 | <variablelist class="dbus-method" generated="True" extra-ref="RefHome()"/> | |
203 | ||
204 | <variablelist class="dbus-method" generated="True" extra-ref="ReleaseHome()"/> | |
205 | ||
206 | <variablelist class="dbus-method" generated="True" extra-ref="LockAllHomes()"/> | |
207 | ||
208 | <variablelist class="dbus-property" generated="True" extra-ref="AutoLogin"/> | |
209 | ||
210 | <!--End of Autogenerated section--> | |
211 | ||
212 | <refsect2> | |
213 | <title>Methods</title> | |
214 | ||
215 | <para>...</para> | |
216 | </refsect2> | |
217 | ||
218 | <refsect2> | |
219 | <title>Signals</title> | |
220 | ||
221 | <para>...</para> | |
222 | </refsect2> | |
223 | </refsect1> | |
224 | ||
225 | <refsect1> | |
226 | <title>The Home Object</title> | |
227 | ||
228 | <programlisting executable="systemd-homed" node="/org/freedesktop/home1/home" interface="org.freedesktop.home1.Home"> | |
229 | node /org/freedesktop/home1/home { | |
230 | interface org.freedesktop.home1.Home { | |
231 | methods: | |
232 | Activate(in s user_record); | |
233 | Deactivate(); | |
234 | Unregister(); | |
235 | Realize(in s user_record); | |
236 | Remove(); | |
237 | Fixate(in s user_record); | |
238 | Authenticate(in s user_record); | |
239 | Update(in s user_record); | |
240 | Resize(in t size, | |
241 | in s user_record); | |
242 | ChangePassword(in s new_user_record, | |
243 | in s old_user_record); | |
244 | Lock(); | |
245 | Unlock(in s user_record); | |
246 | Acquire(in s user_record, | |
247 | in b please_suspend, | |
248 | out h send_fd); | |
249 | Ref(in b please_suspend, | |
250 | out h send_fd); | |
251 | Release(); | |
252 | properties: | |
253 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
254 | readonly s UserName = '...'; | |
255 | readonly u UID = ...; | |
256 | readonly (suusss) UnixRecord = ...; | |
257 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
258 | readonly s State = '...'; | |
259 | @org.freedesktop.DBus.Property.EmitsChangedSignal("invalidates") | |
260 | readonly (sb) UserRecord = ...; | |
261 | }; | |
262 | interface org.freedesktop.DBus.Peer { ... }; | |
263 | interface org.freedesktop.DBus.Introspectable { ... }; | |
264 | interface org.freedesktop.DBus.Properties { ... }; | |
265 | interface org.freedesktop.DBus.ObjectManager { ... }; | |
266 | }; | |
267 | </programlisting> | |
268 | ||
269 | <!--method Activate is not documented!--> | |
270 | ||
271 | <!--method Deactivate is not documented!--> | |
272 | ||
273 | <!--method Unregister is not documented!--> | |
274 | ||
275 | <!--method Realize is not documented!--> | |
276 | ||
277 | <!--method Remove is not documented!--> | |
278 | ||
279 | <!--method Fixate is not documented!--> | |
280 | ||
281 | <!--method Authenticate is not documented!--> | |
282 | ||
283 | <!--method Update is not documented!--> | |
284 | ||
285 | <!--method Resize is not documented!--> | |
286 | ||
287 | <!--method ChangePassword is not documented!--> | |
288 | ||
289 | <!--method Lock is not documented!--> | |
290 | ||
291 | <!--method Unlock is not documented!--> | |
292 | ||
293 | <!--method Acquire is not documented!--> | |
294 | ||
295 | <!--method Ref is not documented!--> | |
296 | ||
297 | <!--method Release is not documented!--> | |
298 | ||
299 | <!--property UserName is not documented!--> | |
300 | ||
301 | <!--property UID is not documented!--> | |
302 | ||
303 | <!--property UnixRecord is not documented!--> | |
304 | ||
305 | <!--property State is not documented!--> | |
306 | ||
307 | <!--property UserRecord is not documented!--> | |
308 | ||
309 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
310 | ||
311 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.DBus.ObjectManager"/> | |
312 | ||
313 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.home1.Home"/> | |
314 | ||
315 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.DBus.ObjectManager"/> | |
316 | ||
317 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.home1.Home"/> | |
318 | ||
319 | <variablelist class="dbus-method" generated="True" extra-ref="Activate()"/> | |
320 | ||
321 | <variablelist class="dbus-method" generated="True" extra-ref="Deactivate()"/> | |
322 | ||
323 | <variablelist class="dbus-method" generated="True" extra-ref="Unregister()"/> | |
324 | ||
325 | <variablelist class="dbus-method" generated="True" extra-ref="Realize()"/> | |
326 | ||
327 | <variablelist class="dbus-method" generated="True" extra-ref="Remove()"/> | |
328 | ||
329 | <variablelist class="dbus-method" generated="True" extra-ref="Fixate()"/> | |
330 | ||
331 | <variablelist class="dbus-method" generated="True" extra-ref="Authenticate()"/> | |
332 | ||
333 | <variablelist class="dbus-method" generated="True" extra-ref="Update()"/> | |
334 | ||
335 | <variablelist class="dbus-method" generated="True" extra-ref="Resize()"/> | |
336 | ||
337 | <variablelist class="dbus-method" generated="True" extra-ref="ChangePassword()"/> | |
338 | ||
339 | <variablelist class="dbus-method" generated="True" extra-ref="Lock()"/> | |
340 | ||
341 | <variablelist class="dbus-method" generated="True" extra-ref="Unlock()"/> | |
342 | ||
343 | <variablelist class="dbus-method" generated="True" extra-ref="Acquire()"/> | |
344 | ||
345 | <variablelist class="dbus-method" generated="True" extra-ref="Ref()"/> | |
346 | ||
347 | <variablelist class="dbus-method" generated="True" extra-ref="Release()"/> | |
348 | ||
349 | <variablelist class="dbus-property" generated="True" extra-ref="UserName"/> | |
350 | ||
351 | <variablelist class="dbus-property" generated="True" extra-ref="UID"/> | |
352 | ||
353 | <variablelist class="dbus-property" generated="True" extra-ref="UnixRecord"/> | |
354 | ||
355 | <variablelist class="dbus-property" generated="True" extra-ref="State"/> | |
356 | ||
357 | <variablelist class="dbus-property" generated="True" extra-ref="UserRecord"/> | |
358 | ||
359 | <!--End of Autogenerated section--> | |
360 | ||
361 | </refsect1> | |
362 | ||
363 | <refsect1> | |
364 | <title>Versioning</title> | |
365 | ||
366 | <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html"> | |
367 | the usual interface versioning guidelines</ulink>.</para> | |
368 | </refsect1> | |
369 | </refentry> |