view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    [version 0.06]

     my @dirs = $xdg->config_dirs_list;

    Returns the system config directories as a list of path class objects.

 exe_dir

    [version 0.10]

     my $exe = $xdg->exe_dir;

    Returns the user-specific executable files directory $HOME/.local/bin,
    if it exists. If it does not exist then undef will be returned. This
    directory should be added to the PATH according to the spec.

 lookup_data_file

     my $xdg = File::XDG->new( name => $name, api => 1 ); # recommended
     my $path = $xdg->lookup_data_File($filename);

    Looks up the data file by searching for ./$name/$filename (where $name
    is provided by the constructor) relative to all base directories
    indicated by $XDG_DATA_HOME and $XDG_DATA_DIRS. If an environment
    variable is either not set or empty, its default value as defined by
    the specification is used instead. Returns a path class object.

     my $xdg = File::XDG->new( name => $name ); # back compat only
     my $path = $xdg->lookup_data_file($subdir, $filename);

    Looks up the data file by searching for ./$subdir/$filename relative to
    all base directories indicated by $XDG_DATA_HOME and $XDG_DATA_DIRS. If
    an environment variable is either not set or empty, its default value
    as defined by the specification is used instead. Returns a path class
    object.

 lookup_config_file

     my $xdg = File::XDG->new( name => $name, api => 1 ); # recommended
     my $path = $xdg->lookup_config_file($filename);

    Looks up the configuration file by searching for ./$name/$filename
    (where $name is provided by the constructor) relative to all base
    directories indicated by $XDG_CONFIG_HOME and $XDG_CONFIG_DIRS. If an
    environment variable is either not set or empty, its default value as
    defined by the specification is used instead. Returns a path class
    object.

     my $xdg = File::XDG->new( name => $name ); # back compat only
     my $path = $xdg->lookup_config_file($subdir, $filename);

    Looks up the configuration file by searching for ./$subdir/$filename
    relative to all base directories indicated by $XDG_CONFIG_HOME and
    $XDG_CONFIG_DIRS. If an environment variable is either not set or
    empty, its default value as defined by the specification is used
    instead. Returns a path class object.

SEE ALSO

    XDG Base Directory specification, version 0.7
    <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>

CAVEATS

    This module intentionally and out of necessity does not follow the spec
    on the following platforms:

    MSWin32 (Strawberry Perl, Visual C++ Perl, etc)

      The spec requires : as the path separator, but use of this character
      is essential for absolute path names in Windows, so the Windows Path
      separator ; is used instead.

      There are no global data or config directories in windows so the data
      and config directories are empty list instead of the default UNIX
      locations.

      The base directory instead of being the user's home directory is
      %LOCALAPPDATA%. Arguably the data and config base directory should be
      %APPDATA%, but cache should definitely be in %LOCALAPPDATA%, and we
      chose to use just one base directory for simplicity.

SEE ALSO

    Path::Class

      Portable native path class used by this module used by default (api =
      0) and optionally (api = 1).

    Path::Tiny

      Smaller lighter weight path class used optionally (api = 0) and by
      default (api = 1).

    Path::Spec

      Core Perl library for working with file and directory paths.

    File::BaseDir

      Provides similar functionality to this module with a different
      interface.

AUTHOR

    Original author: Síle Ekaterin Aman

    Current maintainer: Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

    This software is copyright (c) 2012-2022 by Síle Ekaterin Aman.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.