Forum: Ruby XDG v0.5.2 released

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
unknown (Guest)
on 2009-05-30 23:50
(Received via mailing list)
= XDG Base Directory Standard for Ruby

  http://xdg.rubyforge.org

== Introduction

XDG provides an easy to use module for utilizing the XDG Base Directory
Standard[1].

If your program utilizes user or system-wide support files (eg.
configuration files), you owe it to yourself to checkout the XDG
standard.

What's next? The API should be stable now. I do not forsee and reasons
for it to change. In the future, I may add some additional ruby-esque
features, perhaps for other parts of the XDG utilities, but that should
be purely in addition to what is already here. If all this holds true
for a while a 1.0 release will be forth-coming.

[1]http://standards.freedesktop.org/basedir-spec/base...

== Release Notes

This release requires rbconfig.rb and uses system entries in place of
hardcoded FHS locations.

### 0.5.2 / 2009-05-30

* 1 Major Enhancement

    * replaced hardcoded system directories with rbconfig entries.

== Usage

XDG is a module with a small set of easy to use methods:

  XDG.config_home
  XDG.config_dirs
  XDG.config_find(pattern){ |path| ... }
  XDG.config_select(pattern){ |path| ... }

  XDG.data_home
  XDG.data_dirs
  XDG.data_find(pattern){ |path| ... }
  XDG.data_select(pattern){ |path| ... }

  XDG.cache_home
  XDG.cache_find(pattern){ |path| ... }
  XDG.cache_select(pattern){ |path| ... }

  XDG.config_work
  XDG.cache_work

If you know XDG these are pretty much self-explanitory. But see the
RDocs for specifics.

== Installation

Using RubyGems:

  $ sudo gem install xdg

Installing the tarball requires Ruby Setup (see
http://setup.rubyforge.org).

  $ tar -xvzf xdg-0.5.2
  $ cd xdg-0.5.2
  $ sudo setup.rb all

== Development

Visit http://rubyforge.org/projects/xdg

== Copyright

Copyright (c) 2008 Tiger Ops / 7rans Distributed under the terms of the
MIT license.
This topic is locked and can not be replied to.