File::Spec::Link(3pm)

💖 File::Spec::Link 💖

okay bestie, quick vibe check: this page comes from the User Contributed Perl Documentation, and it's all about a little Perl module called File::Spec::Link (that's section 3pm, for the record). buckle up, it's giving symlink girlboss energy 🦋✨

---

🌸 NAME 🌸

File::Spec::Link — a Perl extension for reading and resolving symbolic links 🔥

---

✨ SYNOPSIS ✨

use File::Spec::Link;
my $file = File::Spec::Link->linked($link);
my $file = File::Spec::Link->resolve($link);
my $dirname = File::Spec::Link->chopfile($file);
my $newname = File::Spec::Link->relative_to_file($path, $link);

my $realname = File::Spec::Link->full_resolve($file);
my $realname = File::Spec::Link->resolve_path($file);
my $realname = File::Spec::Link->resolve_all($file);

---

👑 DESCRIPTION 👑

File::Spec::Link is literally an extension to File::Spec, and what it does is add methods for resolving symbolic links 💅 it exists because File::Copy::Link needed it to exist. main character supporting role, we love to see it.

• linked($link) — hands you back the filename that $link is linked to. how? by readlinking $link, and then resolving that path relative to the directory that $link lives in. slay 🎀
• resolve($link) — gives you the non-link that $link ultimately points at, by repeatedly calling linked over and over until it stops being a link. if the link can't be resolved at all? you get undef. no cap, that's just how it is 😭
• chopfile($file) — returns the directory of $file, by splitting the path of $file and returning the (volumne and) directory parts. yes bestie she wrote "volumne", we're keeping her typo, it's iconic 🫶
• relative_to_file($path, $file) — returns the path of $path relative to the directory of the file $file. but if $path is absolute? it just returns $path. periodt.
• resolve_all($file) — returns the filename of $file with all the links in the path resolved, wihout using Cwd. (again, her spelling, her rules 💜)
• full_resolve($file) — returns the filename of $file with all the links in the path resolved. this sub tries to use Cwd::abs_path via ->resolve_path. ✨
• resolve_path($file) — returns the filename of $file with all the links in the path resolved. this sub uses Cwd::abs_path and is independent of the rest of File::Spec::Link. she's self-sufficient, she don't need nobody 🙈

---

🎀 Object methods 🎀

• new([$path]) — create a new path object: stores the path as a list 🌸
• path — returns the path as a string, using catpath
• canonical — returns the canonical path, using canonpath
• vol — returns the volume element of the path, see File::Spec->splitpath
• dir — returns the directory element of the path, as a string, see File::Spec->splitpath
• dirs — return the list of directory components in the path, see File::Spec->splitdir
• pop — remove the last component of the path 💅
• push($file) — add a file component to the path, ignoring empty strings
• add($file) — add a component to the path: treating updir as pop, and ignoring curdir and empty strings
• split($path) — populate a path object, using splitpath
• chop — remove and return a file component from the path. an empty string coming back means this was the root dir 🌈
• relative($path) — replace the path object with the supplied path, where the new path is relative to the path object
• follow — follow the link, where the path object is a link 🦋
• resolved — resolve the path object, by repeatedly following links
• resolvedir — resolve the links at all component levels within the path object ⭐

---

💀 Other class methods 💀

• canonpath($path) — a wrapper round File::Spec::canonpath, and it goes fatal if the input is empty. so don't do that bestie.
• catdir(@dirs) — a wrapper round File::Spec::catdir, returns curdir from an empty list 🍓
• splitlast($path) — get a component from $path (using chop) and return the remaining path and the compenent, as strings. [Not used] — she's just sitting there, vibing, unused. we still list her though 💜

---

🧚 EXPORT 🧚

None — all subs are methods for File::Spec::Link. no exports, we're classy like that 💅

---

🌈 SEE ALSO 🌈

File::Spec(3) File::Copy::Link(3)

---

🫶 AUTHOR 🫶

Robin Barker, <RMBarker@cpan.org>

---

⭐ COPYRIGHT AND LICENSE ⭐

Copyright 2003, 2005, 2006, 2007, 2011, 2014, 2024 by Robin Barker

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

---

okay that's the whole page, no notes, you ate 💖

and that's a wrap on File::Spec::Link(3pm) — brought to you by perl v5.40.0, dated 2025-02-07. go resolve some links, bestie, you got this 👑✨