From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

PERLANCAR / App-FileRenameUtils-0.014 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

              
NAME
    App::FileRenameUtils - Utilities related to renaming/moving files
VERSION
    This document describes version 0.014 of App::FileRenameUtils (from Perl
    distribution App-FileRenameUtils), released on 2023-11-20.
DESCRIPTION
    This distribution provides the following command-line utilities:
    1. datestamp
    2. move-files-here
    3. mv-add-prefix
    4. mv-add-prefix-datestamp
    5. mv-add-prefix-number
    6. mv-files-to-dirs
    7. mv-reverse
    8. mv-swap
    9. mv-to-from
    10. rename-add-prefix
    11. rename-add-prefix-datestamp
    12. rename-add-prefix-number
    13. rename-swap
    14. rename-to-from
FUNCTIONS
  add_filename_suffix
    Usage:
     $new_name = add_filename_suffix($filename, $suffix);
    Examples:
     add_filename_suffix("foo.jpg", " (1)"); # -> "foo (1).jpg"
     add_filename_suffix("foo", " (1)"); # -> "foo (1)"
  find_unique_filename
    Usage:
     $new_name = find_unique_filename($filename);
    Continue adding suffix " (1)", " (2)", and so on to $filename (see
    "add_filename_suffix") until the new name does not exist on the
    filesystem. If $filename already does not exist, it will be returned
    as-is.
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-FileRenameUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-FileRenameUtils>.
SEE ALSO
    rename from File::Rename
    perlmv from App::perlmv, and its various scriptlets under
    "App::perlmv::scriptlet::*", e.g. App::perlmv::scriptlet::add_prefix or
    App::perlmv::scriptlet::according_to_containing_dir.
    renwd from App::renwd
    Other similar distributions: App::FileModifyUtils,
    App::FileRemoveUtilities.
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) 2023, 2020, 2019 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=App-FileRenameUtils>
    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.