diff options
| author | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
|---|---|---|
| committer | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
| commit | 5e95d487982b9362b544139b98d1da55fa6ef78c (patch) | |
| tree | 1abf6d91f9e6d0b6d0ac7b7d759663f2531eb51b /doc/source/user/xdg | |
| parent | f7df2f7bb6abbea365cccb1345dcf1a1b7a80797 (diff) | |
| download | goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.gz goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.bz2 goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.zip | |
Add doc
Diffstat (limited to 'doc/source/user/xdg')
| -rw-r--r-- | doc/source/user/xdg/xdg-runtime-dir.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/source/user/xdg/xdg-runtime-dir.html b/doc/source/user/xdg/xdg-runtime-dir.html new file mode 100644 index 0000000..3b17d8b --- /dev/null +++ b/doc/source/user/xdg/xdg-runtime-dir.html @@ -0,0 +1,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> |