File::Rename - Perl extension for renaming multiple files
use File::Rename qw(rename); # hide CORE::rename rename \@ARGV, sub { s/\.pl\z/.pm/ }, 1; use File::Rename; File::Rename::rename \@ARGV, '$_ = lc'; use File::Rename qw(:config no_require_order);
Parameters to use File::Rename consists of functions to be imported and configuration options.
use File::Rename
The only exported function is rename(). The configuation options are preceded by :config, and are passed to File::Rename::Options.
rename()
rename( FILES, CODE [, VERBOSE])
rename FILES using CODE, if FILES is empty read list of files from stdin
rename_files( CODE, VERBOSE, FILES)
rename FILES using CODE
rename_list( CODE, VERBOSE, HANDLE [, FILENAME])
rename a list of file read from HANDLE, using CODE
List of files to be renamed, for rename must be an ARRAY reference
rename
Subroutine to change file names, for rename can be a string, otherwise it is a code reference
Flag for printing names of files successfully renamed, optional for rename
Filehandle to read file names to be renames
Name of file that HANDLE reads from
Either CODE or VERBOSE can be a HASH of options.
If CODE is a HASH, VERBOSE is ignored and CODE is supplied by the _code key.
Other options are
As VERBOSE above, provided by -v.
Input separator \0 when reading file names from stdin.
Print names of files to be renamed, but do not rename (i.e. take no action), provided by -n.
Allow files to be over-written by the renaming, provided by -f.
Only apply renaming to the filename component of the path, provided by -d.
Print help, provided by -h.
Print manual page, provided by -m.
Print version number, provided by -V.
Enable unicode_strings feature, provided by -u.
Encoding for filenames, provided by -u.
No environment variables are used.
mv(1), perl(1), rename(1)
Robin Barker <RMBarker@cpan.org>
Based on code from Larry Wall.
Options -e, -f, -n suggested by more recent code written by Aristotle Pagaltzis.
Errors from the code argument are not trapped.
Copyright (C) 2004, 2005, 2006, 2011, 2018, 2021, 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.4 or, at your option, any later version of Perl 5 you may have available.
To install File::Rename, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::Rename
CPAN shell
perl -MCPAN -e shell install File::Rename
For more information on module installation, please visit the detailed CPAN module installation guide.