| <!DOCTYPE html> |
| <html lang="en"> |
| |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE- 2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="The Apache PDFBox™ library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0."> |
| |
| <title>Apache PDFBox | Command-Line Tools</title> |
| |
| <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> |
| <link href="/css/prism.css" rel="stylesheet"> |
| <link href="/css/styles.css" rel="stylesheet"> |
| |
| |
| |
| |
| |
| |
| |
| </head> |
| |
| |
| <body> |
| |
| <header class="main-header"> |
| <div class="main-header-logo"> |
| <a href="/" aria-label="Navigation to the PDFBox home page"> |
| <svg focusable="false" class="pdfbox-brand-toolbox" viewBox="0 0 744.09448819 1052.3622047" xmlns="http://www.w3.org/2000/svg" aria-labelledby="brandImageTitle brandImageDesc" role="img"> |
| <title id="brandImageTitle">PDFBox Brand Logo</title> |
| <desc id="brandImageDesc">The PDFBox logo showing a toolbox.</desc> |
| <g transform="matrix(1.25 0 0 -1.25 -317.14 1018.08)" clip-path="url(#clipPath3375)"> |
| <path d="M821.924 376.535L463.24 122.525l-203.83 76.86c23.89 6.02 46.87 15.197 68.335 27.29 60.063 33.835 105.686 88.46 128.282 153.59 2.634 4.66 8.11 6.92 13.265 5.47 4.667-1.31 8.01-5.41 8.353-10.247l-3.572-188.12 334.99 193.957c2.41 1 5.113 1.028 7.54.075 2.315-.907 4.21-2.64 5.32-4.865zm-1.307 97.91l.13-78.324c-.87-2.72-3.342-4.61-6.197-4.75-3.104-.14-5.924 1.8-6.893 4.75l1.29 79.54c.386 2.92 2.893 5.09 5.835 5.04 3.37-.04 6.022-2.89 5.835-6.25z"/> |
| <path d="M751.88 651.666c-.237.002-.48-.022-.723-.077l-363.512-25.15c-10.37-.73-19.583-6.76-24.588-15.87-6.943-12.64-4.677-28.26 5.864-37.72 2.85-2.56 6.22-4.49 8.97-7.16 2.19-2.12 3.93-4.65 5.12-7.45 23.7-26.86 30.3-64.76 17.08-98.05-4.75-11.96-11.97-22.77-21.2-31.73l-73.74 16.1 46.69 115.89c2.01 3.07.64 7.21-2.8 8.49-2.8 1.03-5.91-.34-7.03-3.1L286.49 448.8l-11.79 4.32c-2.097.28-4.21-.39-5.76-1.825-1.16-1.077-1.925-2.516-2.16-4.083l-11.53-189.68c1.66-1.83 4.03-2.85 6.5-2.798 2.533.05 4.913 1.22 6.5 3.197 6.22 22.46 11.216 45.23 14.96 68.22 5.137 31.55 7.91 63.43 8.3 95.39l136.152-15.28c2.396-1.09 5.032-1.56 7.66-1.35 2.75.22 5.396 1.16 7.663 2.73 41.62 19.22 83.375 38.15 125.26 56.79 41.615 18.52 83.36 36.75 125.23 54.68 1.935-.16 3.703-1.16 4.843-2.73 1.266-1.74 1.618-3.99.948-6.04-3.8-3.45-7.333-7.19-10.575-11.17-3.5-4.3-6.65-8.88-9.42-13.69.11-.34.22-.68.35-1.01.32-.85.7-1.68 1.25-2.41 2.42-3.16 7.04-3.55 9.96-.84 8.66 9.71 19.21 17.557 31.01 23.05 10.67 4.97 22.17 7.927 33.92 8.717 2.58 1.626 4.23 4.39 4.43 7.437.14 2.06-.41 4.103-1.56 5.815-3.63-.24-7.27.26-10.71 1.47-3.55 1.25-6.81 3.23-9.55 5.815l19.55 78.14c-1.4 1.684-3.13 3.07-5.08 4.06-2.28 1.16-4.81 1.76-7.37 1.746-53.05-4.71-106.21-8.08-159.433-10.11-53.34-2.035-106.73-2.72-160.1-2.056-3.79-.575-6.82 3.092-5.54 6.7.63 1.784 2.31 2.98 4.2 2.996l321.783 26.06c2.094.873 3.99 1.933 5.74 3.18 1.46 1.036 2.987 2.365 2.947 4.34-.034 1.75-1.484 3.09-3.154 3.11zm-23.61-56.02c.952-.32 1.776-.934 2.354-1.755.472-.67.76-1.45.833-2.27l-12.96-35.37c-2.706-3.39-5.87-6.4-9.404-8.92-3.324-2.37-6.945-4.3-10.77-5.73l-260.77-58.65-21.01 80.83 311.727 31.88z"/> |
| <path d="M786.68 627.94c.393-18.97 2.614-37.734 6.564-56.05 3.873-17.958 9.463-35.75 19.087-51.71 3.54-5.854 7.58-11.385 12.08-16.53 1.07-1.608 1.71-3.462 1.86-5.386.14-1.842-.16-3.69-.9-5.385-54.19-15.56-108.32-31.34-162.39-47.35-54.2-16.05-108.33-32.33-162.39-48.85-.23 1.43.04 2.9.78 4.15 1.07 1.81 2.96 2.99 5.06 3.13l271.54 104.43c-4.43 19.56-7.17 39.46-8.19 59.49-.99 19.68-.32 39.4 2.02 58.97.81 4.06 4.63 6.79 8.74 6.24 2.88-.39 5.27-2.4 6.15-5.16z"/> |
| </g> |
| </svg> |
| |
| <svg focusable="false" class="pdfbox-brand-text" xmlns="http://www.w3.org/2000/svg" style="isolation:isolate" viewBox="0 0 109.81066666651577 30.943999999957384" aria-labelledby="brandTextTitle brandTextDesc" role="img"> |
| <title id="brandTextTitle">PDFBox brand text</title> |
| <desc id="brandTextDesc">PDFBox, the brand text.</desc> |
| <path d="M0 .31h6.528q1.792 0 3.157.47 1.366.468 2.475 1.663 1.11 1.194 1.536 2.816.427 1.57.427 4.3 0 2-.256 3.45-.214 1.41-.982 2.64-.896 1.492-2.39 2.345-1.492.81-3.924.81H4.36v11.87H0V.305zm4.352 14.42h2.09q1.323 0 2.05-.383.724-.384 1.065-1.024.342-.683.384-1.622.09-.93.09-2.09 0-1.06-.08-2-.04-.98-.38-1.66-.3-.72-.98-1.11-.68-.43-1.96-.43H4.36v10.32z" fill-rule="evenodd"/> |
| <path d="M17.333.31h6.443q3.712 0 5.675 2.09 1.97 2.048 1.97 5.76v14.208q0 4.267-2.09 6.315-2.05 2.005-5.93 2.005h-6.06V.308zm4.352 26.282h2.006q1.84 0 2.61-.896.77-.94.77-2.9V8.16q0-1.792-.72-2.773-.72-.982-2.64-.982H21.7v22.187z" fill-rule="evenodd"/> |
| <path d="M35.583.31h12.97v4.095h-8.618v9.216h7.51v4.1h-7.51v12.97h-4.352V.31z"/> |
| <path d="M51.417.31h6.357q2.09 0 3.54.64 1.495.64 2.433 1.706.94 1.067 1.323 2.475.427 1.37.427 2.86V9.1q0 1.236-.214 2.09-.17.853-.554 1.493-.39.64-.94 1.152-.56.47-1.28.896 1.53.73 2.26 2.18.72 1.41.72 3.8v1.71q0 4.01-1.97 6.15-1.92 2.13-6.19 2.13H51.4V.31zm4.352 26.026h1.87q1.32 0 2.05-.384.77-.384 1.15-1.067.38-.682.47-1.62.08-.94.08-2.05 0-1.15-.13-2.004-.13-.85-.56-1.4-.386-.6-1.11-.89-.727-.3-1.92-.3h-1.92v9.73zm0-13.568h1.96q2.17 0 2.9-1.067.77-1.1.77-3.2 0-2.04-.86-3.07-.81-1.02-2.99-1.02h-1.79v8.37z" fill-rule="evenodd"/> |
| <path d="M69.027 16.31q0-1.323.17-2.433.17-1.11.64-1.962.768-1.408 2.22-2.262 1.45-.853 3.455-.853t3.456.853q1.45.854 2.22 2.262.468.853.64 1.962.17 1.11.17 2.432v7.12q0 1.32-.17 2.43-.172 1.11-.64 1.96-.77 1.4-2.22 2.26-1.45.85-3.456.85-2.005 0-3.456-.86-1.45-.854-2.22-2.26-.468-.855-.64-1.964-.17-1.11-.17-2.43V16.3zm4.352 7.807q0 1.238.55 1.878.6.597 1.58.597.98 0 1.53-.597.59-.64.59-1.878v-8.49q0-1.238-.6-1.835-.557-.64-1.538-.64-.98 0-1.58.64-.553.597-.553 1.835v8.49z" fill-rule="evenodd"/> |
| <path d="M88.316 19.637L83.24 9.057h4.607l2.688 6.143 2.688-6.144h4.608l-5.16 10.58 5.42 11.052h-4.61l-2.94-6.613-2.94 6.613h-4.61l5.34-11.05z"/> |
| <path d="M102.883 5.28h1.2q.784 0 1.168-.224.4-.24.4-.784 0-.464-.35-.672-.33-.224-.88-.224h-1.53V5.28zm-1.056-2.864h2.56q2.32 0 2.32 1.904 0 .48-.144.816-.128.336-.368.56-.24.224-.56.352-.304.112-.656.16l1.93 2.96h-1.28L103.7 6.24h-.817v2.928h-1.056V2.416zm6.832 3.376q0-.976-.37-1.84-.37-.864-.99-1.504-.63-.64-1.48-1.008-.85-.384-1.81-.384t-1.81.384q-.85.368-1.47 1.008t-1 1.504-.37 1.84q0 .976.364 1.84.37.864.992 1.504t1.47 1.024q.85.368 1.81.368.96 0 1.805-.368.85-.384 1.47-1.024.625-.64.99-1.504.37-.864.37-1.84zm-10.44 0q0-1.2.45-2.256.46-1.056 1.25-1.84t1.84-1.232Q102.82 0 104.02 0t2.255.464q1.056.448 1.84 1.232t1.232 1.84q.464 1.056.464 2.256 0 1.2-.46 2.256-.45 1.056-1.23 1.84t-1.84 1.248q-1.05.448-2.25.448t-2.25-.448q-1.053-.464-1.84-1.248t-1.25-1.84q-.45-1.056-.45-2.256z" fill-rule="evenodd"/> |
| </svg> |
| |
| </a> |
| </div> |
| <nav class="wrapper"> |
| <input type="checkbox" id="menu-toggle"> |
| <label for="menu-toggle" class="label-toggle"></label> |
| <ul> |
| <li><a href="/blog">Blog</a></li> |
| </ul> |
| </nav> |
| </header> |
| |
| |
| |
| |
| <div class="container documentation"> |
| <nav class="accordion-menu" role="navigation"> |
| <h1>Documentation</h1> |
| <ul><li> |
| <a href="/3.0/migration.html" > |
| Migration |
| </a> |
| </li><li> |
| <a href="/3.0/getting-started.html" > |
| Getting Started |
| </a> |
| </li><li> |
| <a href="/3.0/dependencies.html" > |
| Dependencies |
| </a> |
| </li><li> |
| <a href="/3.0/commandline.html" > |
| Command-Line Tools |
| </a> |
| </li><li> |
| <a href="/3.0/faq.html" > |
| FAQ |
| </a> |
| </li><li> |
| <a href="https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.0-alpha3/index.html" > |
| API Docs <small>via javadoc.io</small> |
| </a> |
| </li> |
| </ul> |
| </nav> |
| |
| <section> |
| <h1 id="command-line-tools" tabindex="-1">Command-Line Tools</h1> |
| <p>PDFBox comes with a series of command-line utilities. They are available as standard Java applications.</p> |
| <p>See the <a href="/3.0/dependencies.html">Dependencies</a> page for instructions on how to set your classpath in order to run |
| PDFBox tools as Java applications.</p> |
| <h2 id="decrypt" tabindex="-1">Decrypt</h2> |
| <p>This application will decrypt a PDF document.</p> |
| <p>NOTE: You must have the owner password to decrypt the document!</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar decrypt [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-alias=<alias></td> |
| <td>The alias to the certificate in the keystore.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td>The PDF file to decrypt.</td> |
| </tr> |
| <tr> |
| <td>-keyStore=<keyStore></td> |
| <td>Path to keystore that holds certificate to decrypt the document. This is only required if the document is encrypted with a certificate, otherwise only the password is required.</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td>The file to save the decrypted document to. If left blank then it will be the same as the input file.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td>Password to the PDF or certificate in keystore.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="encrypt" tabindex="-1">Encrypt</h2> |
| <p>This application will encrypt a PDF document.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar encrypt [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-canAssemble</td> |
| <td>true</td> |
| <td>Set the assemble permission.</td> |
| </tr> |
| <tr> |
| <td>-canExtractContent</td> |
| <td>true</td> |
| <td>Set the extraction permission.</td> |
| </tr> |
| <tr> |
| <td>-canExtractForAccessibility</td> |
| <td>true</td> |
| <td>Set the extraction permission.</td> |
| </tr> |
| <tr> |
| <td>-canFillInForm</td> |
| <td>true</td> |
| <td>Set the fill in form permission.</td> |
| </tr> |
| <tr> |
| <td>-canModify</td> |
| <td>true</td> |
| <td>Set the modify permission.</td> |
| </tr> |
| <tr> |
| <td>-canModifyAnnotations</td> |
| <td>true</td> |
| <td>Set the modify annots permission.</td> |
| </tr> |
| <tr> |
| <td>-canPrint</td> |
| <td>true</td> |
| <td>Set the print permission.</td> |
| </tr> |
| <tr> |
| <td>-canPrintFaithful</td> |
| <td>true</td> |
| <td>Set the print faithful permission.</td> |
| </tr> |
| <tr> |
| <td>-certFile=<certFile></td> |
| <td></td> |
| <td>Path to X.509 cert file.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>The PDF file to encrypt.</td> |
| </tr> |
| <tr> |
| <td>-keyLength</td> |
| <td>256</td> |
| <td>Key length in bits (valid values: 40, 128 or 256)</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td></td> |
| <td>the encrypted PDF file. If omitted the original file is overwritten.</td> |
| </tr> |
| <tr> |
| <td>-O=[<ownerPassword>]</td> |
| <td></td> |
| <td>set the owner password (ignored if certFile is set)</td> |
| </tr> |
| <tr> |
| <td>-U=[<userPassword>]</td> |
| <td></td> |
| <td>set the user password (ignored if certFile is set)</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="extractimages" tabindex="-1">ExtractImages</h2> |
| <p>This application will extract all images from the given PDF document.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar export:images [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td>The PDF file to decrypt.</td> |
| </tr> |
| <tr> |
| <td>-noColorConvert</td> |
| <td>Images are extracted with their original colorspace if possible.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td>Password for the PDF or certificate in keystore.</td> |
| </tr> |
| <tr> |
| <td>-prefix=<prefix></td> |
| <td>the image prefix (default to pdf name).</td> |
| </tr> |
| <tr> |
| <td>-useDirectJPEG</td> |
| <td>Forces the direct extraction of JPEG/JPX images regardless of colorspace or masking.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="extracttext" tabindex="-1">ExtractText</h2> |
| <p>This application will extract all text from the given PDF document.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar export:text [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-alwaysNext</td> |
| <td>false</td> |
| <td>Process next page (if applicable) despite IOException (ignored when -html)</td> |
| </tr> |
| <tr> |
| <td>-console</td> |
| <td>false</td> |
| <td>Send text to console instead of file.</td> |
| </tr> |
| <tr> |
| <td>-debug</td> |
| <td>false</td> |
| <td>Enables debug output about the time consumption of every stage.</td> |
| </tr> |
| <tr> |
| <td>-encoding=<encoding></td> |
| <td>UTF-8</td> |
| <td>The encoding type of the text file, e.g. UTF-8 or ISO-8859-1, UTF-16BE, UTF-16LE, etc.</td> |
| </tr> |
| <tr> |
| <td>-endPage=<endPage></td> |
| <td>Integer.MAX_INT</td> |
| <td>The last page to extract (1 based, inclusive)</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-html</td> |
| <td>false</td> |
| <td>Output in HTML format instead of raw text.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>The PDF file to encrypt.</td> |
| </tr> |
| <tr> |
| <td>-ignoreBeads</td> |
| <td>false</td> |
| <td>Disables the separation by beads.</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td></td> |
| <td>the exported text file.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td></td> |
| <td>Password for the PDF or certificate in keystore.</td> |
| </tr> |
| <tr> |
| <td>-rotationMagic</td> |
| <td>false</td> |
| <td>Analyze each page for rotated/skewed text, rotate to 0° and extract separately (slower, and ignored when -html)</td> |
| </tr> |
| <tr> |
| <td>-sort</td> |
| <td>false</td> |
| <td>Sort the text before writing.</td> |
| </tr> |
| <tr> |
| <td>-startPage=<startPage></td> |
| <td>1</td> |
| <td>The first page to start extraction (1 based, inclusive)</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="overlaypdf" tabindex="-1">OverlayPDF</h2> |
| <p>This application will overlay one document with the content of another document</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar overlay [OPTIONS] -i=<infile> -o=<outfile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-default=<defaultOverlay></td> |
| <td></td> |
| <td>the default overlay file.</td> |
| </tr> |
| <tr> |
| <td>-even=<evenPageOverlay></td> |
| <td></td> |
| <td>overlay file used for even pages.</td> |
| </tr> |
| <tr> |
| <td>-first=<firstPageOverlay</td> |
| <td></td> |
| <td>overlay file used for the first page.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>the PDF file to be overlayed.</td> |
| </tr> |
| <tr> |
| <td>-last=<lastPageOverlay></td> |
| <td></td> |
| <td>Overlay file used for the last pages.</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td></td> |
| <td>the resulting PDF file.</td> |
| </tr> |
| <tr> |
| <td>-odd=<oddPageOverlay></td> |
| <td></td> |
| <td>overlay file used for odd pages.</td> |
| </tr> |
| <tr> |
| <td>-page=<Integer=specificPageOverlay></td> |
| <td></td> |
| <td>overlay file used for the given page number, may occur more than once.</td> |
| </tr> |
| <tr> |
| <td>-position=<position></td> |
| <td>background</td> |
| <td>Where to put the overlay, foreground or background.</td> |
| </tr> |
| <tr> |
| <td>-useAllPages=<useAllPagesOverlay</td> |
| <td></td> |
| <td>overlay file used for overlay, all pages are used by simply repeating them</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Examples:</p> |
| <ul> |
| <li>overlayPDF -i=input.pdf -default=overlay.pdf -o=output.pdf</li> |
| <li>overlayPDF -i=input.pdf -default=defaultOverlay.pdf -page="10=overlayForPage10.pdf" -position=foreground -o=output.pdf</li> |
| <li>overlayPDF -i=input.pdf -odd=oddOverlay.pdf -even=evenOverlay.pdf -o=output.pdf</li> |
| </ul> |
| <h2 id="pdfdebugger" tabindex="-1">PDFDebugger</h2> |
| <p>This application will take an existing PDF document and allows to analyze and inspect the internal structure. |
| It is used as replacement for the PDFReader which was removed in 2.0.0.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar debug [inputfile]</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>inputfile</td> |
| <td>the name of an optional PDF file to open.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td>password to derypt the PDF.</td> |
| </tr> |
| <tr> |
| <td>-viewstructure</td> |
| <td>Activates the "view structure" view on startup.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="pdfmerger" tabindex="-1">PDFMerger</h2> |
| <p>This application will take a list of pdf documents and merge them, saving the result in a new document.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar merge [-hV] -o=outfile -i=<infile> [-i=<infile>]</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td>the PDF files to merge</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td>the merged PDF file.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="pdfsplit" tabindex="-1">PDFSplit</h2> |
| <p>This application will take an existing PDF document and split it into a number of new documents.</p> |
| <p>Per default the resulting files will be named after the original filenmame with <code>-<nr></code> appended before the suffix. |
| To override the filename use the <code>outputPrefix</code> option.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar split [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-endPage=<endPage></td> |
| <td>end page.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td>the PDF file to split</td> |
| </tr> |
| <tr> |
| <td>--outputPrefix=<outputPrefix></td> |
| <td>the filename prefix for split files.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td>Password to the PDF.</td> |
| </tr> |
| <tr> |
| <td>-split=<split></td> |
| <td>split after this many pages (default 1, if startPage and endPage are unset).</td> |
| </tr> |
| <tr> |
| <td>-startPage=<startPage></td> |
| <td>start page.</td> |
| </tr> |
| <tr> |
| <td>-endPage</td> |
| <td>The page to stop at.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td>Print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Examples:</p> |
| <ul> |
| <li>PDFSplit -split=2 -i=sample_with_13_pages.pdf will split the pdf in pieces of 2 pages each except the last which will contain 1 page only.</li> |
| <li>PDFSplit -startPage=5 -i=sample_with_13_pages.pdf will provide a pdf containing all pages of the source pdf starting at page 5</li> |
| <li>PDFSplit -startPage=5 -endPage=10 -i=sample_with_13_pages.pdf will provide a pdf containing all pages from 5 to 10 of the source pdf</li> |
| <li>PDFSplit -split=2 -startPage=5 -endPage=10 -isample_with_13_pages.pdf will provide 3 pdfs containing all pages from 5 to 10 of the source pdf 2 pages each</li> |
| </ul> |
| <h2 id="pdftoimage" tabindex="-1">PDFToImage</h2> |
| <p>This application will create an image for every page in the PDF document.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar render [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-color=<imageType></td> |
| <td>rgb</td> |
| <td>The color depth (valid: BINARY, GRAY, RGB, ARGB, BGR)</td> |
| </tr> |
| <tr> |
| <td>-cropbox=<int> <int> <int> <int></td> |
| <td></td> |
| <td>The page area to export.</td> |
| </tr> |
| <tr> |
| <td>-dpi, -resolution=<dpi></td> |
| <td>detected from screen (or 96 if headless)</td> |
| <td>the DPI of the output image</td> |
| </tr> |
| <tr> |
| <td>-endPage=<endPage></td> |
| <td>Integer.MAX_INT</td> |
| <td>The last page to convert, (one based, inclusive).</td> |
| </tr> |
| <tr> |
| <td>-format=<imageFormat></td> |
| <td>jpg</td> |
| <td>The image file format.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>the PDF file to convert.</td> |
| </tr> |
| <tr> |
| <td>-page=<page></td> |
| <td></td> |
| <td>The only page to extract (1-based).</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td></td> |
| <td>Password for the PDF.</td> |
| </tr> |
| <tr> |
| <td>-prefix, -outputPrefix=<outputPrefix></td> |
| <td>Name of PDF document</td> |
| <td>the filename prefix for image files</td> |
| </tr> |
| <tr> |
| <td>-quality=<quality></td> |
| <td>0 for PNG and 1 for other formats</td> |
| <td>the quality to be used when compressing the image (0 <= quality <= 1).</td> |
| </tr> |
| <tr> |
| <td>-startPage=<startPage></td> |
| <td>1</td> |
| <td>the first page to start extraction (one based)</td> |
| </tr> |
| <tr> |
| <td>-subSampling</td> |
| <td></td> |
| <td>activate subsampling (for PDFs with huge images)</td> |
| </tr> |
| <tr> |
| <td>-time</td> |
| <td></td> |
| <td>print timing information to stdout.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="printpdf" tabindex="-1">PrintPDF</h2> |
| <p>This application will send a pdf document to the printer.</p> |
| <p class="alert alert-info">You must have the correct permissions to print the document!</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar print [OPTIONS] -i=<infile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-border</td> |
| <td></td> |
| <td>Print with border.</td> |
| </tr> |
| <tr> |
| <td>-dpi=<dpi></td> |
| <td></td> |
| <td>render into intermediate image with specific dpi and then print</td> |
| </tr> |
| <tr> |
| <td>-duplex=<duplex></td> |
| <td>DOCUMENT</td> |
| <td>print using duplex (SIMPLEX, DUPLEX, TUMBLE, DOCUMENT).</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>the PDF file to print.</td> |
| </tr> |
| <tr> |
| <td>-mediaSize=<mediaSize></td> |
| <td></td> |
| <td>print using media size name.</td> |
| </tr> |
| <tr> |
| <td>-noColorOpt</td> |
| <td></td> |
| <td>disable color optimizations (useful when printing barcodes).</td> |
| </tr> |
| <tr> |
| <td>-orientation</td> |
| <td>AUTO</td> |
| <td>print using orientation (AUTO, LANDSCAPE, PORTRAIT).</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td></td> |
| <td>Password for the PDF.</td> |
| </tr> |
| <tr> |
| <td>-printerName=<printerName></td> |
| <td></td> |
| <td>print to specified printer.</td> |
| </tr> |
| <tr> |
| <td>-silentPrint</td> |
| <td></td> |
| <td>print without printer dialog box.</td> |
| </tr> |
| <tr> |
| <td>-tray=<tray></td> |
| <td></td> |
| <td>print using tray.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="texttopdf" tabindex="-1">TextToPDF</h2> |
| <p>This application will create a PDF document from a text file.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar fromText [OPTIONS] -i=<infile> -o=<outfile></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-charset=<charset></td> |
| <td>UTF-8</td> |
| <td>the charset to use.</td> |
| </tr> |
| <tr> |
| <td>-fontSize=<fontSize></td> |
| <td>10</td> |
| <td>the size of the font to use.</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td></td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-i, --input=<infile></td> |
| <td></td> |
| <td>the text file to convert.</td> |
| </tr> |
| <tr> |
| <td>-landscape</td> |
| <td></td> |
| <td>set orientation to landscape.</td> |
| </tr> |
| <tr> |
| <td>-o, --output=<outfile></td> |
| <td></td> |
| <td>the generated PDF file.</td> |
| </tr> |
| <tr> |
| <td>-pageSize=<pageSize></td> |
| <td>LETTER</td> |
| <td>the page size to use (LETTER, LEGAL, A0, A1, A2, A3, A4, A5, A6).</td> |
| </tr> |
| <tr> |
| <td>-standardFont=<standardFont></td> |
| <td>Helvetica</td> |
| <td>The font to use for the text. Either this or -ttf should be specified but not both.</td> |
| </tr> |
| <tr> |
| <td>-ttf=<ttfFile></td> |
| <td></td> |
| <td>The TTF font to use for the text. Either this or -standardFont should be specified but not both.</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td></td> |
| <td>print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The following font names can be used for the parameter <code>standardFont</code>:</p> |
| <ul> |
| <li>Courier</li> |
| <li>Courier-Bold</li> |
| <li>Courier-Oblique</li> |
| <li>Courier-BoldOblique</li> |
| <li>Helvetica</li> |
| <li>Helvetica-Bold</li> |
| <li>Helvetica-Oblique</li> |
| <li>Helvetica-BoldOblique</li> |
| <li>Symbol</li> |
| <li>Times-Bold</li> |
| <li>Times-Roman</li> |
| <li>Times-Italic</li> |
| <li>Times-BoldItalic</li> |
| <li>ZapfDingbats</li> |
| </ul> |
| <h2 id="writedecodeddoc" tabindex="-1">WriteDecodedDoc</h2> |
| <p>An application to decompress PDF documents.</p> |
| <p>Usage: <code>java -jar pdfbox-app-3.y.z.jar decode [OPTIONS] <input-file> <output-file></code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Command-Line Parameter</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>input-file</td> |
| <td>the PDF document to decompress</td> |
| </tr> |
| <tr> |
| <td>output-file</td> |
| <td>the PDF file top save to</td> |
| </tr> |
| <tr> |
| <td>-h, --help</td> |
| <td>Show help message and exit.</td> |
| </tr> |
| <tr> |
| <td>-password=[<password>]</td> |
| <td>Password for the PDF.</td> |
| </tr> |
| <tr> |
| <td>-skipImages</td> |
| <td>don't uncompress images</td> |
| </tr> |
| <tr> |
| <td>-V, --version</td> |
| <td>print version information and exit.</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| </section> |
| <aside> |
| |
| <h1>Table of Contents<a class="edit-link" href="https://github.com/apache/pdfbox-docs/edit/master/./content/3.0/commandline.md" title="Edit this page"> |
| <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"/></svg> |
| </a></h1> |
| |
| <nav class="toc"> |
| <ol> |
| |
| <li><a href="#decrypt">Decrypt</a> |
| </li> |
| |
| <li><a href="#encrypt">Encrypt</a> |
| </li> |
| |
| <li><a href="#extractimages">ExtractImages</a> |
| </li> |
| |
| <li><a href="#extracttext">ExtractText</a> |
| </li> |
| |
| <li><a href="#overlaypdf">OverlayPDF</a> |
| </li> |
| |
| <li><a href="#pdfdebugger">PDFDebugger</a> |
| </li> |
| |
| <li><a href="#pdfmerger">PDFMerger</a> |
| </li> |
| |
| <li><a href="#pdfsplit">PDFSplit</a> |
| </li> |
| |
| <li><a href="#pdftoimage">PDFToImage</a> |
| </li> |
| |
| <li><a href="#printpdf">PrintPDF</a> |
| </li> |
| |
| <li><a href="#texttopdf">TextToPDF</a> |
| </li> |
| |
| <li><a href="#writedecodeddoc">WriteDecodedDoc</a> |
| </li> |
| </ol> |
| </nav> |
| |
| </aside> |
| </div> |
| |
| <footer class="footer"> |
| <div class="container"> |
| <div class="row"> |
| <div class="span3"> |
| <!-- nothing in here on purpose --> |
| </div> |
| <div class="span9"> |
| <p>Copyright © 2009–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. |
| <br>Apache PDFBox, PDFBox, Apache, the Apache feather logo and the Apache PDFBox project logos are trademarks of The Apache Software Foundation.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| |
| </body> |
| |
| </html> |
