File::H...ir::Unix(3)

🌸 File::HomeDir::Unix 🌸

okay bestie so this is the File::HomeDir::Unix page — it's from the User Contributed Perl Documentation, and it's literally all about finding your home and other directories on legacy Unix 💅 ("legacy" is doing a lot of work in that sentence, iykyk).

---

✨ NAME ✨

File::HomeDir::Unix — find your home and other directories on legacy Unix 🏠

---

🎀 SYNOPSIS 🎀

okay so here's how you actually use it, no cap:

  use File::HomeDir;

  # Find directories for the current user
  $home    = File::HomeDir->my_home;        # /home/mylogin
  $desktop = File::HomeDir->my_desktop;     # All of these will...
  $docs    = File::HomeDir->my_documents;   # ...default to home...
  $music   = File::HomeDir->my_music;       # ...directory
  $pics    = File::HomeDir->my_pictures;    #
  $videos  = File::HomeDir->my_videos;      #
  $data    = File::HomeDir->my_data;        #

the way that $home gives you /home/mylogin and then everything else just defaults to your home directory — iconic behaviour honestly 🫶

---

🦋 DESCRIPTION 🦋

so like, this module provides implementations for determining common user directories ✨

and in normal usage? bestie, this module will always be used via File::HomeDir — you don't call it directly, that's the vibe 🌈

---

💖 SUPPORT 💖

see the support section the main File::HomeDir module 🌸 (yes, that's how it's worded, and yes, we're keeping it)

---

👑 AUTHORS 👑

• Adam Kennedy <adamk@cpan.org> 💜
• Sean M. Burke <sburke@cpan.org> 💜

---

⭐ SEE ALSO ⭐

• File::HomeDir
• File::HomeDir::Win32 (legacy) 💀

---

🌸 COPYRIGHT 🌸

copyright is serious business even when you're being cute about it 💅

• Copyright 2005 - 2011 Adam Kennedy.
• Copyright 2017 - 2020 Jens Rehsack
• Some parts copyright 2000 Sean M. Burke.

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 📄

---

okay that's the whole page, you ate that 💅✨ — this was File::HomeDir::Unix(3), generated as perl v5.42.0 on 2020-09-29 🎀🦋 mwah 💜