summaryrefslogtreecommitdiffstats
path: root/doc/source/user/xdg/xdg-runtime-dir.html
blob: 3b17d8b4b7fcbde63aa51a4699921cbbfb15a021 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!DOCTYPE html>
<html>
	<head>
    	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    	<meta http-equiv="Content-Language" content="en" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
    	<title>xdg-runtime-dir</title>
    	<meta name="Description" content="User oneshot to create and remove the XDG_RUNTIME_DIR." />
    	<meta name="Keywords" content="goetia s6-rc bundle xdg runtime directory user supervision tree" />
	</head>
	<header>
		<p>
			<a href="//0x53.net/software/goetia/goetia-base">goetia-base</a>
			<br />
			<a href="//0x53.net/software/goetia">goetia</a>
			<br />
			<a href="//0x53.net/software">Software</a>
			<br />
			<a href="//0x53.net">0x53.net</a>
		</p>
	</header>
	<body>
		<h1>The xdg-runtime-dir service</h1>
		<p>
    		This service dynamically creates the directory
    		specified in the environment variable
    		<code>XDG_RUNTIME_DIR</code>.
		</p>
		<p>
    		Starting this service creates the directory
    		and sets the proper permissions,
    		stopping it deletes it.
		</p>
		<p>
    		It is recommended to set
    		<code>XDG_RUNTIME_DIR</code>
    		to the
    		<code><var>@USER@</var>/<var>@USERTREE@</var>/xdg-runtime-dir</code>
    		subdirectory of the
    		<a href="//0x53.net/software/goetia/rundir.html#user">user runtime directory</a>.
    		This allows to follow the
    		<a href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</a>.
		</p>
		<p>
    		If more than one
    		<a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>
    		<em>per user</em> is used to have multiple
    		<a href="//0x53.net/software/goetia/tutorials/ui/seatsession.html">sessions</a>
    		with a distinct UI server, audio server, etc.
    		It makes sense for each session to have its own,
    		distinct <code>xdg-runtime-dir</code>,
    		since it is often used for sockets and temporary files
    		of said UI server, audio server, etc.
    		Setting
    		<code>XDG_RUNTIME_DIR</code>
    		as described above, allows for this.
    		Note, however, that this deviates from the
    		<a href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</a>.
		</p>
		<p>
    		All user services writing to or reading from
    		<code>XDG_RUNTIME_DIR</code>
    		should depend on this service.
		</p>
		<h2>See also</h2>
		<ul>
    		<li>
        		<a href="//0x53.net/software/goetia/tutorials/ui/seatsession.html">seat and session management</a>
    		</li>
    		<li>
    			<a href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</a>.
    		</li>
		</ul>
	</body>
</html>