Author: lehmi
Date: Fri Mar 12 07:26:49 2010
New Revision: 922165
URL: http://svn.apache.org/viewvc?rev=922165&view=rev
Log:
PDFBOX-653: added basic documentation for some commandline tools. Patch by
Maruan Sahyoun (sahyoun at fileaffairs dot de)
Added:
pdfbox/trunk/src/site/xdoc/commandlineutilities/Overlay.xml
pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFDebugger.xml
pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFMerger.xml
pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFReader.xml
pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFSplit.xml
Modified:
pdfbox/trunk/src/site/site.xml
Modified: pdfbox/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/site.xml?rev=922165&r1=922164&r2=922165&view=diff
==============================================================================
--- pdfbox/trunk/src/site/site.xml (original)
+++ pdfbox/trunk/src/site/site.xml Fri Mar 12 07:26:49 2010
@@ -51,13 +51,18 @@
</menu>
<menu name="Command Line Utilities">
<item name="Index" href="commandlineutilities/index.html"/>
+ <item name="ConvertColorspace"
+ href="commandlineutilities/ConvertColorspace.html"/>
<item name="Decrypt" href="commandlineutilities/Decrypt.html"/>
<item name="Encrypt" href="commandlineutilities/Encrypt.html"/>
<item name="ExtractText" href="commandlineutilities/ExtractText.html"/>
- <item name="PDFToImage" href="commandlineutilities/PDFToImage.html"/>
+ <item name="Overlay" href="commandlineutilities/Overlay.html"/>
<item name="PrintPDF" href="commandlineutilities/PrintPDF.html"/>
- <item name="ConvertColorspace"
- href="commandlineutilities/ConvertColorspace.html"/>
+ <item name="PDFDebugger" href="commandlineutilities/PDFDebugger.html"/>
+ <item name="PDFMerger" href="commandlineutilities/PDFMerger.html"/>
+ <item name="PDFReader" href="commandlineutilities/PDFReader.html"/>
+ <item name="PDFSplit" href="commandlineutilities/PDFSplit.html"/>
+ <item name="PDFToImage" href="commandlineutilities/PDFToImage.html"/>
<item name="TextToPDF" href="commandlineutilities/TextToPDF.html"/>
</menu>
<menu name="Developers Guide">
Added: pdfbox/trunk/src/site/xdoc/commandlineutilities/Overlay.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/xdoc/commandlineutilities/Overlay.xml?rev=922165&view=auto
==============================================================================
--- pdfbox/trunk/src/site/xdoc/commandlineutilities/Overlay.xml (added)
+++ pdfbox/trunk/src/site/xdoc/commandlineutilities/Overlay.xml Fri Mar 12
07:26:49 2010
@@ -0,0 +1,30 @@
+<!--
+ ! 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>
+ <properties>
+ <title>Overlay</title>
+ </properties>
+ <body>
+ <section name="Overlay">
+ <p>This application will overlay one document with the content of
another document</p>
+ <p>usage: java org.apache.pdfbox.Overlay <overlay.pdf>
<document.pdf> <result.pdf></p>
+ <p>If the overlay document contains more than one page the pages are
overlayed to the document on order e.g. if the document has 10 pages and the
overlay contains 2 pages the order is
+ Document: 1234567890 Overlay: 1212121212</p>
+ </section>
+ </body>
+</document>
Added: pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFDebugger.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFDebugger.xml?rev=922165&view=auto
==============================================================================
--- pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFDebugger.xml (added)
+++ pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFDebugger.xml Fri Mar 12
07:26:49 2010
@@ -0,0 +1,42 @@
+<!--
+ ! 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>
+ <properties>
+ <title>PDFDebugger</title>
+ </properties>
+ <body>
+ <section name="PDFDebugger">
+ <p>This application will take an existing PDF document and allows to
analyze and inspect the internal structure </p>
+ <p>usage: java org.apache.pdfbox.PDFDebugger [PDF file]</p>
+ <table>
+ <tr>
+ <th>Command Line Parameter</th>
+ <th>Type</th>
+ <th>Default Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>PDF file</td>
+ <td>string</td>
+ <td>none</td>
+ <td>the name of an optional PDF file to open</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
Added: pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFMerger.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFMerger.xml?rev=922165&view=auto
==============================================================================
--- pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFMerger.xml (added)
+++ pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFMerger.xml Fri Mar 12
07:26:49 2010
@@ -0,0 +1,28 @@
+<!--
+ ! 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>
+ <properties>
+ <title>PDFMerger</title>
+ </properties>
+ <body>
+ <section name="PDFMerger">
+ <p>This application will take a list of pdf documents and merge them,
saving the result in a new document.</p>
+ <p>usage: java org.apache.pdfbox.PDFMerger <Source PDF files (2
..n)> <Target PDF file></p>
+ </section>
+ </body>
+</document>
Added: pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFReader.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFReader.xml?rev=922165&view=auto
==============================================================================
--- pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFReader.xml (added)
+++ pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFReader.xml Fri Mar 12
07:26:49 2010
@@ -0,0 +1,42 @@
+<!--
+ ! 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>
+ <properties>
+ <title>PDFReader</title>
+ </properties>
+ <body>
+ <section name="PDFReader">
+ <p>An application to read PDF documents. This will provide Acrobat
Reader like functionality.</p>
+ <p>usage: java org.apache.pdfbox.PDFReader [PDF file]</p>
+ <table>
+ <tr>
+ <th>Command Line Parameter</th>
+ <th>Type</th>
+ <th>Default Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>PDF file</td>
+ <td>string</td>
+ <td>none</td>
+ <td>the name of an optional PDF file to open</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
Added: pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFSplit.xml
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFSplit.xml?rev=922165&view=auto
==============================================================================
--- pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFSplit.xml (added)
+++ pdfbox/trunk/src/site/xdoc/commandlineutilities/PDFSplit.xml Fri Mar 12
07:26:49 2010
@@ -0,0 +1,49 @@
+<!--
+ ! 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>
+ <properties>
+ <title>PDFSplit</title>
+ </properties>
+ <body>
+ <section name="PDFSplit">
+ <p>This application will take an existing PDF document and split it into
a number of other documents</p>
+ <p>usage: java org.apache.pdfbox.PDFSplit [OPTIONS] <PDF file></p>
+ <table>
+ <tr>
+ <th>Command Line Parameter</th>
+ <th>Type</th>
+ <th>Default Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>-password <password></td>
+ <td>string</td>
+ <td>none</td>
+ <td>The password to the PDF document.</td>
+ </tr>
+ <tr>
+ <td>-split <integer></td>
+ <td>integer
+ </td>
+ <td>None</td>
+ <td>Number of pages after which splitting occurs.</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
