blob: c89f0570fdcc58d05307257712b22ce43fcd8198 [file]
<!--
! 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.
!-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>PDFToImage</title>
<meta name="keywords">pdf to image, java pdf image, image, pdfbox, open source</meta>
</header>
<body>
<section>
<title>Description</title>
<p>This application will create an image for every page in the PDF document.</p>
<warning>This is new code and should be treated as beta quality!</warning>
<table>
<tr>
<th>Command Line Parameter</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>-password &lt;password&gt;</td>
<td>string</td>
<td>None</td>
<td>The password to the PDF document.</td>
</tr>
<tr>
<td>-imageType &lt;type&gt;</td>
<td>string</td>
<td>jpg</td>
<td>The image type to write to. Currently only jpg or png.</td>
</tr>
<tr>
<td>-outputPrefix &lt;image file prefix&gt;</td>
<td>string</td>
<td>Name of PDF document</td>
<td>The prefix to the image file.</td>
</tr>
<tr>
<td>-startPage &lt;start page&gt;</td>
<td>integer</td>
<td>1</td>
<td>The first page to extract, one based.</td>
</tr>
<tr>
<td>-endPage &lt;end page&gt;</td>
<td>integer</td>
<td>Integer.MAX_INT</td>
<td>The last page to extract, one based.</td>
</tr>
</table>
</section>
</body>
</document>