NAME

diff-pdf-text - Diff the text of two PDF documents

VERSION

This document describes version 0.006 of diff-pdf-text (from Perl distribution App-DiffPDFText), released on 2023-08-09.

SYNOPSIS

Use like you would use the Unix command diff:

% diff-pdf-text [options] <FILE>...

DESCRIPTION

This is a wrapper for the Unix command diff. It assumes that each input file is a PDF file and tries to convert the file to text first using App::PDFUtils (which in turn uses pdftotext CLI utility). It then passes the converted text diff -ruN command.

OPTIONS

These are options that are interpreted by diff-pdf-text and not passed to diff.

Please specify these options before file names.

  • --pdf-pages

    Only diff a range of pages instead of the whole PDF. Example: 1,5-10,15. Requires pdftk to extract the page range.

  • --(no-)pdf-fmt

    Whether to apply `fmt` formatting to the `pdftotext` output. The default is yes; use --no-pdf-fmt to disable it.

  • --pager

    Run the output through pager. Currently this option uses less and also forces color output. The main use is to see colored diff with a pager.

ENVIRONMENT

DEBUG

If set to true, do not cleanup temporary directories.

DIFF_CMD

String. Can be used to set path to diff command. See also "DIFF_PDF_TEXT_DIFF_CMD" which takes precedence.

DIFF_PDF_TEXT_DIFF_CMD

String. Can be used to set path to diff command. The defaultl is diffwc if available in PATH, or diff. Takes precedence over "DIFF_CMD".

HOMEPAGE

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

SOURCE

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

SEE ALSO

Unix command diff.

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) 2023, 2022 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-DiffPDFText

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.