grep-from-pdf - Print lines matching text in PDF files
This document describes version 0.007 of grep-from-pdf (from Perl distribution App-PDFUtils), released on 2021-07-17.
Usage:
% grep-from-pdf [--all] [--color=str] [--count|-c] [--dash-prefix-inverts|--no-dash-prefix-inverts|--nodash-prefix-inverts] [--debug|--log-level=level|--quiet|--trace|--verbose] [(--file=filename)+] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--invert-match|-v|--no-invert-match|--noinvert-match] [--line-number|-n] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--quiet-arg] [(--regexp=str)+] [--files-json=json] [--regexps-json=json|(-e=str)+] [-q|--silent] -- [pattern] [file] ...
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.
--dash-prefix-inverts
* marks required options.
*
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.
See --file.
--file
Can also be specified as the 1st command-line argument.
See --regexp.
--regexp
Alias for --regexp.
Default value:
"auto"
Valid values:
["never","always","auto"]
Supress normal output, return a count of matching lines.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Require all patterns to match, instead of just one.
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.
Invert the sense of matching.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C grep-from-pdf grep-from-pdf
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.
To activate tcsh completion for this script, put:
complete grep-from-pdf 'p/*/`grep-from-pdf`/'
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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-PDFUtils.
Source repository is at https://github.com/perlancar/perl-App-PDFUtils.
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.
perlancar <perlancar@cpan.org>
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.
To install App::PDFUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PDFUtils
CPAN shell
perl -MCPAN -e shell install App::PDFUtils
For more information on module installation, please visit the detailed CPAN module installation guide.