NAME

grep-terms - Print lines that match terms

VERSION

This document describes version 0.005 of grep-terms (from Perl distribution App-GrepUtils), released on 2021-11-14.

SYNOPSIS

 % grep-terms [GREP-TERM-OPTIONS]... <TERMS> [GREP-OPTIONS | FILES]...
 % grep-terms --help
 % grep-terms --version|-V

Example:

  % grep-terms "foo bar baz -qux -quux" -i file.txt

will print lines from file.txt that contain "foo", "bar", "baz" (in no particular order) and do not contain "qux" or "quux".

DESCRIPTION

grep-terms is a simple wrapper for Unix command grep. It converts terms (the first argument) like this:

 "foo bar baz -qux -quux"

to:

 -P -e '^(?=.*foo)(?=.*bar)(?=.*baz)(?!.*qux)(?!.*quux)'

It allows searching each term in terms in no particular order and negative search (using the dash prefix syntax). The drawback is that the pattern does not capture anything and thus does not highlight anything. To highlight terms, specify the "<--highlight-terms" option which will add a second grep invocation to do highlighting.

EXIT CODES

0 on success.

255 on I/O error.

99 on command-line options error.

OPTIONS

The following options are grep-terms' own option. All other unknown options will be passed to grep.

--highlight-terms

If set, will apply a second grep to highlight the terms, so:

 % grep "foo bar baz -qux -quux" FILE1 FILE2

will become:

 % grep -P -e '^(?=.*foo)(?=.*bar)(?=.*baz)(?!.*qux)(?!.*quux)' | grep --color=always -P 'foo|bar|baz'

FAQ

HOMEPAGE

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

SOURCE

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

SEE ALSO

abgrep (from App::abgrep)

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 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-GrepUtils

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.