App::PDFUtils - Command-line utilities related to PDF files
This document describes version 0.007 of App::PDFUtils (from Perl distribution App-PDFUtils), released on 2021-07-17.
This distribution provides tha following command-line utilities related to PDF files:
add-pdf-password
grep-from-pdf
pdfgrep
remove-pdf-password
Usage:
add_pdf_password(%args) -> [$status_code, $reason, $payload, \%result_meta]
Password-protect PDF files.
This program is a wrapper for qpdf to password-protect PDF files (in-place). This is the counterpart for remove-pdf-password.
This function is not exported.
Arguments ('*' denotes required arguments):
backup => bool (default: 1)
Whether to backup the original file to ORIG~.
files* => array[filename]
password* => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
convert_pdf_to_text(%args) -> [$status_code, $reason, $payload, \%result_meta]
Convert PDF file to text.
This utility uses one of the following backends:
pdftotext
file* => filename
Input file.
fmt => bool
Run Unix fmt over the txt output.
output => filename
Output path.
overwrite => bool
pages => uint_range
Only convert a range of pages.
return_output_file => bool
Return the path of output file instead.
This is useful when you do not specify an output file but do not want to show the converted document to stdout, but instead want to get the path to a temporary output file.
remove_pdf_password(%args) -> [$status_code, $reason, $payload, \%result_meta]
Remove password from PDF files.
This program is a wrapper for qpdf to remove passwords from PDF files (in-place).
The motivation for this program is the increasing occurence of financial institutions sending financial statements or documents in the format of password-protected PDF file. This is annoying when we want to archive the file or use it in an organization because we have to remember different passwords for different financial institutions and re-enter the password everytime we want to use the file. (The banks could've sent the PDF in a password-protected .zip, or use PGP-encrypted email, but I digress.)
You can provide the passwords to be tried in a configuration file, ~/remove-pdf-password.conf, e.g.:
~/remove-pdf-password.conf
passwords = pass1 passwords = pass2 passwords = pass3
or:
passwords = ["pass1", "pass2", "pass3"]
passwords => array[str]
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.
diff-pdf-text from App::DiffPDFText.
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.