Difference between revisions of "XDG Base Directory"

From ArchWiki
Jump to: navigation, search
m (The XDG Base Directory specification: Remove "The")
m (XDG Base Directory specification: fix link)
Line 15: Line 15:
 
Please read the [http://standards.freedesktop.org/basedir-spec/latest/ full specification]. This section will attempt to break down the essence of what it tries to achieve.
 
Please read the [http://standards.freedesktop.org/basedir-spec/latest/ full specification]. This section will attempt to break down the essence of what it tries to achieve.
  
Only {{ic|XDG_RUNTIME_DIR}} is set by default through [http://www.freedesktop.org/software/systemd/man/pam_systemd.html pam_systemd]. It is up to the user to explicitly [[define]] the other variables, using absolute paths that point to existing directories.
+
Only {{ic|XDG_RUNTIME_DIR}} is set by default through [http://www.freedesktop.org/software/systemd/man/pam_systemd.html pam_systemd]. It is up to the user to explicitly [[Environment_variables#Defining_variables | define]] the other variables, using absolute paths that point to existing directories.
  
 
===User directories===
 
===User directories===

Revision as of 23:08, 20 January 2017

This article exists to catalog the growing set of software using the XDG Base Directory Specification introduced in 2003. This is here to demonstrate the viability of this specification by listing commonly found dotfiles and their support status. For those not currently supporting the Base Directory Specification, workarounds will be demonstrated to emulate it instead.

The workarounds will be limited to anything not involving patching the source, executing code stored in environment variables or compile-time options. The rationale for this is that configurations should be portable across systems and having compile-time options prevent that.

Hopefully this will provide a source of information about exactly what certain kinds of dotfiles are and where they come from.

XDG Base Directory specification

Please read the full specification. This section will attempt to break down the essence of what it tries to achieve.

Only XDG_RUNTIME_DIR is set by default through pam_systemd. It is up to the user to explicitly define the other variables, using absolute paths that point to existing directories.

User directories

  • XDG_CONFIG_HOME
    • Where user-specific configurations should be written (analogous to /etc).
    • Should default to $HOME/.config.
  • XDG_CACHE_HOME
    • Where user-specific non-essential (cached) data should be written (analogous to /var/cache).
    • Should default to $HOME/.cache.
  • XDG_DATA_HOME
    • Where user-specific data files should be written (analogous to /usr/share).
    • Should default to $HOME/.local/share.
  • XDG_RUNTIME_DIR
    • Used for non-essential, user-specific data files such as sockets, named pipes, etc.
    • Not required to have a default value; warnings should be issued if not set or equivalents provided.
    • Must be owned by the user with an access mode of 0700.
    • Filesystem fully featured by standards of OS.
    • Must be on the local filesystem.
    • May be subject to periodic cleanup.
    • Modified every 6 hours or set sticky bit if persistence is desired.
    • Can only exist for the duration of the user's login.
    • Should not store large files as it may be mounted as a tmpfs.

System directories

  • XDG_DATA_DIRS
    • List of directories seperated by : (analogous to PATH).
    • Should default to /usr/local/share:/usr/share.
  • XDG_CONFIG_DIRS
    • List of directories seperated by : (analogous to PATH).
    • Should default to /etc/xdg.

Contributing

When contributing make sure to use the correct section.

Nothing should require code evaluation (such as vim and VIMINIT), patches or compile-time options to gain support and anything which does must be deemed hardcoded. Additionally if the process is too error prone or difficult, such as Haskell's cabal or eclipse, they should also be considered as hardcoded.

  • The first column should be the project name, ideally the command name if it is not ambigious, linked to their website or an appropriate internal wiki article.
  • The second column is for any legacy files and directories the project had, this is done so people can find them even if they are no longer read.
  • In the third, try to find the commit or version a project switched to XDG Base Directory or any open discussions and include them in the next two columns.
  • Finally the fourth should include any appropriate workarounds or solutions for unsupported projects. Be terse, this article assumes intelligence and good charity from the reader. If something is unclear then feel free to expend some explanation to clarify it.

Lastly, and this goes without saying, please verify that your solution is correct and functional.

Supported

Application Legacy Path Supported Since Discussion Notes
antimicro ~/.antimicro edba864 [1]
aria2 ~/.aria2 8bc1d37 [2]
blender ~/.blender 4293f473 [3]
burp f2388e9
chromium ~/.chromium 23057 [4] [5]
citra ~/.citra-emu f7c3193fec [6]
cower 8b70805
d-feet ~/.d-feet 7f6104b
dconf
dolphin-emu ~/.dolphin-emu a498c68 [7]
dunst 78b6e2b1 [8]
dwb
fish
fontconfig ~/.fontconfig 8c255fb1
fontforge ~/.FontForge ~/.PfaEdit e4c2cc7432 [9] [10]
fontconfig ~/.fonts Use "$XDG_DATA_HOME"/fonts instead.
freerdp ~/.freerdp edf6e7258d
gconf ~/.gconf fc28caa7 [11]
git ~/.gitconfig 0d94427e
gstreamer-1.0 4e36f93924cf [12]
gtk3
htop ~/.htoprc 93233a67
i3 ~/.i3 7c130fb54
i3status ~/.i3status.conf c3f7fc4994
imagemagick
inkscape ~/.inkscape 0.47 [13]
latexmk ~/.latexmkrc 2016-08-17
lftp ~/.lftp 21dc400 [14]
lgogdownloader ~/.gogdownloader d430af63d000 [15]
LibreOffice a6f56f70 25bd2eec [16]
livestreamer ~/.livestreamerrc ea805917 [17]
llpp 3ab86f0cb Currently llpp places the configuration directly under XDG_CONFIG_HOME instead of creating a directory.
mc ~/.mc 1b9957058 0b7115647 ce401d797 [18]
mintty ~/.minttyrc cff1bd8f v2.3.7. [19]
milkytracker ~/.milkytracker_config eb487c55 [20]
mpd ~/.mpdconf 87b73284
mpv ~/.mpv cb250d490 [21]
mutt ~/.mutt 42fee7585f [22]
mypaint ~/.mypaint cf723b74cd
ncmpcpp ~/.ncmpcpp 38d9f811 27cd86e0 [23] [24] ncmpcpp_directory should be set to avoid an error.log file in ~/.ncmpcpp.
neovim ~/.nvim ~/.nvimlog ~/.nviminfo 1ca5646bb [25] [26]
newsbeuter ~/.newsbeuter 3c57824c5 [27] It is required to create both "$XDG_DATA_HOME"/newsbeuter and "$XDG_CONFIG_HOME"/newsbeuter [28]
OfflineIMAP ~/.offlineimaprc 5150de5 [29]
opentyrian ~/.opentyrian 8d45ff2 [30]
pcsx2 ~/.pcsx2 87f1e8f77 a9020c606 3b22f0fb0 0a012aec2 [31] [32]
ppsspp ~/.ppsspp 132fe47c7d [33]
orbment
pacman ~/.makepkg.conf 80eca94c8 [34]
PulseAudio ~/.pulse ~/.pulse-cookie 59a8618dcd9 87ae8307057 9ab510a6921 4c195bcc9d5 [35]
pyroom
qutebrowser
qtile fd8686e 66d704b 51cff01 [36] Some optional bar widgets can create files and directories in non-compliant paths, but most often these are still configurable.
retroarch
rr ~/.rr 02e7d41e [37]
surfraw ~/.surfraw.conf ~/.surfraw.bookmarks 3e4591d8 bd8c427d f57fc718
sway ~/.sway/config 614393c09 [38]
systemd
termite
transmission ~/.transmission 5517 [39]
util-linux 570b32100
vimb
VLC media player ~/.vlcrc 16f32e15 [40]
wireshark ~/.wireshark b0b53fa5
xsettingsd ~/.xsettingsd 4ecd7be
warsow ~/.warsow-2.x 98ece3f [41]
uzbl c6fd63a [42]
VirtualBox ~/.VirtualBox 4.3 [43]

Partial

Application Legacy Path Supported Since Discussion Notes
abook ~/.abook $ abook --config "$XDG_CONFIG_HOME"/abook/abookrc \

--datafile "$XDG_CACHE_HOME"/abook/addressbook

Anki ~/Anki ~/Documents/Anki [44] [45] $ anki -b "$XDG_DATA_HOME"/Anki
Atom ~/.atom $ export ATOM_HOME="$XDG_DATA_HOME"/atom
aspell ~/.aspell.conf
cargo ~/.cargo [46] [47] $ export CARGO_HOME="$XDG_DATA_HOME"/cargo
ccache ~/.ccache $ export CCACHE_DIR="$XDG_CACHE_HOME"/ccache
conky ~/.conkyrc 00481ee [48] $ conky --config="$XDG_CONFIG_HOME"/conky/conkyrc
crawl ~/.crawl $ export CRAWL_DIR="$XDG_DATA_HOME"/crawl/ # Trailing '/' is required.
composer ~/.composer $ export COMPOSER_HOME="$XDG_CONFIG_HOME"/composer

$ export COMPOSER_CACHE_DIR="$XDG_CACHE_HOME"/composer

coreutils ~/.dircolors $ source "$(dircolors "$XDG_CONFIG_HOME"/dircolors)"
dict ~/.dictrc $ dict -c "$XDG_CONFIG_HOME"/dict/dictrc
ELinks ~/.elinks $ export ELINKS_CONFDIR="$XDG_CONFIG_HOME"/elinks
emscripten ~/.emscripten ~/.emscripten_sanity ~/.emscripten_ports ~/.emscripten_cache__last_clear 3624 $ export EM_CONFIG="$XDG_CONFIG_HOME"/emscripten/config

$ export EM_CACHE="$XDG_CACHE_HOME"/emscripten/cache $ export EM_PORTS="$XDG_DATA_HOME"/emscripten/cache $ emcc --em-config "$XDG_CONFIG_HOME"/emscripten/config --em-cache "$XDG_CACHE_HOME"/emscripten/cache

PulseAudio ~/.esd_auth Very likely generated by the module-esound-protocol-unix.so module. It can be configured to use a different location but it makes much more sense to just comment out this module in /etc/pulse/default.pa or "$XDG_CONFIG_HOME"/pulse/default.pa.
gdb ~/.gdbinit $ gdb -nh -x "$XDG_CONFIG_HOME"/gdb/init
GIMP ~/.gimp-2.8 60e0cfe [49] [50] $ export GIMP2_DIRECTORY="$XDG_CONFIG_HOME"/gimp
gliv ~/.glivrc $ gliv --glivrc="$XDG_CONFIG_HOME"/gliv/glivrc
GnuPG ~/.gnupg [51] [52] $ export GNUPGHOME="$XDG_CONFIG_HOME"/gnupg

$ gpg2 --homedir "$XDG_CONFIG_HOME"/gnupg

gtk2 ~/.gtkrc-2.0 $ export GTK2_RC_FILES="$XDG_CONFIG_HOME"/gtk-2.0/gtkrc
Google Earth ~/.googleearth Some paths can be changed with the KMLPath and CachePath options in ~/.config/Google/GoogleEarthPlus.conf
gtk ~/.gtkrc $ export GTK_RC_FILES="$XDG_CONFIG_HOME"/gtk-1.0/gtkrc
httpie ~/.httpie [53] $ export HTTPIE_CONFIG_DIR="$XDG_CONFIG_HOME"/httpie
irssi ~/.irssi [54] irssi --config="$XDG_CONFIG_HOME"/irssi/config --home="$XDG_DATA_HOME"/irssi
ipython/jupyter ~/.ipython $ export IPYTHONDIR="$XDG_CONFIG_HOME"/jupyter

$ export JUPYTER_CONFIG_DIR="$XDG_CONFIG_HOME"/jupyter

isync ~/.mbsyncrc $ mbsync -c "$XDG_CONFIG_HOME"/isync/mbsyncrc
libice ~/.ICEauthority [55] $ export ICEAUTHORITY="$XDG_RUNTIME_DIR"/X11/iceauthority
less ~/.lesshst $ export LESSHISTFILE="$XDG_CACHE_HOME"/less/history (It is required to create the "$XDG_CACHE_HOME"/less directory manually.)

$ export LESSHISTFILE=- can be used to disable this feature.

$ export LESSKEY="$XDG_CONFIG_HOME"/less/lesskey

libdvdcss ~/.dvdcss [56] $ export DVDCSS_CACHE="$XDG_DATA_HOME"/dvdcss
ltrace ~/.ltrace.conf $ ltrace -F "$XDG_CONFIG_HOME"/ltrace/ltrace.conf
Mathematica ~/.Mathematica $ export MATHEMATICA_USERBASE="$XDG_CONFIG_HOME"/mathematica
mednafen ~/.mednafen $ export MEDNAFEN_HOME="$XDG_CONFIG_HOME"/mednafen
moc ~/.moc $ mocp -M "$XDG_CONFIG_HOME"/moc

$ mocp -O MOCDir="$XDG_CONFIG_HOME"/moc

MPlayer ~/.mplayer $ export MPLAYER_HOME="$XDG_CONFIG_HOME"/mplayer
notmuch ~/.notmuch-config [57] $ export NOTMUCH_CONFIG="$XDG_CONFIG_HOME"/notmuch/notmuchrc

$ export NMBGIT="$XDG_DATA_HOME"/notmuch/nmbug

ncurses ~/.terminfo $ export TERMINFO="$XDG_DATA_HOME"/terminfo # Precludes system path searching.

$ export TERMINFO_DIRS="$XDG_DATA_HOME"/terminfo:/usr/share/terminfo

npm ~/.npm ~/.npmrc [58] $ export NPM_CONFIG_USERCONFIG=$XDG_CONFIG_HOME/npm/npmrc
npmrc
cache=$XDG_CACHE_HOME/npm
prefix=$XDG_DATA_HOME/npm
NVIDIA, CUDA ~/.nv $ export __GL_SHADER_DISK_CACHE_PATH="$XDG_CACHE_HOME"/nv

$ export CUDA_CACHE_PATH="$XDG_CACHE_HOME"/nv

openscad ~/.OpenSCAD 7c3077b0f [59] Does not fully honour XDG Base Directory Specification, see [60]

Currently it hard-codes ~/.local/share.

OpenSSL ~/.rnd Seeding file .rnd's location can be set with RANDFILE environment variable per FAQ.
pass ~/.password-store $ export PASSWORD_STORE_DIR="$XDG_DATA_HOME"/pass
pidgin ~/.purple $ pidgin --config="$XDG_DATA_HOME"/purple
python-setuptools ~/.python-eggs $ export PYTHON_EGG_CACHE="$XDG_CACHE_HOME"/python-eggs
rclone ~/.rclone.conf $ rclone --config="$XDG_CONFIG_HOME"/rclone/rclone.conf
readline ~/.inputrc $ export INPUTRC="$XDG_CONFIG_HOME"/readline/inputrc
rlwrap ~/.*_history [61] $ export RLWRAP_HOME="$XDG_DATA_HOME"/rlwrap
screen ~/.screenrc $ export SCREENRC="$XDG_CONFIG_HOME"/screen/screenrc
stack ~/.stack [62] $ export STACK_ROOT="$XDG_DATA_HOME"/stack
subversion ~/.subversion [63] [64][65] $ svn --config-dir "$XDG_CONFIG_HOME"/subversion
task ~/.task

~/.taskrc

$ export TASKDATA="$XDG_DATA_HOME"/task

$ export TASKRC="$XDG_CONFIG_HOME"/task/taskrc

tig ~/.tigrc $ export TIGRC_USER="$XDG_CONFIG_HOME"/tig/tigrc
tmux ~/.tmux.conf [66] [67] $ tmux -f "$XDG_CONFIG_HOME"/tmux/tmux.conf

$ export TMUX_TMPDIR="$XDG_RUNTIME_DIR"/tmux

Unison ~/.unison $ export UNISON="$XDG_DATA_HOME"/unison
urxvtd ~/.urxvt/urxvtd-hostname $ export RXVT_SOCKET="$XDG_RUNTIME_DIR"/urxvt/urxvt-"$(hostname)"
WeeChat ~/.weechat [68] $ export WEECHAT_HOME="$XDG_CONFIG_HOME"/weechat

$ weechat -d "$XDG_CONFIG_HOME"/weechat

wget ~/.wgetrc $ export WGETRC="$XDG_CONFIG_HOME/wgetrc"
wine ~/.wine [69] $ export WINEPREFIX="$XDG_DATA_HOME"/wine
xorg-xauth ~/.Xauthority $ export XAUTHORITY="$XDG_RUNTIME_DIR"/X11/xauthority
libx11 ~/.XCompose $ export XCOMPOSEFILE="$XDG_CONFIG_HOME"/X11/xcompose
xorg-xinit ~/.xinitrc $ export XINITRC="$XDG_CONFIG_HOME"/X11/xinitrc
xorg-xrdb ~/.Xresources ~/.Xdefaults Ultimately you should be using Xresources and since these resources are loaded via xrdb you can specify a path such as xrdb -load ~/.config/X11/xresources.
uncrustify ~/.uncrustify.cfg $ export UNCRUSTIFY_CONFIG="$XDG_CONFIG_HOME"/uncrustify/uncrustify.cfg
xsel ~/.xsel.log [70] $ xsel --logfile "$XDG_CACHE_HOME"/xsel/xsel.log
ChezScheme ~/.chezscheme_history $ petite --eehistory "$XDG_DATA_HOME"/chezscheme/history
nvidia-settings ~/.nvidia-settings-rc $ nvidia-settings --config="$XDG_CONFIG_HOME"/nvidia/settings
get_iplayer ~/.get_iplayer $ export GETIPLAYERUSERPREFS="$XDG_DATA_HOME"/get_iplayer

Hardcoded

Application Legacy Path Supported Since Discussion Notes
Apache Directory Studio ~/.ApacheDirectoryStudio
AMule ~/.aMule
bash ~/.bashrc ~/.bash_history ~/.bash_profile ~/.bash_login ~/.bash_logout [71]
  • A specified bashrc can be sourced from /etc/bashrc
  • export HISTFILE="$XDG_DATA_HOME"/bash/history
cabal ~/.cabal [72] See discussion for potential workarounds. It is not very easy or straightforward but may be possible to emulate Base Directory compliance.
CUPS ~/.cups [73]
dbus ~/.dbus [74] This should be avoidable with kdbus [citation needed].
eclipse ~/.eclipse [75] Option -Dosgi.configuration.area=@user.home/.config/.. overrides but must be added to "$ECLIPSE_HOME"/eclipse.ini" rather than command line which means you must have write access to $ECLIPSE_HOME. (Arch Linux hard-codes $ECLIPSE_HOME in /usr/bin/eclipse)
emacs ~/.emacs ~/.emacs.d [76] It's possible to set HOME, but it has unexpected side effects. So far the most promising approach is modifying another Emacs environment variable to alter the load path and author your own site file which can manually load up your init file, but it changes the load process significantly.
Fetchmail ~/.fetchmailrc
Firefox ~/.mozilla [77]
GNU parallel ~/.parallel
idris ~/.idris
julia ~/.juliarc.jl ~/.julia_history [78] [79]
lldb ~/.lldb ~/.lldbinit
mathomatic ~/.mathomaticrc ~/.matho_history History can be moved by using rlwrap mathomatic -r with the RLWRAP_HOME environment set appropriately.
Mercurial ~/.hgrc You cannot append to the configuration search paths, just overwrite them completely. That means you need to be careful to add all default folders: export HGRCPATH=/usr/lib/python2.7/site-packages/mercurial/default.d/:/etc/mercurial/hgrc:"${XDG_CONFIG_HOME}"/mercurial/hgrc

To find the default configuration paths, use this: env -u HGRCPATH hg debugconfig --debug | grep "read config"

milkytracker ~/.milkytracker_config [80]
mongodb ~/.mongorc.js ~/.dbshell [81] This Stack Overflow thread suggests a partial workaround using command-line switch --norc.
ncmpc ~/.ncmpc
~/.netrc Like ~/.ssh, many programs expect this file to be here. These include projects like curl (CURLOPT_NETRC_FILE), ftp (NETRC), s-nail (NETRC), etc. While some of them offer alternative configurable locations, many do not such as w3m, wget and lftp.
NSS ~/.pki [82]
OpenSSH ~/.ssh [83] Assumed to be present by many ssh daemons and clients such as DropBear and OpenSSH.
palemoon ~/.moonchild productions [84]
perf ~/.debug Hardcoded in tools/perf/util/config.c:18.
python ~/.python_history All history from interactive sessions is saved to ~/.python_history by default since version 3.4, custom path can still be set the same way as in older versions (see this example).
procps-ng ~/.toprc [85] [86]
SeaMonkey ~/.mozilla [87]
Skype ~/.Skype [88]
SpamAssassin ~/.spamassassin
spectrwm ~/.spectrwm
SQLite ~/.sqlite_history [89][90]
Thunderbird ~/.thunderbird [91]
vim ~/.vim ~/.vimrc ~/.viminfo Since 7.3.1178 vim will search for ~/.vim/vimrc if ~/.vimrc is not found.
~/.vim/vimrc
set undodir=~/.cache/vim/undo " vim will not create this directory.
set directory=~/.cache/vim/swap " vim will not create this directory.
set backupdir=~/.cache/vim/backup " vim will not create this directory.
set viminfo+=n~/.cache/vim/viminfo
vimperator ~/.vimperatorrc [92] $ export VIMPERATOR_INIT=":source $XDG_CONFIG_HOME/vimperator/vimperatorrc"

$ export VIMPERATOR_RUNTIME="$XDG_CONFIG_HOME"/vimperator

wpa_cli ~/.wpa_cli_history
xdg-utils ~/.gnome For some reason the script xdg-desktop-menu hard-codes gnome_user_dir="$HOME/.gnome/apps". This is used by chromium amoung others.
xmonad ~/.xmonad [93]
xombrero ~/.xombrero [94]
zsh ~/.zshrc ~/.zprofile ~/.zshenv ~/.zlogin ~/.zlogout ~/.histfile [95] Consider exporting ZDOTDIR=$HOME/.config/zsh in ~/.zshenv (this is hardcoded due to the bootstrap problem). You could also add this to /etc/zsh/zshenv and avoid the need for any dotfiles in your HOME. Doing this however requires root privilege which may not be viable and is system-wide.

export HISTFILE="$XDG_DATA_HOME"/zsh/history

racket ~/.racketrc

Library and language support

C
C99: Cloudef's simple implementation.
Haskell
Officially in directory since 1.2.3.0 ab9d0810ce.
xdg-basedir
Perl
File-BaseDir
perl-file-xdg
Python
pyxdg
Vala
Builtin support via GLib.Environment.
See get_user_cache_dir, get_user_data_dir, get_user_config_dir, etc.

See also