File::Rename::Options

Section: User Contributed Perl Documentation (3pm)
Updated: 2023-01-23
Index Return to Main Contents
 

NAME

File::Rename::Options - Option processing 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

The parameters to "use File::Rename::Options" are configurations settings for Getopt::Long

The default configuration is posix_default and no_ignore_case; other settings are added to this list.  

FUNCTIONS

"GetOptions()"
Call "Getopt::Long::GetOptions()" with options for rename script, returning a HASH of options.
"bad_encoding($options)"
Test if encoding does not look like an encoding
 

OPTIONS

See rename script for options (in @ARGV).

See File::Rename for structure of the options HASH  

ENVIRONMENT

No environment variables are used.  

SEE ALSO

File::Rename(3), rename(1)  

AUTHOR

Robin Barker <RMBarker@cpan.org>  

DIAGNOSTICS

Returns "undef" when there is an error in the options.  

COPYRIGHT AND LICENSE

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.


 

Index

NAME
SYNOPSIS
DESCRIPTION
CONFIGUATION
FUNCTIONS
OPTIONS
ENVIRONMENT
SEE ALSO
AUTHOR
DIAGNOSTICS
COPYRIGHT AND LICENSE

This document was created by man2html, using the manual pages.
Time: 09:57:23 GMT, March 29, 2024