Author: msahyoun
Date: Mon Dec 28 13:38:26 2020
New Revision: 1884867
URL: http://svn.apache.org/viewvc?rev=1884867&view=rev
Log:
PDFBOX-2602: commands wil use lower case (case insensitive); harmonize
header/description
Modified:
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/PDFDebugger.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFBox.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFMerger.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFSplit.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PrintPDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Version.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
Modified:
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/PDFDebugger.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/PDFDebugger.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
---
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/PDFDebugger.java
(original)
+++
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/PDFDebugger.java
Mon Dec 28 13:38:26 2020
@@ -141,7 +141,7 @@ import picocli.CommandLine.Parameters;
* @author Khyrul Bashar
*/
@SuppressWarnings({ "serial", "squid:MaximumInheritanceDepth", "squid:S1948" })
-@Command(name = "PDFDebugger", description = "Analyze and inspect the internal
structure of a PDF.")
+@Command(name = "pdfdebugger", description = "Analyzes and inspects the
internal structure of a PDF document")
public class PDFDebugger extends JFrame implements Callable<Integer> {
private static final Set<COSName> SPECIALCOLORSPACES = new HashSet<>(
Arrays.asList(COSName.INDEXED, COSName.SEPARATION,
COSName.DEVICEN));
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java Mon
Dec 28 13:38:26 2020
@@ -39,8 +39,8 @@ import picocli.CommandLine.Parameters;
* @author Ben Litchfield
*/
@Command(
- name = "Decrypt",
- header = "${COMMAND-NAME} - decrypts a PDF file.%n",
+ name = "decrpyt",
+ header = "Decrypts a PDF document",
description = "This will read an encrypted document and decrypt it either
using a password or a certificate.",
versionProvider = Version.class,
mixinStandardHelpOptions = true
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java Mon
Dec 28 13:38:26 2020
@@ -47,8 +47,8 @@ import picocli.CommandLine.Parameters;
* @author Ben Litchfield
*/
@Command(
- name = "Encrypt",
- header = "${COMMAND-NAME} - encrypts a PDF file.%n",
+ name = "encrypt",
+ header = "Encrypts a PDF document",
description = {
"${COMMAND-NAME} will read an unencrypted document and encrypt it
either using a password or a certificate.%n",
"While encypting the document permissions can be set which will
allow/disallow certain functionality"
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java Mon
Dec 28 13:38:26 2020
@@ -37,7 +37,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "ExportFDF", description = "Exports AcroForm form data to
FDF.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "exportfdf", description = "Exports AcroForm form data to
FDF", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class ExportFDF implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
Mon Dec 28 13:38:26 2020
@@ -37,7 +37,7 @@ import org.apache.pdfbox.pdmodel.fdf.FDF
*
* @author Ben Litchfield
*/
-@Command(name = "ExportXFDF", description = "Exports AcroForm form data to
XFDF.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "exportxfdf", description = "Exports AcroForm form data to
XFDF", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class ExportXFDF implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
Mon Dec 28 13:38:26 2020
@@ -66,7 +66,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "ExtractImages", description = "Extracts the images from a PDF
file.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "extractimages", description = "Extracts the images from a PDF
document", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class ExtractImages implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
Mon Dec 28 13:38:26 2020
@@ -59,7 +59,7 @@ import picocli.CommandLine.Parameters;
* @author Ben Litchfield
* @author Tilman Hausherr
*/
-@Command(name = "ExtractText", description = "Extract all text from the given
PDF document.", versionProvider = Version.class, mixinStandardHelpOptions =
true)
+@Command(name = "extracttext", description = "Extracts the text from a PDF
document", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class ExtractText implements Callable<Integer>
{
private static final Log LOG = LogFactory.getLog(ExtractText.class);
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
Mon Dec 28 13:38:26 2020
@@ -35,7 +35,7 @@ import picocli.CommandLine.Parameters;
/**
* Create a PDF document from images.
*/
-@Command(name = "ImageToPDF", description = "Create a PDF document from
images.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "imagetopdf", description = "Creates a PDF document from
images", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class ImageToPDF implements Callable<Integer>
{
private PDRectangle mediaBox = PDRectangle.LETTER;
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java Mon
Dec 28 13:38:26 2020
@@ -37,7 +37,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "ImportFDF", description = "Import AcroForm form data from
FDF.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "importfdf", description = "Imports AcroForm form data from
FDF", versionProvider = Version.class, mixinStandardHelpOptions = true)
public class ImportFDF implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
Mon Dec 28 13:38:26 2020
@@ -37,7 +37,7 @@ import java.io.PrintStream;
*
* @author Ben Litchfield
*/
-@Command(name = "ImportFDF", description = "Import AcroForm form data from
XFDF.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "importxfdf", description = "Imports AcroForm form data from
XFDF", versionProvider = Version.class, mixinStandardHelpOptions = true)
public class ImportXFDF
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/OverlayPDF.java
Mon Dec 28 13:38:26 2020
@@ -39,7 +39,7 @@ import picocli.CommandLine.Parameters;
* Based on code contributed by Balazs Jerk.
*
*/
-@Command(name = "OverlayPDF", description = "Add an overlay to an existing PDF
document.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "overlaypdf", description = "Adds an overlay to a PDF
document", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class OverlayPDF implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFBox.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFBox.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFBox.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFBox.java Mon
Dec 28 13:38:26 2020
@@ -27,10 +27,10 @@ import picocli.CommandLine.Spec;
* Simple wrapper around all the command line utilities included in PDFBox.
* Used as the main class in the runnable standalone PDFBox jar.
*/
-@Command(name="PDFBox",
- customSynopsis = "PDFBox [COMMAND] [OPTIONS]",
+@Command(name="pdfbox",
+ customSynopsis = "pdfbox [COMMAND] [OPTIONS]",
footer = {
- "See 'PDFBox help <command>' to read about a specific subcommand."
+ "See 'pdfbox help <command>' to read about a specific subcommand"
},
subcommands = {
PDFDebugger.class,
@@ -63,7 +63,7 @@ public final class PDFBox implements Run
// suppress the Dock icon on OS X
System.setProperty("apple.awt.UIElement", "true");
- new CommandLine(new PDFBox()).execute(args);
+ new CommandLine(new
PDFBox()).setSubcommandsCaseInsensitive(true).execute(args);
}
@Override
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFMerger.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFMerger.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFMerger.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFMerger.java Mon
Dec 28 13:38:26 2020
@@ -34,7 +34,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "PDFMerger", description = "Merge multiple PDFs into one.",
versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "pdfmerger", description = "Merges multiple PDF documents into
one", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class PDFMerger implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFSplit.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFSplit.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFSplit.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFSplit.java Mon
Dec 28 13:38:26 2020
@@ -39,7 +39,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "PDFSplit", description = "Split a PDF into number of new
documents.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "pdfsplit", description = "Splits a PDF document into number
of new documents", versionProvider = Version.class, mixinStandardHelpOptions =
true)
public final class PDFSplit implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java
Mon Dec 28 13:38:26 2020
@@ -46,7 +46,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "PDFToImage", description = "Convert a PDF document to
image(s).", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "pdftoimage", description = "Converts a PDF document to
image(s)", versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class PDFToImage implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PrintPDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PrintPDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PrintPDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/PrintPDF.java Mon
Dec 28 13:38:26 2020
@@ -42,7 +42,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "PrintPDF", description = "Print a PDF.", versionProvider =
Version.class, mixinStandardHelpOptions = true)
+@Command(name = "printpdf", description = "Prints a PDF document",
versionProvider = Version.class, mixinStandardHelpOptions = true)
public final class PrintPDF implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java Mon
Dec 28 13:38:26 2020
@@ -43,7 +43,7 @@ import picocli.CommandLine.Parameters;
*
* @author Ben Litchfield
*/
-@Command(name = "TextToPDF", description = "Create a PDF document from a text
file.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(name = "texttopdf", description = "Creates a PDF document from text",
versionProvider = Version.class, mixinStandardHelpOptions = true)
public class TextToPDF implements Callable<Integer>
{
/**
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Version.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Version.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Version.java
(original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Version.java Mon
Dec 28 13:38:26 2020
@@ -30,7 +30,7 @@ import picocli.CommandLine.Model.Command
*
* @author Ben Litchfield
*/
-@Command(name = "Version", description = "Get the version of PDFBox.")
+@Command(name = "version", description = "Gets the version of PDFBox")
final class Version implements Callable<Integer>, IVersionProvider
{
// Expected for CLI app to write to System.out/Sytem.err
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java?rev=1884867&r1=1884866&r2=1884867&view=diff
==============================================================================
---
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
(original)
+++
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
Mon Dec 28 13:38:26 2020
@@ -41,7 +41,7 @@ import picocli.CommandLine.Parameters;
*
* @author Michael Traut
*/
-@Command(name = "WriteDecodedDoc", description = "Load document and write with
all streams decoded.", versionProvider = Version.class,
mixinStandardHelpOptions = true)
+@Command(name = "writedecodeddoc", description = "Writes a PDF document with
all streams decoded", versionProvider = Version.class, mixinStandardHelpOptions
= true)
public class WriteDecodedDoc implements Callable<Integer>
{
// Expected for CLI app to write to System.out/Sytem.err
