You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2016/08/03 06:18:39 UTC

pdfbox-docs git commit: PDFBOX-3330: document outputPrefix option for PDFSplit command

Repository: pdfbox-docs
Updated Branches:
  refs/heads/master b2746fd31 -> da3aa6c04


PDFBOX-3330: document outputPrefix option for PDFSplit command


Project: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/commit/da3aa6c0
Tree: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/tree/da3aa6c0
Diff: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/diff/da3aa6c0

Branch: refs/heads/master
Commit: da3aa6c04a0d15541c7d5d71db6ac58bdcaa5bef
Parents: b2746fd
Author: Maruan Sahyoun <sa...@fileaffairs.de>
Authored: Wed Aug 3 08:18:23 2016 +0200
Committer: Maruan Sahyoun <sa...@fileaffairs.de>
Committed: Wed Aug 3 08:18:23 2016 +0200

----------------------------------------------------------------------
 content/1.8/commandline.md | 16 ++++++++++------
 content/2.0/commandline.md | 14 +++++++++-----
 2 files changed, 19 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/da3aa6c0/content/1.8/commandline.md
----------------------------------------------------------------------
diff --git a/content/1.8/commandline.md b/content/1.8/commandline.md
index 7f991bd..8fc3b63 100644
--- a/content/1.8/commandline.md
+++ b/content/1.8/commandline.md
@@ -15,7 +15,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
          KIND, either express or implied.  See the License for the
          specific language governing permissions and limitations
          under the License.
-         
+
 layout:  default
 title:   Command Line Tools
 ---
@@ -24,7 +24,7 @@ title:   Command Line Tools
 
 PDFBox comes with a series of command line utilities. They are available as standard Java applications.
 
-See the [Dependencies](/1.8/dependencies.html) page for instructions on how to set your classpath in order to run 
+See the [Dependencies](/1.8/dependencies.html) page for instructions on how to set your classpath in order to run
 PDFBox tools as Java applications.
 
 **Table of Contents**  
@@ -184,7 +184,10 @@ usage: ``java -jar pdfbox-app-x.y.z.jar PDFMerger <Source PDF files (2 ..n)> <Ta
 
 ## PDFSplit ##
 
-This application will take an existing PDF document and split it into a number of other documents
+This application will take an existing PDF document and split it into a number of new documents.
+
+Per default the resulting files will be named after the original filenmame with `-<nr>` appended before the suffix.
+To override the filename use the `outputPrefix` option.
 
 usage: ``java -jar pdfbox-app-x.y.z.jar PDFSplit [OPTIONS] <PDF file>``
 
@@ -194,8 +197,10 @@ usage: ``java -jar pdfbox-app-x.y.z.jar PDFSplit [OPTIONS] <PDF file>``
 | -split | | Number of pages of every splitted part of the pdf.|
 | -startPage | | The page to start at. |
 | -endPage | | The page to stop at. |
+| -outputPrefix | | The prefix for the generated file name. The resulting name will be in the format `<prefix>-<nr>.pdf` |
 | -nonSeq | false | Use the new non sequential parser.|
 
+
 Examples:
 
  - PDFSplit -split 2 sample_with_13_pages.pdf will split the pdf in pieces of 2 pages each except the last which will contain 1 page only.
@@ -216,7 +221,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar PDFToImage [OPTIONS] <PDF file>``
 | -outputPrefix | Name of PDF document | The prefix to the image file. |
 | -startPage | 1 | The first page to convert, one based. |
 | -endPage | Integer.MAX_INT | The last page to convert, one based. |
-| -nonSeq | false | Use the new non sequential parser. | 
+| -nonSeq | false | Use the new non sequential parser. |
 
 ## TextToPDF ##
 
@@ -246,7 +251,7 @@ The following font names can be used for the parameter ``standardFont``:
  - Times-Italic
  - Times-BoldItalic
  - ZapfDingbats
- 
+
 ## WriteDecodedDoc ##
 
 An application to decompress PDF documents.
@@ -259,4 +264,3 @@ usage: ``java -jar pdfbox-app-x.y.z.jar WriteDecodedDoc <input-file> <output-fil
 | -nonSeq 	| false | Use the new non sequential parser. |
 | <input-file> |  | The PDF file to decompress |
 | <output-file> |  | The destination PDF file |
-

http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/da3aa6c0/content/2.0/commandline.md
----------------------------------------------------------------------
diff --git a/content/2.0/commandline.md b/content/2.0/commandline.md
index aa4f8cf..1a638f6 100644
--- a/content/2.0/commandline.md
+++ b/content/2.0/commandline.md
@@ -23,14 +23,14 @@ title:   Command Line Tools
 
 PDFBox comes with a series of command line utilities. They are available as standard Java applications.
 
-See the [Dependencies](/2.0/dependencies.html) page for instructions on how to set your classpath in order to run 
+See the [Dependencies](/2.0/dependencies.html) page for instructions on how to set your classpath in order to run
 PDFBox tools as Java applications.
 
 **Table of Contents**  
 [Decrypt](#decrypt)
 [Encrypt](#encrypt)
 [ExtractImages](#extractimages)
-[ExtractText](#extracttext) 
+[ExtractText](#extracttext)
 [OverlayPDF](#overlaypdf)
 [PDFDebugger](#pdfdebugger)
 [PDFMerger](#pdfmerger)
@@ -155,7 +155,10 @@ usage: ``java -jar pdfbox-app-2.y.z.jar PDFMerger <Source PDF files (2 ..n)> <Ta
 
 ## PDFSplit ##
 
-This application will take an existing PDF document and split it into a number of other documents
+This application will take an existing PDF document and split it into a number of new documents.
+
+Per default the resulting files will be named after the original filenmame with `-<nr>` appended before the suffix.
+To override the filename use the `outputPrefix` option.
 
 usage: ``java -jar pdfbox-app-2.y.z.jar PDFSplit [OPTIONS] <PDF file>``
 
@@ -165,6 +168,8 @@ usage: ``java -jar pdfbox-app-2.y.z.jar PDFSplit [OPTIONS] <PDF file>``
 | -split | | Number of pages of every splitted part of the pdf.|
 | -startPage | | The page to start at. |
 | -endPage | | The page to stop at. |
+| --outputPrefix | | The prefix for the generated file name. The resulting name will be in the format `<prefix>-<nr>.pdf` |
+
 
 Examples:
 
@@ -229,7 +234,7 @@ The following font names can be used for the parameter ``standardFont``:
  - Times-Italic
  - Times-BoldItalic
  - ZapfDingbats
- 
+
 ## WriteDecodedDoc ##
 
 An application to decompress PDF documents.
@@ -241,4 +246,3 @@ usage: ``java -jar pdfbox-app-2.y.z.jar WriteDecodedDoc <input-file> <output-fil
 | -password |  | The password to the PDF document. |
 | <input-file> |  | The PDF file to decompress |
 | <output-file> |  | The destination PDF file |
-