Home / ubuntu / Questions / 59822
Accepted
8128
Asked: 2011-09-04 01:43:34 +0800 CST

Where to store user settings for an app?

  • 772

If I want my application to store a few settings, that persist when an application closes, then where should I store them?

I'm not talking anything complicated: two booleans and a string (although in the future I might want to store more complex settings)

I've heard gconf, dconf, gsettings, etc all mentioned. What is the "preferred" method? Preferably one that's nice and easy in Python.

python

3 Answers

  1. Application runs system wide

    the appropriate place to store settings would be:

    /etc/[application]/

    where a subdirectory is optional.

    Application runs in a per user mode

    settings should be stored in the user HOME, preferably in a hidden directory:

    /home/<user>/<.application>/

    See also the Debian FHS.

    Applications running in X-Desktop

    Applications for the X-Desktop (e.g. GNOME, KDE, Unity, Xfce) should refer to the XDG Base Directory Specification where the following file locations are defined in local variables:

    • $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.

    • $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.

    • $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.

    • $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.

    • 10
  2. Best Answer

    gconf is deprecated, so for a new project I would not use it. dconf is a backend for storing the settings, as an application developer you should normally not have to bother with it.

    What you seem to need is gsettings, a high-level API (API documentation for C) to store/retrieve settings without bothering how/where they are actually stored. gsettings is part of gio, which is one of the core packages of gnome (like glib and gobject). This blog post gives a short introduction how to use it with Python.

    If you do not want any dependencies on gio (e.g. you are not developing a GNOME application) and want to store simple config files, I'd suggest to use the $HOME/.config directory (or whatever directory defined by $XDG_CONFIG_DIRS) instead of $HOME/.your_appname, in line with the freedesktop spec.

    • 9

  3. Quickly, which is is one of the newer helpers for application development for Ubuntu, defaults to storing all preferences with desktopcouch. The advantage is that those settings can be synchronized with other installations via the Ubuntu One tools.

    • 1