NAME

File::Util::Rename - Utilities related to renaming files

VERSION

This document describes version 0.001 of File::Util::Rename (from Perl distribution File-Util-Rename), released on 2024-01-22.

SYNOPSIS

 use File::Util::Symlink qw(
     rename_noclobber
 );

 rename_noclobber "foo.txt", "bar.txt"; # will rename to "bar (01).txt" etc if "bar.txt" exists

DESCRIPTION

rename_noclobber

Usage:

 rename_noclobber( [ \%opts , ] $from, $to );

Known options:

  • pattern

    Str. Defaults to " (%02d)".

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/File-Util-Rename.

SOURCE

Source repository is at https://github.com/perlancar/perl-File-Util-Rename.

SEE ALSO

File::Copy::NoClobber

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Util-Rename

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.