/ 
App-PDFUtils-0.005
River stage one • 2 direct dependents • 2 total dependents
/ pdfgrep

NAME

pdfgrep - Print lines matching text in PDF files

VERSION

This document describes version 0.005 of pdfgrep (from Perl distribution App-PDFUtils), released on 2021-07-06.

SYNOPSIS

Usage:

% pdfgrep [--all] [-c] [--color=s] [--count] [--dash-prefix-inverts]
    [--debug] [-e=s+] [--file=s+] [--files-json=s] [--format=name] [-i]
    [--ignore-case] [--invert-match] [--json] [--line-number]
    [--log-level=level] [-n] [--(no)naked-res] [--no-dash-prefix-inverts]
    [--no-ignore-case] [--no-invert-match] [--nodash-prefix-inverts]
    [--noignore-case] [--noinvert-match] [--page-result[=program]] [-q]
    [--quiet] [--quiet-arg] [--regexp=s+] [--regexps-json=s] [--silent]
    [--trace] [-v] [--verbose] [--view-result[=program]] -- [pattern]
    [file] ...

DESCRIPTION

This is a wrapper for pdftotext + grep-like utility that is based on AppBase::Grep. The unique features include multiple patterns and --dash-prefix-inverts.

OPTIONS

* marks required options.

Main options

--file=s@

If not specified, will search for all PDF files recursively from the current directory.

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

Can be specified multiple times.

--files-json=s

See --file.

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

--pattern=s

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

--regexp=s@

Can be specified multiple times.

--regexps-json=s

See --regexp.

-e=s@

Alias for --regexp.

See --regexp.

Can be specified multiple times.

General output control options

--color=s

Default value:

"auto"

Valid values:

["never","always","auto"]
--count, -c

Supress normal output, return a count of matching lines.

--quiet-arg, --silent, -q

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.

Matching control options

--all

Require all patterns to match, instead of just one.

--dash-prefix-inverts

When given pattern that starts with dash "-FOO", make it to mean "^(?!.*FOO)".

This is a convenient way to search for lines that do not match a pattern. Instead of using `-v` to invert the meaning of all patterns, this option allows you to invert individual pattern using the dash prefix, which is also used by Google search and a few other search engines.

--ignore-case, -i
--invert-match, -v

Invert the sense of matching.

Output line prefix control options

--line-number, -n

Output options

--format=s

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

Default value:

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

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

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

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

SOURCE

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

BUGS

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

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, 2020, 2017 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.