diff options
| author | piegames <git@piegames.de> | 2020-11-07 18:00:48 +0000 |
|---|---|---|
| committer | David Faure <faure@kde.org> | 2020-11-07 18:00:48 +0000 |
| commit | 4f2884e16db35f2962d9b64312917c81be5cb54b (patch) | |
| tree | fd7072301cd8f41760f612eca3d7e275c87edaf6 /basedir/basedir-spec.xml | |
| parent | d68714f779c0d068837e108ff3bdad3d02477b88 (diff) | |
Add XDG_STATE_DIR
Diffstat (limited to 'basedir/basedir-spec.xml')
| -rw-r--r-- | basedir/basedir-spec.xml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/basedir/basedir-spec.xml b/basedir/basedir-spec.xml index 1ed79dc..8658aa9 100644 --- a/basedir/basedir-spec.xml +++ b/basedir/basedir-spec.xml @@ -68,6 +68,13 @@ </listitem> <listitem> <para> + There is a single base directory relative to which user-specific + state data should be written. This directory is defined by the + environment variable <literal>$XDG_STATE_HOME</literal>. + </para> + </listitem> + <listitem> + <para> There is a set of preference ordered base directories relative to which data files should be searched. This set of directories is defined by the environment variable <literal>$XDG_DATA_DIRS</literal>. @@ -122,6 +129,22 @@ <literal>$HOME</literal>/.config should be used. </para> <para> + <literal>$XDG_STATE_HOME</literal> defines the base directory relative to + which user-specific state files should be stored. If + <literal>$XDG_STATE_HOME</literal> is either not set or empty, a default equal to + <literal>$HOME</literal>/.local/state should be used. + </para> + <para> + The <literal>$XDG_STATE_HOME</literal> contains state data that should persist between + (application) restarts, but that is not important or portable enough to the user that it should be stored + in <literal>$XDG_DATA_HOME</literal>. It may contain: + <itemizedlist> + <listitem><para>actions history (logs, history, recently used files, …)</para></listitem> + <listitem><para>current state of the application that can be reused on a restart (view, layout, + open files, undo history, …)</para></listitem> + </itemizedlist> + </para> + <para> <literal>$XDG_DATA_DIRS</literal> defines the preference-ordered set of base directories to search for data files in addition to the <literal>$XDG_DATA_HOME</literal> base directory. |