userdirs

object userdirs

Common directories for user applications, as specified by the XDG Base Directory Specification, with some adaptations made for macOS.

See also

dirs for conventional directories for an application of a given name, including system services.

class Object
trait Matchable
class Any

Type members

Classlikes

case class project(name: String)

Same as userdirs, but with a project name appended to every path.

Same as userdirs, but with a project name appended to every path.

Value members

Concrete methods

def cacheHome: Path

A directory in which to read and write user-specific non-essential (cached) data.

A directory in which to read and write user-specific non-essential (cached) data.

Should be considered read-writable.

Corresponds to XDG_CACHE_HOME.

def configDirs: List[Path]

A list of preference ordered directories relative to which configuration files should be searched, in addition to configHome.

A list of preference ordered directories relative to which configuration files should be searched, in addition to configHome.

Should be considered read-only.

Corresponds to XDG_CONFIG_DIRS.

def configHome: Path

A directory relative to which user-specific configuration files should be written.

A directory relative to which user-specific configuration files should be written.

Should be considered read-writable.

Corresponds to XDG_CONFIG_HOME.

def dataDirs: List[Path]

A list of preference ordered directories relative to which data files should be searched, in addition to dataHome.

A list of preference ordered directories relative to which data files should be searched, in addition to dataHome.

Should be considered read-only.

Corresponds to XDG_DATA_DIRS.

def dataHome: Path

A directory relative to which user-specific data files should be written.

A directory relative to which user-specific data files should be written.

Should be considered read-writable.

Corresponds to XDG_DATA_HOME.

def runtime: Path

A directory in which to read and write user-specific runtime files, such as sockets and small temporary files.

A directory in which to read and write user-specific runtime files, such as sockets and small temporary files.

Should be considered read-writable.

Corresponds to XDG_RUNTIME_DIR, with a fallback to ~/.run