.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "File::HomeDir::FreeDesktop 3pm"
.TH File::HomeDir::FreeDesktop 3pm "2018-05-17" "perl v5.26.2" "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"
File::HomeDir::FreeDesktop \- Find your home and other directories on FreeDesktop.org Unix
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides implementations for determining common user
directories.  In normal usage this module will always be
used via File::HomeDir.
.PP
This module can operate only when the command \f(CW\*(C`xdg\-user\-dir\*(C'\fR is available
and executable, which is typically achieved by installed a package named
\&\f(CW\*(C`xdg\-user\-dirs\*(C'\fR or similar.
.PP
One can find the latest spec at <https://specifications.freedesktop.org/basedir\-spec/basedir\-spec\-latest.html>.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use File::HomeDir;
\&  
\&  # Find directories for the current user
\&  $home     = File::HomeDir\->my_home;        # /home/mylogin
\&  $desktop  = File::HomeDir\->my_desktop;
\&  $docs     = File::HomeDir\->my_documents;
\&  $music    = File::HomeDir\->my_music;
\&  $pics     = File::HomeDir\->my_pictures;
\&  $videos   = File::HomeDir\->my_videos;
\&  $data     = File::HomeDir\->my_data;
\&  $config   = File::HomeDir\->my_config;
\&  
\&  # Some undocumented ones, expect they don\*(Aqt work \- use with caution
\&  $download    = File::HomeDir\->my_download;
\&  $publicshare = File::HomeDir\->my_publicshare;
\&  $templates   = File::HomeDir\->my_templates;
\&  $cache       = File::HomeDir\->my_cache;
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
Jerome Quelin <jquellin@cpan.org<gt>
.PP
Adam Kennedy <adamk@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::HomeDir, File::HomeDir::Win32 (legacy)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2009 \- 2011 Jerome Quelin.
.PP
Some parts copyright 2010 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.