/ 
App-IODUtils-0.164
River stage one • 1 direct dependent • 1 total dependent
/ map-iod

NAME

map-iod - Modify IOD section/key/value with Perl code

VERSION

This document describes version 0.164 of map-iod (from Perl distribution App-IODUtils), released on 2024-06-24.

SYNOPSIS

Examples:

# make section names uppercase
% map-iod --section '$_ = uc' /path/to/file.iod

# prepend key name with section name
% map-iod --key '$_ = "$SECTION.$_"' /path/to/file.iod

# prepend value with section and key name
% map-iod --value '$_ = "$SECTION.$KEY.$_"' /path/to/file.iod

OPTIONS

* marks required options.

Main options

--key=s

(No description)

--section=s

(No description)

--value=s

(No description)

Output options

--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.

Parser options

--allow-directive=s@

(No description)

Can be specified multiple times.

--allow-directives-json=s

See --allow-directive.

--allow-encoding=s@

(No description)

Can be specified multiple times.

--allow-encodings-json=s

See --allow-encoding.

--default-section=s

Default value:

"GLOBAL"
--disable-brace

(No description)

--disable-bracket

(No description)

--disable-directive

(No description)

--disable-encoding

(No description)

--disable-quoting

(No description)

--disallow-bang-only

(No description)

--disallow-directive=s@

(No description)

Can be specified multiple times.

--disallow-directives-json=s

See --disallow-directive.

--disallow-duplicate-key

(No description)

--disallow-encoding=s@

(No description)

Can be specified multiple times.

--disallow-encodings-json=s

See --disallow-encoding.

--enable-expr, -e

(No description)

--expr-var=s%

(No description)

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

--expr-vars-json=s

See --expr-var.

--ignore-unknown-directive

(No description)

--warn-perl

(No description)

Other options

--help, -h, -?

Display help message and exit.

--iod=s*

IOD file.

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

--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 map-iod map-iod

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 map-iod 'p/*/`map-iod`/'

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-IODUtils.

SOURCE

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

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, 2022, 2019, 2017, 2016, 2015, 2014 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-IODUtils

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.