NAME

grep-ini - Filter INI using pattern against section/key/value

VERSION

This document describes version 0.035 of grep-ini (from Perl distribution App-INIUtils), released on 2024-06-24.

SYNOPSIS

Examples:

# only show sections with 'foo' in their name
% grep-ini --section foo /path/to/file.ini

# do not (-v) show sections with 'foo' in their name, do case-insensitive matching (-i)
% grep-ini --section foo -iv /path/to/file.ini

# only show keys with 'foo' in their name
% grep-ini --key foo /path/to/file.ini

# only show values with 'foo' in their name
% grep-ini --value foo /path/to/file.ini

OPTIONS

* marks required options.

Main options

--ignore-case, -i

(No description)

--invert-match, -v

(No description)

--invert-match-key

(No description)

--invert-match-section

(No description)

--invert-match-value

(No description)

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

--default-section=s

Default value:

"GLOBAL"

--disallow-duplicate-key

(No description)

Other options

--help, -h, -?

Display help message and exit.

--ini=s*

INI file.

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

-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 grep-ini grep-ini

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 grep-ini 'p/*/`grep-ini`/'

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

SOURCE

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

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, 2019, 2015 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-INIUtils

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.

cpanm App::INIUtils

perl -MCPAN -e shell
install App::INIUtils