Path  XDG

Generated with Razzle Dazzle Redfish

[Validate]

XDG Base Directory Standard

This provides a conveient library for conforming to the XDG Base Directory Standard. 

  http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

Some important clarifications, not made clear by the above specification.

The data directories are for “read-only” files. In other words once something is put there, it should only be read, never written to by a program. (Generally speaking only users or pacakge mangers should be adding, changing or removing files from the data locations.

The config locations are where you should store files that may change, and effect operations depending one there content. This is like etc/ in the FHS, but alterable by end users and and end user programs, not just root and sudo admin scripts.

The cache location stores files that could judt as well be deleted and everyihtng still works find. This is for variable and temporary files. Like var/ in FHS.

This module returns paths as strings.

Public Instance Methods

home() click to toggle source 
# File vendor/path/xdg.rb, line 35
  def home
    ENV['HOME'] || File.expand_path('~')
  end
xdg_cache_file(file) click to toggle source

Find a file or directory in the user cache. 

# File vendor/path/xdg.rb, line 95
  def xdg_cache_file(file)
    File.join(cache_home,file)
  end
xdg_cache_home() click to toggle source

Location of user’s personal cache directory. 

# File vendor/path/xdg.rb, line 72
  def xdg_cache_home
    File.expand_path(
      ENV['XDG_CACHE_HOME'] || File.join(home, '.cache')
    )
  end
xdg_cache_work() click to toggle source

Location of working cache directory. 

# File vendor/path/xdg.rb, line 121
  def xdg_cache_work
    File.expand_path(
      #ENV['XDG_CACHE_WORK'] || File.join(Dir.pwd, '.cache')
      File.join(Dir.pwd, '.cache')
    )
  end
xdg_config_dirs() click to toggle source

List of user’s shared config directories. 

# File vendor/path/xdg.rb, line 47
  def xdg_config_dirs
    dirs = ENV['XDG_CONFIG_DIRS'].split(/[:;]/)
    if dirs.empty?
      dirs = %w{/etc/xdg}
    end
    dir.collect{ |d| File.expand_path(d) }
  end
xdg_config_file(file) click to toggle source

Find a file or directory in config dirs. 

# File vendor/path/xdg.rb, line 87
  def xdg_config_file(file)
    [config_home, *config_dirs].each do |dir|
      path = File.join(dir,file)
      break path if File.exist?(path)
    end
  end
xdg_config_home() click to toggle source

Location of user’s personal config directory. 

# File vendor/path/xdg.rb, line 40
  def xdg_config_home
    File.expand_path(
      ENV['XDG_CONFIG_HOME'] || File.join(home, '.config')
    )
  end
xdg_config_work() click to toggle source

Location of working config directory. 

# File vendor/path/xdg.rb, line 105
  def xdg_config_work
    File.expand_path(
      #ENV['XDG_CONFIG_WORK'] || File.join(Dir.pwd, '.config')
      File.join(Dir.pwd, '.config')
    )
  end
xdg_data_dirs() click to toggle source

List of user’s shared data directores. 

# File vendor/path/xdg.rb, line 63
  def xdg_data_dirs
    dirs = ENV['XDG_DATA_DIRS'].split(/[:;]/)
    if dirs.empty?
      dirs = %w{/usr/local/share/ /usr/share/}
    end
    dir.collect{ |d| File.expand_path(d) }
  end
xdg_data_file(file) click to toggle source

Find a file or directory in data dirs. 

# File vendor/path/xdg.rb, line 79
  def xdg_data_file(file)
    [data_home, *data_dirs].each do |dir|
      path = File.join(dir,file)
      break path if File.exist?(path)
    end
  end
xdg_data_home() click to toggle source

Location of user’s personal data directory. 

# File vendor/path/xdg.rb, line 56
  def xdg_data_home
    File.expand_path(
      ENV['XDG_DATA_HOME'] || File.join(home, '.local', 'share')
    )
  end
xdg_data_work() click to toggle source

Location of working data directory. 

# File vendor/path/xdg.rb, line 113
  def xdg_data_work
    File.expand_path(
      #ENV['XDG_DATA_WORK'] || File.join(Dir.pwd, '.share')
      File.join(Dir.pwd, '.share')
    )
  end

Disabled; run with --debug to generate this.