File::...Options(3pm)

πŸ“¦
version 2.01 Β· 2 versions
, in debian bookworm

πŸ’– NAME πŸ’–

File::Rename::Options β€” bestie, this is the option-processing era of File::Rename, and it's lowkey carrying the whole squad πŸŽ€


✨ SYNOPSIS ✨

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

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

literally just that. two lines of import and you're in. πŸ¦‹


🌸 DESCRIPTION 🌸

πŸ’… CONFIGUATION πŸ’…

The parameters you hand to use File::Rename::Options are configuration settings for Getopt::Long, periodt.

The default configuration is posix_default and no_ignore_case; any other settings you throw in get added to that list. 🫢

πŸ‘‘ FUNCTIONS πŸ‘‘

  • GetOptions() β€” calls Getopt::Long::GetOptions() with the options for the rename script, and hands you back a HASH of options. the way it just... returns a hash. iconic. πŸ’–
  • bad_encoding($options) β€” vibe-checks whether an encoding does not look like an encoding. 🧚

πŸ”₯ OPTIONS πŸ”₯

  • See the rename script for options (they live in @ARGV). πŸ‘€
  • See File::Rename for the structure of the options HASH. πŸ“

🌈 ENVIRONMENT 🌈

No environment variables are used. not a single one. zero. nada. we keep it clean bestie. πŸ’€


πŸ¦‹ SEE ALSO πŸ¦‹


πŸ’œ AUTHOR πŸ’œ

Robin Barker <RMBarker@cpan.org> β€” the main character who wrote all this πŸŽ€


😭 DIAGNOSTICS 😭

Returns undef when there is an error in the options. so check for that, fr fr.


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.


and that's the whole page, bestie πŸ’–βœ¨ this one came from perl v5.36.0, dated 2023-01-23, and it's part of the User Contributed Perl Documentation collection β€” go forth and process those options, you absolute legend πŸ‘‘πŸ¦‹

πŸ“¦ where this page comes from