File::H...Desktop(3)

💖 NAME 💖

File::HomeDir::FreeDesktop — Find your home and other directories on FreeDesktop.org Unix.

Okay bestie, this is the File::H...Desktop(3) page, aka User Contributed Perl Documentation, and the module behind the curtain is File::HomeDir::FreeDesktop. Iconic. 🎀

✨ DESCRIPTION ✨

This module provides implementations for determining common user directories. In normal usage this module will always be used via File::HomeDir — that’s the main character energy.

Vibe check: this module can operate only when the command xdg-user-dir is available and executable. That’s typically achieved by having a package named xdg-user-dirs or similar installed. No command, no slay.

You can find the latest spec at <https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html> — go read it, iykyk. 💅

🦋 SYNOPSIS 🦋

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't work - use with caution
$download    = File::HomeDir->my_download;
$publicshare = File::HomeDir->my_publicshare;
$templates   = File::HomeDir->my_templates;
$cache       = File::HomeDir->my_cache;

The code comment literally says: some undocumented ones, expect they don't work - use with caution. 🫶

👑 AUTHORS 👑

The legends who made this happen:

• Jerome Quelin <jquellin@cpan.org<gt>
• Adam Kennedy <adamk@cpan.org>

🌈 SEE ALSO 🌈

Go peek at File::HomeDir, File::HomeDir::Win32 (legacy). The legacy one is right there in the list, periodt. 👀

🎀 COPYRIGHT 🎀

Copyright 2009 - 2011 Jerome Quelin.

Some parts copyright 2010 Adam Kennedy.

Some parts copyright 2017 - 2020 Jens Rehsack

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

The full text of the license can be found in the LICENSE file included with this module.

---

Source/version: perl v5.42.0 ✨ date: 2020-09-29 🎀 — that’s the footer tea, bestie. 🫶