qpdf

https://qpdf.readthedocs.io/en/stable
Admin
qpdf is a command-line tool and C++ library that performs content-preserving transformations on PDF...
Tokens:66,562
Snippets:1,128
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Development Files with Static Libraries

Source: https://qpdf.readthedocs.io/en/stable/_sources/installation.rst.txt

Configure, build, and install only the development files and static libraries.

```bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_SHARED_LIBS=OFF
cmake --build build --parallel --target libqpdf
cmake --install build --component dev
```

--------------------------------

### Install Development Files with Shared and Static Libraries

Source: https://qpdf.readthedocs.io/en/stable/_sources/installation.rst.txt

Configure, build, and install both shared and static library components.

```bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build --parallel --target libqpdf libqpdf_static
cmake --install build --component lib
cmake --install build --component dev
```

--------------------------------

### Example command-line argument structure

Source: https://qpdf.readthedocs.io/en/stable/_sources/cli.rst.txt

A practical example demonstrating the use of input files, flags, parameters, and output files.

```text
qpdf in.pdf --object-stream=generalized out.pdf
```

--------------------------------

### Page Selection Examples

Source: https://qpdf.readthedocs.io/en/stable/_sources/cli.rst.txt

Practical examples of merging pages from multiple files into a single output PDF.

```bash
qpdf in.pdf --pages . a.pdf b.pdf 1-z:even -- out.pdf
```

```bash
qpdf --empty --pages a.pdf b.pdf --password=x z-1 c.pdf 3,6
```

--------------------------------

### Install Development Files with Shared Libraries

Source: https://qpdf.readthedocs.io/en/stable/_sources/installation.rst.txt

Configure, build, and install development files along with the required runtime shared libraries.

```bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_STATIC_LIBS=OFF
cmake --build build --parallel --target libqpdf
cmake --install build --component lib
cmake --install build --component dev
```

--------------------------------

### Configure QPDF via Job JSON

Source: https://qpdf.readthedocs.io/en/stable/_sources/qpdf-job.rst.txt

Example of a JSON configuration file representing the same operations as the CLI example.

```json
{
  "inputFile": "infile.pdf",
  "outputFile": "outfile.pdf",
  "pages": [
    {
      "file": "."
    },
    {
      "file": "other.pdf",
      "password": "x",
      "range": "1-5"
    }
  ],
  "encrypt": {
    "userPassword": "user",
    "ownerPassword": "owner",
    "256bit": {
      "print": "low"
    }
  },
  "objectStreams": "generate"
}
```

--------------------------------

### Page Labeling Examples

Source: https://qpdf.readthedocs.io/en/stable/_sources/cli.rst.txt

Examples of page labeling schemes for a 50-page document.

```text
1:a 5:D
```

```text
1:r 5:D 12: 14:D/10 r5:D//A- z:"end note"
```

--------------------------------

### Execute QPDF via CLI

Source: https://qpdf.readthedocs.io/en/stable/_sources/qpdf-job.rst.txt

Example of running QPDF operations using command-line arguments.

```text
qpdf infile.pdf outfile.pdf \
   --pages . other.pdf --password=x 1-5 -- \
   --encrypt user owner 256 --print=low -- \
   --object-streams=generate
```

--------------------------------

### Partial Job JSON Configuration

Source: https://qpdf.readthedocs.io/en/stable/_sources/qpdf-job.rst.txt

Example of a partial JSON configuration file that can be combined with command-line options.

```json
{
  "encrypt": {
    "userPassword": "",
    "ownerPassword": "owner",
    "256bit": {
    }
  },
  "objectStreams": "generate"
}
```

--------------------------------

### CLI Command with Job JSON File

Source: https://qpdf.readthedocs.io/en/stable/qpdf-job.html

Example of running qpdf while referencing an external JSON configuration file.

```bash
qpdf infile.pdf outfile.pdf --job-json-file=my-options.json
```

--------------------------------

### Configure QPDF with GnuTLS only

Source: https://qpdf.readthedocs.io/en/stable/installation.html

Example command to build QPDF using only the GnuTLS crypto provider by disabling implicit selection and explicitly requiring GnuTLS.

```bash
cmake -DUSE_IMPLICIT_CRYPTO=0 -DREQUIRE_CRYPTO_GNUTLS=1
```

--------------------------------

### Configure CMake for qpdf

Source: https://qpdf.readthedocs.io/en/stable/library.html

Example CMakeLists.txt for linking a C++ application against the qpdf library.

```cmake
cmake_minimum_required(VERSION 3.16)
project(some-application LANGUAGES CXX)
find_package(qpdf)
add_executable(some-application some-application.cc)
target_link_libraries(some-application qpdf::libqpdf)
```

--------------------------------

### Configure QPDF via C++ API

Source: https://qpdf.readthedocs.io/en/stable/_sources/qpdf-job.rst.txt

Example of using the QPDFJob C++ class to perform operations, including error handling with QPDFUsage.

```cpp
#include <qpdf/QPDFJob.hh>
#include <qpdf/QPDFUsage.hh>
#include <iostream>

int main(int argc, char* argv[])
{
    try
    {
        QPDFJob j;
        j.config()
            ->inputFile("infile.pdf")
            ->outputFile("outfile.pdf")
            ->pages()
            ->pageSpec(".", "1-z")
            ->pageSpec("other.pdf", "1-5", "x")
            ->endPages()
            ->encrypt(256, "user", "owner")
            ->print("low")
            ->endEncrypt()
            ->objectStreams("generate")
            ->checkConfiguration();
        j.run();
    }
    catch (QPDFUsage& e)
    {
        std::cerr << "configuration error: " << e.what() << std::endl;
        return 2;
    }
    catch (std::exception& e)
    {
        std::cerr << "other error: " << e.what() << std::endl;
        return 2;
    }
    return 0;
}
```

--------------------------------

### --pages

Source: https://qpdf.readthedocs.io/en/stable/_sources/cli.rst.txt

Starts page selection options for splitting, merging, and collating files.

```APIDOC
## --pages

### Description
Starts page selection options, which are used to select pages from one or more input files to perform operations such as splitting, merging, and collating files.

### Parameters
- **--file=file** (string) - Optional - Specify the file for the current page operation.
- **--range=numeric-range** (string) - Optional - Specify the page range for the current page operation.
```

--------------------------------

### Update PointerHolder Construction

Source: https://qpdf.readthedocs.io/en/stable/design.html

Examples of updating implicit PointerHolder construction to explicit forms.

```cpp
PointerHolder<X> x = new X();
```

```cpp
auto x = PointerHolder<X>(new X(...)); // all versions of qpdf
// or, if X(...) is public:
auto x = make_pointer_holder<X>(...); // only 10.6 and above
```

--------------------------------

### Overlay and Underlay Syntax

Source: https://qpdf.readthedocs.io/en/stable/cli.html

General syntax for applying overlay or underlay operations in the qpdf CLI.

```bash
{--overlay|--underlay} [--file=]file [options] --
```

--------------------------------

### Basic CMake Build Invocation

Source: https://qpdf.readthedocs.io/en/stable/_sources/installation.rst.txt

Standard commands to configure and build the qpdf project.

```bash
cmake -S . -B build
cmake --build build
```

--------------------------------

### Command Line Argument Handling

Source: https://qpdf.readthedocs.io/en/stable/_sources/cli.rst.txt

QPDF supports reading arguments from files or standard input using @filename or @- syntax.

```APIDOC
## Command Line Argument Files

### Description
If @filename appears as a word in the command line, QPDF reads the file line by line and treats each line as a command-line argument. The @- option allows reading arguments from standard input.

### Usage
- @filename: Read arguments from the specified file.
- @-: Read arguments from standard input.
```

--------------------------------

### Basic qpdf command usage

Source: https://qpdf.readthedocs.io/en/stable/cli.html

The standard syntax for invoking the qpdf utility.

```text
Usage: qpdf [infile] [options] [outfile]
```

--------------------------------

### qpdf JSON Example

Source: https://qpdf.readthedocs.io/en/stable/_sources/json.rst.txt

This JSON represents a simple PDF file's structure as output by qpdf. It includes metadata, object definitions, and stream data.

```json
{
  "qpdf": [
    {
      "jsonversion": 2,
      "pdfversion": "1.3",
      "pushedinheritedpageresources": false,
      "calledgetallpages": false,
      "maxobjectid": 6
    },
    {
      "obj:1 0 R": {
        "value": {
          "/Pages": "3 0 R",
          "/Type": "/Catalog"
        }
      },
      "obj:2 0 R": {
        "value": {
          "/Author": "u:Digits of π",
          "/CreationDate": "u:D:20220731155308-05'00'",
          "/Creator": "u:A person typing in Emacs",
          "/Keywords": "u:potato, example",
          "/ModDate": "u:D:20220731155308-05'00'",
          "/Producer": "u:qpdf",
          "/Subject": "u:Example",
          "/Title": "u:Something potato-related"
        }
      },
      "obj:3 0 R": {
        "value": {
          "/Count": 1,
          "/Kids": [
            "4 0 R"
          ],
          "/Type": "/Pages"
        }
      },
      "obj:4 0 R": {
        "value": {
          "/Contents": "5 0 R",
          "/MediaBox": [
            0,
            0,
            612,
            792
          ],
          "/Parent": "3 0 R",
          "/Resources": {
            "/Font": {
              "/F1": "6 0 R"
            }
          },
          "/Type": "/Page"
        }
      },
      "obj:5 0 R": {
        "stream": {
          "data": "eJxzCuFSUNB3M1QwMlEISQOyzY2AyEAhJAXI1gjIL0ksyddUCMnicg3hAgDLAQnI",
          "dict": {
            "/Filter": "/FlateDecode"
          }
        }
      },
      "obj:6 0 R": {
        "value": {
          "/BaseFont": "/Helvetica",
          "/Encoding": "/WinAnsiEncoding",
          "/Subtype": "/Type1",
          "/Type": "/Font"
        }
      },
      "trailer": {
        "value": {
          "/ID": [
            "b:98b5a26966fba4d3a769b715b2558da6",
            "b:6bea23330e0b9ff0ddb47b6757fb002e"
          ],
          "/Info": "2 0 R",
          "/Root": "1 0 R",
          "/Size": 7
        }
      }
    }
  ]
}
```
Tokens:
Raw