.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MooX::File::ConfigDir 3pm"
.TH MooX::File::ConfigDir 3pm "2019-02-21" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MooX::File::ConfigDir \- Moo eXtension for File::ConfigDir
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    my App;
\&
\&    use Moo;
\&    with MooX::File::ConfigDir;
\&
\&    1;
\&
\&    package main;
\&
\&    my $app = App\->new();
\&    $app\->config_identifier(\*(AqMyProject\*(Aq);
\&
\&    my @cfgdirs = @{ $app\->config_dirs };
\&
\&    # install support
\&    my $site_cfg_dir = $app\->site_cfg_dir\->[0];
\&    my $vendor_cfg_dir = $app\->site_cfg_dir\->[0];
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a helper for easily find configuration file locations.
Whether to use this information for find a suitable place for installing
them or looking around for finding any piece of settings, heavily depends
on the requirements.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "config_identifier"
.IX Subsection "config_identifier"
Allows to deal with a global unique identifier passed to the functions of
File::ConfigDir. Using it encapsulates configuration files from the
other ones (e.g. \f(CW\*(C`/etc/apache2\*(C'\fR vs. \f(CW\*(C`/etc\*(C'\fR).
.PP
\&\f(CW\*(C`config_identifier\*(C'\fR can be initialized by specifying it as parameter
during object construction or via inheriting default builder
(\f(CW\*(C`_build_config_identifier\*(C'\fR).
.SS "system_cfg_dir"
.IX Subsection "system_cfg_dir"
Provides the configuration directory where configuration files of the
operating system resides. For details see \*(L"system_cfg_dir\*(R" in File::ConfigDir.
.SS "desktop_cfg_dir"
.IX Subsection "desktop_cfg_dir"
Provides the configuration directory where configuration files of the
desktop applications resides. For details see \*(L"desktop_cfg_dir\*(R" in File::ConfigDir.
.SS "xdg_config_dirs"
.IX Subsection "xdg_config_dirs"
Alias for desktop_cfg_dir to support
\&\s-1XDG\s0 Base Directory Specification <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>
.SS "core_cfg_dir"
.IX Subsection "core_cfg_dir"
Provides the configuration directory of the Perl5 core location.
For details see \*(L"core_cfg_dir\*(R" in File::ConfigDir.
.SS "site_cfg_dir"
.IX Subsection "site_cfg_dir"
Provides the configuration directory of the Perl5 sitelib location.
For details see \*(L"site_cfg_dir\*(R" in File::ConfigDir.
.SS "vendor_cfg_dir"
.IX Subsection "vendor_cfg_dir"
Provides the configuration directory of the Perl5 vendorlib location.
For details see \*(L"vendor_cfg_dir\*(R" in File::ConfigDir.
.SS "singleapp_cfg_dir"
.IX Subsection "singleapp_cfg_dir"
Provides the configuration directory of \f(CW$0\fR if it's installed as
a separate package \- either a program bundle (\s-1TSM,\s0 Oracle \s-1DB\s0) or
an independent package combination (e.g. via PkgSrc <http://www.pkgsrc.org/>
For details see \*(L"singleapp_cfg_dir\*(R" in File::ConfigDir.
.SS "vendorapp_cfg_dir"
.IX Subsection "vendorapp_cfg_dir"
Provides the configuration directory of \f(CW$0\fR if it's installed as
a separate package via a vendor installation as e.g. PkgSrc <http://www.pkgsrc.org/>
or Homebrew <https://brew.sh/>.
For details see \*(L"vendorapp_cfg_dir\*(R" in File::ConfigDir.
.SS "local_cfg_dir"
.IX Subsection "local_cfg_dir"
Returns the configuration directory for distribution independent, 3rd
party applications. For details see \*(L"local_cfg_dir\*(R" in File::ConfigDir.
.SS "locallib_cfg_dir"
.IX Subsection "locallib_cfg_dir"
Provides the configuration directory of the Perl5 local::lib environment
location.  For details see \*(L"locallib_cfg_dir\*(R" in File::ConfigDir.
.SS "here_cfg_dir"
.IX Subsection "here_cfg_dir"
Provides the path for the \f(CW\*(C`etc\*(C'\fR directory below the current working directory.
For details see \*(L"here_cfg_dir\*(R" in File::ConfigDir.
.SS "user_cfg_dir"
.IX Subsection "user_cfg_dir"
Provides the users home folder using File::HomeDir.
For details see \*(L"user_cfg_dir\*(R" in File::ConfigDir.
.SS "xdg_config_home"
.IX Subsection "xdg_config_home"
Returns the user configuration directory for desktop applications.
For details see \*(L"xdg_config_home\*(R" in File::ConfigDir.
.SS "config_dirs"
.IX Subsection "config_dirs"
Tries to get all available configuration directories as described above.
Returns those who exists and are readable.
For details see \*(L"config_dirs\*(R" in File::ConfigDir.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jens Rehsack, \f(CW\*(C`<rehsack at cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-MooX\-File\-ConfigDir at rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MooX\-File\-ConfigDir>.
I will be notified, and then you'll automatically be notified of progress
on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc MooX::File::ConfigDir
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooX\-File\-ConfigDir>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/MooX\-File\-ConfigDir>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/m/MooX\-File\-ConfigDir>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/MooX\-File\-ConfigDir/>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2013\-2018 Jens Rehsack.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.