.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "File::UserDirs 3pm"
.TH File::UserDirs 3pm "2022-11-19" "perl v5.36.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"
File::UserDirs \- Find extra media and documents directories
.SH "VERSION"
.IX Header "VERSION"
version 0.09
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use File::UserDirs qw(:all);
\& print xdg_desktop_dir; # e.g. /home/user/Desktop
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module can be used to find directories as informally specified
by the Freedesktop.org xdg-user-dirs software. This
gives a mechanism to locate extra directories for media and documents files.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
May be exported on request.
Also the group \f(CW\*(C`:all\*(C'\fR is defined which exports all methods.
.SS "xdg_desktop_dir"
.IX Subsection "xdg_desktop_dir"
.Vb 1
\& my $dir = xdg_desktop_dir;
.Ve
.PP
Returns the desktop directory. Unless changed by the user,
this is the directory \fIDesktop\fR in the home directory.
.SS "xdg_documents_dir"
.IX Subsection "xdg_documents_dir"
.Vb 1
\& my $dir = xdg_documents_dir;
.Ve
.PP
Returns the documents directory. Unless changed by the user,
this is the home directory.
.SS "xdg_download_dir"
.IX Subsection "xdg_download_dir"
.Vb 1
\& my $dir = xdg_download_dir;
.Ve
.PP
Returns the download directory. Unless changed by the user,
this is the home directory.
.SS "xdg_music_dir"
.IX Subsection "xdg_music_dir"
.Vb 1
\& my $dir = xdg_music_dir;
.Ve
.PP
Returns the music directory. Unless changed by the user,
this is the home directory.
.SS "xdg_pictures_dir"
.IX Subsection "xdg_pictures_dir"
.Vb 1
\& my $dir = xdg_pictures_dir;
.Ve
.PP
Returns the pictures directory. Unless changed by the user,
this is the home directory.
.SS "xdg_publicshare_dir"
.IX Subsection "xdg_publicshare_dir"
.Vb 1
\& my $dir = xdg_publicshare_dir;
.Ve
.PP
Returns the public share directory. Unless changed by the user,
this is the home directory.
.SS "xdg_templates_dir"
.IX Subsection "xdg_templates_dir"
.Vb 1
\& my $dir = xdg_templates_dir;
.Ve
.PP
Returns the templates directory. Unless changed by the user,
this is the home directory.
.SS "xdg_videos_dir"
.IX Subsection "xdg_videos_dir"
.Vb 1
\& my $dir = xdg_videos_dir;
.Ve
.PP
Returns the videos directory. Unless changed by the user,
this is the home directory.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP """""xdg\-user\-dir"" failed to start: %s""" 4
.el .IP "\f(CW``xdg\-user\-dir'' failed to start: %s\fR" 4
.IX Item """xdg-user-dir"" failed to start: %s"
The executable \f(CW\*(C`xdg\-user\-dir\*(C'\fR could not be run, most likely because it was not
installed. See \*(L"\s-1DEPENDENCIES\*(R"\s0.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
The location of the directories can be specified by the user in the file
\&\fI\f(CI$XDG_CONFIG_HOME\fI/user\-dirs.dirs\fR. It is a shell file setting a number of
environment variables. To find the exact pathname from Perl, run:
.PP
.Vb 2
\& use File::BaseDir qw(config_home);
\& print config_home(\*(Aquser\-dirs.dirs\*(Aq);
.Ve
.SS "Example customised \fIuser\-dirs.dirs\fP"
.IX Subsection "Example customised user-dirs.dirs"
.Vb 8
\& XDG_DESKTOP_DIR="$HOME/Workspace"
\& XDG_DOCUMENTS_DIR="$HOME/Files"
\& XDG_DOWNLOAD_DIR="$HOME/Files/Downloads"
\& XDG_MUSIC_DIR="$HOME/Files/Audio"
\& XDG_PICTURES_DIR="$HOME/Files/Images"
\& XDG_PUBLICSHARE_DIR="$HOME/public_html"
\& XDG_TEMPLATES_DIR="$HOME/Files/Document templates"
\& XDG_VIDEOS_DIR="$HOME/Files/Video"
.Ve
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
This module requires the executable \fIxdg-user-dir\fR from the package
\&\f(CW\*(C`xdg\-user\-dirs\*(C'\fR. Source code is available from
.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Jaap Karssenberg || Pardus [Larus]
.IP "\(bu" 4
Graham Ollis
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2003\-2021 by Jaap Karssenberg || Pardus [Larus] .
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.