XDG
From charlesreid1
Link: https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Basics
The XDG Base Directory Specification is based on the following concepts:
user specific data files:
- There is a single base directory relative to which user-specific data files should be written.
- This directory is defined by the environment variable $XDG_DATA_HOME.
user-specific config files:
- There is a single base directory relative to which user-specific configuration files should be written.
- This directory is defined by the environment variable $XDG_CONFIG_HOME.
base directories for data files:
- 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 $XDG_DATA_DIRS.
base directories for config files:
- There is a set of preference ordered base directories relative to which configuration files should be searched.
- This set of directories is defined by the environment variable $XDG_CONFIG_DIRS.
base directories for cached (non-essential) data:
- There is a single base directory relative to which user-specific non-essential (cached) data should be written.
- This directory is defined by the environment variable $XDG_CACHE_HOME.
base directory for runtime files and other file objects:
- There is a single base directory relative to which user-specific runtime files and other file objects should be placed.
- This directory is defined by the environment variable $XDG_RUNTIME_DIR.
Environment variables
user specific data files:
- $XDG_DATA_HOME defines the base directory relative to which user specific data files should be stored.
- If $XDG_DATA_HOME is either not set or empty, a default equal to $HOME/.local/share should be used.
user specific config files:
- $XDG_CONFIG_HOME defines the base directory relative to which user specific configuration files should be stored.
- If $XDG_CONFIG_HOME is either not set or empty, a default equal to $HOME/.config should be used.
base directories for data files:
- $XDG_DATA_DIRS defines the preference-ordered set of base directories to search for data files in addition to the $XDG_DATA_HOME base directory.
- The directories in $XDG_DATA_DIRS should be seperated with a colon ':'.
- If $XDG_DATA_DIRS is either not set or empty, a value equal to /usr/local/share/:/usr/share/ should be used.
base directories for config files:
- $XDG_CONFIG_DIRS defines the preference-ordered set of base directories to search for configuration files in addition to the $XDG_CONFIG_HOME base directory.
- The directories in $XDG_CONFIG_DIRS should be seperated with a colon ':'.
- If $XDG_CONFIG_DIRS is either not set or empty, a value equal to /etc/xdg should be used.
- The order of base directories denotes their importance; the first directory listed is the most important.
- When the same information is defined in multiple places the information defined relative to the more important base directory takes precedent.
- The base directory defined by $XDG_DATA_HOME is considered more important than any of the base directories defined by $XDG_DATA_DIRS.
- The base directory defined by $XDG_CONFIG_HOME is considered more important than any of the base directories defined by $XDG_CONFIG_DIRS.
non essential data files:
- $XDG_CACHE_HOME defines the base directory relative to which user specific non-essential data files should be stored. If $XDG_CACHE_HOME is either not set or empty, a default equal to $HOME/.cache should be used.
- $XDG_RUNTIME_DIR defines the base directory relative to which user-specific non-essential runtime files and other file objects (such as sockets, named pipes, ...) should be stored.
- The directory MUST be owned by the user, and they MUST be the only one having read and write access to it.
- Its Unix access mode MUST be 0700.
more principles:
- The lifetime of the directory MUST be bound to the user being logged in.
- It MUST be created when the user first logs in and if the user fully logs out the directory MUST be removed.
- If the user logs in more than once he should get pointed to the same directory, and it is mandatory that the directory continues to exist from his first login to his last logout on the system, and not removed in between.
- Files in the directory MUST not survive reboot or a full logout/login cycle.
more more principles:
- The directory MUST be on a local file system and not shared with any other system.
- The directory MUST by fully-featured by the standards of the operating system.
- More specifically, on Unix-like operating systems AF_UNIX sockets, symbolic links, hard links, proper permissions, file locking, sparse files, memory mapping, file change notifications, a reliable hard link count must be supported, and no restrictions on the file name character set should be imposed.
- Files in this directory MAY be subjected to periodic clean-up.
- To ensure that your files are not removed, they should have their access time timestamp modified at least once every 6 hours of monotonic time or the 'sticky' bit should be set on the file.
- If $XDG_RUNTIME_DIR is not set applications should fall back to a replacement directory with similar capabilities and print a warning message.
- Applications should use this directory for communication and synchronization purposes and should not place larger files in it, since it might reside in runtime memory and cannot necessarily be swapped out to disk.