File::...Options(3pm)

📦
version 2.02 · 4 versions
, in debian trixie, ubuntu noble, ubuntu questing

💖 File::...Options(3pm) 💖

okay bestie, so this is a User Contributed Perl Documentation page, and it's literally all about File::Rename::Options — the lil module that handles option processing for File::Rename. it's giving "behind the scenes queen" energy fr fr. 👑

✨ NAME ✨

File::Rename::Options — the option processing situation for File::Rename 💅

🌸 SYNOPSIS 🌸

use File::Rename::Options;
my $options = File::Rename::Options::GetOptions()
    or pod2usage;

use File::Rename::Options qw(no_require_order);

🦋 DESCRIPTION 🦋

🎀 CONFIGUATION 🎀

(yes the original spells it like that, no I will not be fixing it, it's iconic 🫶)

so like, the parameters you pass to use File::Rename::Options? those are configuration settings for Getopt::Long. that's the whole vibe.

the default configuration is posix_default and no_ignore_case, and any other settings you throw in just get added onto that list. slay. ✨

💜 FUNCTIONS 💜

  • GetOptions() — calls Getopt::Long::GetOptions() with the options for the rename script, and hands you back a HASH of options. it's giving "here's your stuff, bestie". 🎁
  • bad_encoding($options) — tests whether an encoding does not look like an encoding. vibe check on your encoding, basically. 🔍

👑 OPTIONS 👑

  • peep the rename script for the options themselves (they live in @ARGV) 👀
  • peep File::Rename for the structure of the options HASH 📦

🌈 ENVIRONMENT 🌈

no environment variables are used. zero. none. not a single one. the env is unbothered, moisturized, in its lane. 💆‍♀️

⭐ SEE ALSO ⭐

💖 AUTHOR 💖

Robin Barker <RMBarker@cpan.org> — the legend, the icon, the moment. 👑

🔥 DIAGNOSTICS 🔥

returns undef when there's an error in the options. so like, if you get undef back, that's your sign that something went wrong, bestie. 😭

Copyright (C) 2018, 2022, 2023 by Robin Barker

this library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8 or, at your option, any later version of Perl 5 you may have available. so generous, so giving. 🫶

okay that's the whole page!! this was perl v5.36.0, dated 2024-01-01, and it's the File::...Options(3pm) manpage — ily, go process some options, mwah 💋✨

📦 where this page comes from