Filename::Backup - Check whether filename indicates being a backup file
This document describes version 0.04 of Filename::Backup (from Perl distribution Filename-Backup), released on 2023-12-15.
use Filename::Backup qw(check_backup_filename); my $res = check_backup_filename(filename => "foo.txt~"); if ($res) { printf "Filename indicates a backup, original name: %s\n", $res->{original_filename}; } else { print "Filename does not indicate a backup\n"; }
Usage:
check_backup_filename(%args) -> bool|hash
Check whether filename indicates being a backup file.
Examples:
Example #1:
check_backup_filename(filename => "foo.bar"); # -> 0
Example #2:
check_backup_filename(filename => "foo.bak"); # -> { original_filename => "foo" }
Example #3:
check_backup_filename(filename => "foo.Bak", ignore_case => 0); # -> 0
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
filename* => str
(No description)
ignore_case => bool (default: 1)
Whether to match case-insensitively.
Return value: (bool|hash)
Return false if not detected as backup name. Otherwise return a hash, which may contain these keys: original_filename. In the future there will be extra information returned, e.g. editor name (if filename indicates backup from certain backup program), date (if filename contains date information), and so on.
original_filename
Please visit the project's homepage at https://metacpan.org/release/Filename-Backup.
Source repository is at https://github.com/perlancar/perl-Filename-Backup.
Filename::Archive
Filename::Compressed
perlancar <perlancar@cpan.org>
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.
This software is copyright (c) 2023, 2016, 2015 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Filename-Backup
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.
To install Filename::Backup, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Filename::Backup
CPAN shell
perl -MCPAN -e shell install Filename::Backup
For more information on module installation, please visit the detailed CPAN module installation guide.