NAME

diff-two-module-version-hash - diff-two-module-version-hash

VERSION

This document describes version 0.003 of diff-two-module-version-hash (from Perl distribution App-ModuleVersionDiffUtils), released on 2021-05-25.

SYNOPSIS

Usage:

 % diff-two-module-version-hash [-I=s+] [--debug] [--include-dir-json=s]
     [--include-dir=s+] [--log-level=level] [--page-result[=program]]
     [--quiet] [--trace] [--verbose] [--view-result[=program]] <module>
     <hash_name>

Examples:

Diff %hash between two versions of Foo::Bar:

 % diff-two-module-version-hash Foo::Bar %hash

Diff $hashref between two versions of Foo::Bar:

 % diff-two-module-version-hash Foo::Bar '$hashref'

OPTIONS

* marks required options.

Main options

--hash-name=s*

Hash name to be found in module namespace, with sigil.

Can also be specified as the 2nd command-line argument.

--include-dir-json=s, -I

See --include-dir.

--include-dir=s@

Can be specified multiple times.

--module=s*

Module will be searched in the `@INC` (you can specify `-I` to add more directories to search). There needs to be at least two locations of the module. Otherwise, the application will croak.

Can also be specified as the 1st command-line argument.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

 complete -C diff-two-module-version-hash diff-two-module-version-hash

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 diff-two-module-version-hash 'p/*/`diff-two-module-version-hash`/'

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.

HOMEPAGE

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

SOURCE

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

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2018 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::ModuleVersionDiffUtils

perl -MCPAN -e shell
install App::ModuleVersionDiffUtils