Author: msahyoun Date: Fri Oct 23 12:14:14 2015 New Revision: 1710194 URL: http://svn.apache.org/viewvc?rev=1710194&view=rev Log: PDFBOX-3040: add TOC
Modified: pdfbox/cmssite/branches/jekyll-migration/content/1.8/commandline.mdtext pdfbox/cmssite/branches/jekyll-migration/content/2.0/commandline.md Modified: pdfbox/cmssite/branches/jekyll-migration/content/1.8/commandline.mdtext URL: http://svn.apache.org/viewvc/pdfbox/cmssite/branches/jekyll-migration/content/1.8/commandline.mdtext?rev=1710194&r1=1710193&r2=1710194&view=diff ============================================================================== --- pdfbox/cmssite/branches/jekyll-migration/content/1.8/commandline.mdtext (original) +++ pdfbox/cmssite/branches/jekyll-migration/content/1.8/commandline.mdtext Fri Oct 23 12:14:14 2015 @@ -10,9 +10,21 @@ PDFBox comes with a series of command li See the Dependencies page for instructions on how to set your classpath in order to run PDFBox tools as Java applications. -[TOC] +**Table of Contents** +[Decrypt](#decrypt) +[Encrypt](#encrypt) +[ExtractText](#extracttext) +[OverlayPDF](#overlaypdf) +[PrintPDF](#printpdf) +[PDFDebugger](#pdfdebugger) +[PDFReader](#pdfreader) +[PDFMerger](#pdfmerger) +[PDFSplit](#pdfsplit) +[PDFToImage](#pdftoimage) +[TextToPDF](#texttopdf) +[WriteDecodedDoc](#writedecodeddoc) -## Decrypt ## {#decrypt} +## Decrypt ## This application will decrypt a PDF document. @@ -28,7 +40,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | inputfile | The PDF file to decrypt. | | outputfile | The file to save the decrypted document to. If left blank then it will be the same as the input file. | -## Encrypt ## {#encrypt} +## Encrypt ## This application will encrypt a PDF document. @@ -51,7 +63,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | inputfile | |The PDF file to encrypt. | | outputfile | |The file to save the encrypted document to. If left blank then it will be the same as the input file. | -## ExtractText ## {#extractText} +## ExtractText ## This application will extract all text from the given PDF document. @@ -71,7 +83,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | -endPage | Integer.MAX_INT | The last page to extract, one based. | | -nonSeq | false | Use the new non sequential parser. | -## OverlayPDF ## {#overlayPDF} +## OverlayPDF ## This application will overlay one document with the content of another document @@ -96,7 +108,7 @@ Examples: - OverlayPDF input.pdf defaultOverlay.pdf -page 10 overlayForPage10.pdf -position foreground -nonSeq output.pdf - OverlayPDF input.pdf -odd oddOverlay.pdf -even evenOverlay.pdf -nonSeq output.pdf -## PrintPDF ## {#printPDF} +## PrintPDF ## This application will send a pdf document to the printer. @@ -110,7 +122,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | -silentPrint | Print the PDF without prompting for a printer. | | inputfile | The PDF file to print. | -## PDFDebugger ## {#pdfDebugger} +## PDFDebugger ## This application will take an existing PDF document and allows to analyze and inspect the internal structure @@ -122,7 +134,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | -nonSeq | false | Use the new non sequential parser. | inputfile | | the name of an optional PDF file to open. | -## PDFReader ## {#pdfReader} +## PDFReader ## An application to read PDF documents. This will provide Acrobat Reader like functionality. @@ -134,7 +146,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | -nonSeq | false | Use the new non sequential parser.| | PDF file | | the name of an optional PDF file to open | -## PDFMerger ## {#pdfMerger} +## PDFMerger ## This application will take a list of pdf documents and merge them, saving the result in a new document. @@ -161,7 +173,7 @@ Examples: - PDFSplit -startPage 5 -endPage 10 sample_with_13_pages.pdf will provide a pdf containing all pages from 5 to 10 of the source pdf - PDFSplit -split 2 -startPage 5 -endPage 10 sample_with_13_pages.pdf will provide 3 pdfs containing all pages from 5 to 10 of the source pdf 2 pages each -## PDFToImage ## {#pdfToImage} +## PDFToImage ## This application will create an image for every page in the PDF document. @@ -176,7 +188,7 @@ usage: ``java -jar pdfbox-app-x.y.z.jar | -endPage | Integer.MAX_INT | The last page to convert, one based. | | -nonSeq | false | Use the new non sequential parser. | -## TextToPDF ## {#textToPDF} +## TextToPDF ## This application will create a PDF document from a text file. @@ -205,7 +217,7 @@ The following font names can be used for - Times-BoldItalic - ZapfDingbats -## WriteDecodedDoc ## {#writeDecodeDoc} +## WriteDecodedDoc ## An application to decompress PDF documents. Modified: pdfbox/cmssite/branches/jekyll-migration/content/2.0/commandline.md URL: http://svn.apache.org/viewvc/pdfbox/cmssite/branches/jekyll-migration/content/2.0/commandline.md?rev=1710194&r1=1710193&r2=1710194&view=diff ============================================================================== --- pdfbox/cmssite/branches/jekyll-migration/content/2.0/commandline.md (original) +++ pdfbox/cmssite/branches/jekyll-migration/content/2.0/commandline.md Fri Oct 23 12:14:14 2015 @@ -9,9 +9,20 @@ PDFBox comes with a series of command li See the Dependencies page for instructions on how to set your classpath in order to run PDFBox tools as Java applications. -[TOC] +**Table of Contents** +[Decrypt](#decrypt) +[Encrypt](#encrypt) +[ExtractText](#extracttext) +[OverlayPDF](#overlaypdf) +[PDFDebugger](#pdfdebugger) +[PDFMerger](#pdfmerger) +[PDFSplit](#pdfsplit) +[PDFToImage](#pdftoimage) +[PrintPDF](#printpdf) +[TextToPDF](#texttopdf) +[WriteDecodedDoc](#writedecodeddoc) -## Decrypt ## {#decrypt} +## Decrypt ## This application will decrypt a PDF document. @@ -27,7 +38,7 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | inputfile | The PDF file to decrypt. | | outputfile | The file to save the decrypted document to. If left blank then it will be the same as the input file. | -## Encrypt ## {#encrypt} +## Encrypt ## This application will encrypt a PDF document. @@ -50,7 +61,7 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | inputfile | |The PDF file to encrypt. | | outputfile | |The file to save the encrypted document to. If left blank then it will be the same as the input file. | -## ExtractText ## {#extractText} +## ExtractText ## This application will extract all text from the given PDF document. @@ -69,7 +80,7 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | -startPage | 1 | The first page to extract, one based. | | -endPage | Integer.MAX_INT | The last page to extract, one based. | -## OverlayPDF ## {#overlayPDF} +## OverlayPDF ## This application will overlay one document with the content of another document @@ -93,7 +104,7 @@ Examples: - OverlayPDF input.pdf defaultOverlay.pdf -page 10 overlayForPage10.pdf -position foreground output.pdf - OverlayPDF input.pdf -odd oddOverlay.pdf -even evenOverlay.pdf output.pdf -## PDFDebugger ## {#pdfDebugger} +## PDFDebugger ## 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. @@ -106,13 +117,13 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | -viewstructure | | Activates the "view structure" view on startup. | | inputfile | | the name of an optional PDF file to open. | -## PDFMerger ## {#pdfMerger} +## PDFMerger ## This application will take a list of pdf documents and merge them, saving the result in a new document. usage: ``java -jar pdfbox-app-2.y.z.jar PDFMerger <Source PDF files (2 ..n)> <Target PDF file>`` -## PDFSplit ## {#pdfSplit} +## PDFSplit ## This application will take an existing PDF document and split it into a number of other documents @@ -132,7 +143,7 @@ Examples: - PDFSplit -startPage 5 -endPage 10 sample_with_13_pages.pdf will provide a pdf containing all pages from 5 to 10 of the source pdf - PDFSplit -split 2 -startPage 5 -endPage 10 sample_with_13_pages.pdf will provide 3 pdfs containing all pages from 5 to 10 of the source pdf 2 pages each -## PDFToImage ## {#pdfToImage} +## PDFToImage ## This application will create an image for every page in the PDF document. @@ -146,7 +157,7 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | -startPage | 1 | The first page to convert, one based. | | -endPage | Integer.MAX_INT | The last page to convert, one based. | -## PrintPDF ## {#printPDF} +## PrintPDF ## This application will send a pdf document to the printer. @@ -160,7 +171,7 @@ usage: ``java -jar pdfbox-app-2.y.z.jar | -silentPrint | Print the PDF without prompting for a printer. | | inputfile | The PDF file to print. | -## TextToPDF ## {#textToPDF} +## TextToPDF ## This application will create a PDF document from a text file. @@ -189,7 +200,7 @@ The following font names can be used for - Times-BoldItalic - ZapfDingbats -## WriteDecodedDoc ## {#writeDecodeDoc} +## WriteDecodedDoc ## An application to decompress PDF documents.