/ 
App-ImageMagickUtils-0.023
River stage one • 1 direct dependent • 1 total dependent
/ image-resize-notation-to-human

NAME

image-resize-notation-to-human - Translate ImageMagick-like resize notation (e.g. "720^>") to human-friendly text (e.g. "shrink shortest side to 720px")

VERSION

This document describes version 0.023 of image-resize-notation-to-human (from Perl distribution App-ImageMagickUtils), released on 2024-08-29.

SYNOPSIS

image-resize-notation-to-human --help (or -h, -?)

image-resize-notation-to-human --version (or -v)

image-resize-notation-to-human [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] -- <resize>

See examples in the "EXAMPLES" section.

DESCRIPTION

Resize notation supports most syntax from ImageMagick geometry. See Math::Image::CalcResized and ImageMagick documentation on geometry for more details.

OPTIONS

* marks required options.

Main options

--resize=s*

(No description)

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

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--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]
--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

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 image-resize-notation-to-human image-resize-notation-to-human

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 image-resize-notation-to-human 'p/*/`image-resize-notation-to-human`/'

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.

EXAMPLES

Example #1

% image-resize-notation-to-human ''
no resizing

Example #2

% image-resize-notation-to-human 50%
scale to 50%

Example #3

% image-resize-notation-to-human 50%x50%
scale width to 50%, height to 50%

Example #4

% image-resize-notation-to-human 720
set width to 720px

Example #5

% image-resize-notation-to-human '720>'
shrink width to 720px

Example #6

% image-resize-notation-to-human 720^
enlarge width to 720px

Example #7

% image-resize-notation-to-human x720
set height to 720px

Example #8

% image-resize-notation-to-human 'x720>'
shrink height to 720px

Example #9

% image-resize-notation-to-human x720^
enlarge height to 720px

Example #10

% image-resize-notation-to-human 640x480
fit image inside 640x480

Example #11

% image-resize-notation-to-human 640x480^
fit image to fit 640x480 inside it

Example #12

% image-resize-notation-to-human '640x480>'
shrink image to fit inside 640x480

Example #13

% image-resize-notation-to-human '640x480<'
enlarge image to fit 640x480 inside it

Example #14

% image-resize-notation-to-human 640x480!
set dimension to 640x480

Example #15

% image-resize-notation-to-human '720^>'
shrink shortest side to 720px

Example #16

% image-resize-notation-to-human '720^<'
enlarge shortest side to 720px

Example #17

% image-resize-notation-to-human '^720>'
shrink longest side to 720px

Example #18

% image-resize-notation-to-human '^720<'
enlarge longest side to 720px

HOMEPAGE

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

SOURCE

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

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, 2023, 2022, 2021, 2020 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-ImageMagickUtils

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.