#!perl
use 5.032; # use strict; use warnings;
use File::Rename; # REQUIRE_ORDER
main() unless caller;
sub main {
my $options = File::Rename::Options::GetOptions()
or pod2usage;
pod2usage( -verbose => 0,
-exitval => 'NOEXIT',
-message => <<'MESSAGE',
-u|--unicode argument does not look like an encoding:
either give an encoding or put -e as next option
MESSAGE
) if File::Rename::Options::bad_encoding($options);
mod_version() if $options->{show_version};
pod2usage( -verbose => 2 ) if $options->{show_manual};
pod2usage( -exitval => 1 ) if $options->{show_help};
@ARGV = map {glob} @ARGV if $^O =~ m{Win}msx;
File::Rename::rename(\@ARGV, $options);
}
sub mod_version {
print __FILE__;
my $version = File::Rename->VERSION;
my $opt_ver = File::Rename::Options->VERSION;
print ' using File::Rename version '. $version;
if( (eval $opt_ver) < (eval $version) ) {
$opt_ver .= '.00' unless $opt_ver =~ m{\.};
print ', File::Rename::Options version '. $opt_ver;
}
# ignore File::Rename->VERSION
print "\n\n";
exit 0
}
1;
__END__
=head1 NAME
rename - renames multiple files
=head1 SYNOPSIS
B<rename>
S<[ B<-h>|B<-m>|B<-V> ]>
S<[ B<-v> ]>
S<[ B<-0> ]>
S<[ B<-n> ]>
S<[ B<-f> ]>
S<[ B<-d> ]>
S<[ B<-u> [I<enc>]]>
S<[ B<-e>|B<-E> I<perlexpr>]*|I<perlexpr>>
S<[ I<files> ]>
=head1 DESCRIPTION
C<rename>
renames the filenames supplied according to the rule specified as the
first argument.
The I<perlexpr>
argument is a Perl expression which is expected to modify the C<$_>
string in Perl for at least some of the filenames specified.
If a given filename is not modified by the expression, it will not be
renamed.
If no filenames are given on the command line, filenames will be read
via standard input.
=head2 Examples (Larry Wall, 1992)
For example, to rename all files matching C<*.bak> to strip the extension,
you might say
rename -- 's/\.bak$//' *.bak
To translate uppercase names to lower, you'd use
rename 'y/A-Z/a-z/' ./*
Examples rewritten to avoid globs which could inject options.
=head2 More examples (2020)
You can also use rename to move files between directories, possibly at
the same time as making other changes (but see B<--filename>)
rename 'y/A-Z/a-z/;s/^/my_new_dir\//' ./*.*
You can also write the statements separately (see B<-e>/B<-E>)
rename -E 'y/A-Z/a-z/' -E 's/^/my_new_dir\//' -- *.*
You can use the predefined variables C<$a, $b> in the code;
for instance to create sequences of numbers
rename -e '$a++;s/\w+/file_$a/' -- *.*
=head1 OPTIONS
=over 8
=item B<-v>, B<--verbose>
Verbose: print names of files successfully renamed.
=item B<-0>, B<--null>
Use \0 as record separator when reading from STDIN.
=item B<-n>, B<--nono>
No action: print names of files to be renamed, but don't rename.
=item B<-f>, B<--force>
Over write: allow existing files to be over-written.
=item B<--path>, B<--fullpath>
Rename full path: including any directory component. DEFAULT
=item B<-d>, B<--filename>, B<--nopath>, B<--nofullpath>
Do not rename directory: only rename filename component of path.
=item B<-h>, B<--help>
Help: print SYNOPSIS and OPTIONS.
=item B<-m>, B<--man>
Manual: print manual page.
=item B<-V>, B<--version>
Version: show version number.
=item B<-u>, B<--unicode> [I<encoding>]
Treat filenames as perl (unicode) strings when
running the user-supplied code.
Decode/encode filenames using I<encoding>, if
present.
I<encoding> is optional: if omitted, the next argument
should be an option starting with '-', for instance B<-e>.
=item B<-e>
Expression: code to act on files name.
May be repeated to build up code (like C<perl -e>).
If no B<-e>, the first argument is used as code.
=item B<-E>
Statement: code to act on files name, as B<-e> but terminated by ';'.
=back
=head1 ENVIRONMENT
No environment variables are used.
=head1 AUTHOR
Larry Wall
=head1 SEE ALSO
mv(1), perl(1)
=head1 DIAGNOSTICS
If you give an invalid Perl expression you'll get a syntax error.
=head1 BUGS
The original
C<rename>
did not check for the existence of target filenames,
so had to be used with care.
=cut