NAME

perlmv-u - Rename files using Perl code, with undo/redo

VERSION

This document describes version 0.004 of perlmv-u (from Perl distribution App-perlmv-u), released on 2017-08-17.

SYNOPSIS

 # rename some files, but in simulation mode, not really rename the files
 % perlmv-u --dry-run -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt
 % perlmv-u -n        -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt

 # rename some files, for real
 % perlmv-u           -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt

 # oops, made a mistake. undo last action.
 % perlmv-u --undo

 # redo last action
 % permv-u --redo

 # show history
 % perlmv-u --history

 # forget history; past actions can no longer be undone/redone
 % perlmv-u --clear-history

DESCRIPTION

EARLY RELEASE, EXPERIMENTAL.

This utility is a reimplementation of perlmv with undo feature. Currently unimplemented: scriptlets, mv/cp/symlink/link mode, test compile (-c), --parents, etc.

SUBCOMMANDS

clear_history

Clear undo history.

history

Show undo history.

mv

Rename files using Perl code, with undo/redo.

redo

Redo last undone action.

undo

Undo last action.

OPTIONS

* marks required options.

Common options

--clear-history

Shortcut for --cmd=clear_history.

--cmd=s

Select subcommand.

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--dry-run, -n

Run in simulation mode (also via DRY_RUN=1).

--format=s

Choose output format, e.g. json, text.

Default value:

 undef

--help, -h, -?

Display help message and exit.

--history

Shortcut for --cmd=history.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--quiet

Shortcut for --log-level=error.

--redo

Shortcut for --cmd=redo.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--undo

Shortcut for --cmd=undo.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

Options for subcommand mv

--eval=s*, -e

Perl code to rename file.

Your Perl code will receive the original filename in `$_` and is expected to modify it. If it is unmodified, the last expression is used as the new filename. If it is also the same as the original filename, the file is not renamed.

--file=s@*

Can be specified multiple times.

--files-json=s

See --file.

-d

Alias for --dry-run.

Options for subcommand undo

--ignore-errors

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C perlmv-u perlmv-u

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete perlmv-u 'p/*/`perlmv-u`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/perlmv-u.conf, ~/perlmv-u.conf, or /etc/perlmv-u.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)

Configuration for subcommand clear_history

Configuration for subcommand history

Configuration for subcommand mv

 d (see -d)
 eval (see --eval)
 files (see --file)

Configuration for subcommand redo

Configuration for subcommand undo

 ignore_errors (see --ignore-errors)

ENVIRONMENT

PERLMV_U_OPT => str

Specify additional command-line options.

FILES

~/.config/perlmv-u.conf

~/perlmv-u.conf

/etc/perlmv-u.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-perlmv-u.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-perlmv-u.

BUGS

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

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.

SEE ALSO

perlmv from App::perlmv

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by 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.

cpanm App::perlmv::u

perl -MCPAN -e shell
install App::perlmv::u