.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Config::Find::WinAny 3pm"
.TH Config::Find::WinAny 3pm "2021-01-06" "perl v5.32.0" "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"
Config::Find::WinAny \- Behaviours common to any Win32 OS for Config::Find
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # don\*(Aqt use Config::Find::WinAny directly
\&  use Config::Find;
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
Implements features common to all the Win32 \s-1OS\s0's
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements Config::Find for Win32 \s-1OS\s0's.
.PP
\&\fB\s-1WARNING\s0!!!\fR Configuration file placement has changed on version 0.15
to be more Windows friendly (see note below).
.PP
Order for config files searching is... (see note at the end for
entries marked as 1b and 2b)
.PP
.Vb 3
\&  1  ${LOCAL_APPDATA}/$name.cfg                [user]
\& (1b /$path_to_script/Users/$user/$name.cfg    [user])
\&  2  /$path_to_script/$name.cfg                [global]
.Ve
.PP
unless when \f(CW$ENV{${name}_HOME}\fR is defined. That changes the search
paths to...
.PP
.Vb 2
\& (1b $ENV{${name}_HOME}/Users/$user/$name.cfg  [user])
\&  2  $ENV{${name}_HOME}/$name.cfg              [global]
.Ve
.PP
When the \*(L"several configuration files in one directory\*(R" approach is
used, the order is something different...
.PP
.Vb 4
\&  1  ${LOCAL_APPDATA}/$dir/$name.cfg              [user]
\& (1b /$path_to_script/Users/$user/$dir/$name.cfg  [user])
\&  2  /$path_to_script/$name.cfg                   [global]
\& (2b /$path_to_script/$dir/$name.dfg              [global])
.Ve
.PP
(it is also affected by \f(CW$ENV{${name}_HOME}\fR variable)
.PP
Note: entries marked as 1b were the default behaviour for versions of
Config::Find until 0.14. New behaviour is to put user application
configuration data under ${\s-1LOCAL_APPDATA\s0} as returned by
\&\f(CW\*(C`Win32::GetFolderPath(CSIDL_LOCAL_APPDATA)\*(C'\fR (if this call fails, the
old approach is used).  Also, global configuration files were stored
under a new directory placed in the same directory as the script but
this is unnecessary because windows apps already go in their own
directory.
.PP
It seems that, sometimes, ${\s-1LOCAL_APPDATA\s0} points to the user desktop
and placing configuration files there would be obviously wrong. As a
work around, the module will ignore ${\s-1LOCAL_APPDATA\s0} or ${\s-1APPDATA\s0} if
they point to any place below the desktop path.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Find, Config::Find::Any
.SH "AUTHOR"
.IX Header "AUTHOR"
Salvador Fandiño García, <sfandino@yahoo.com>
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Barbie, <barbie@missbarbell.co.uk> (some bug fixes and documentation)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2003\-2015 by Salvador Fandiño García (sfandino@yahoo.com)
Copyright 2015 by Barbie (barbie@missbarbell.co.uk)
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.