svn commit: r1884847 - in /pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools: Decrypt.java Encrypt.java

[ms...@apache.org]

Author: msahyoun
Date: Sun Dec 27 15:54:03 2020
New Revision: 1884847

URL: http://svn.apache.org/viewvc?rev=1884847&view=rev
Log:
PDFBOX-2602: additional usage information

Modified:
    pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
    pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java

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=1884847&r1=1884846&r2=1884847&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 Sun Dec 27 15:54:03 2020
@@ -38,7 +38,13 @@ import picocli.CommandLine.Parameters;
  *
  * @author  Ben Litchfield
  */
-@Command(name = "Decrypt", description = "Decrypts a PDF file.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(
+    name = "Decrypt",
+    header = "${COMMAND-NAME} - decrypts a PDF file.%n",
+    description = "This will read an encrypted document and decrypt it either using a password or a certificate.",
+    versionProvider = Version.class,
+    mixinStandardHelpOptions = true
+)
 public final class Decrypt 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/Encrypt.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java?rev=1884847&r1=1884846&r2=1884847&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 Sun Dec 27 15:54:03 2020
@@ -46,7 +46,16 @@ import picocli.CommandLine.Parameters;
  *
  * @author  Ben Litchfield
  */
-@Command(name = "Encrypt", description = "Encrypt a PDF file.", versionProvider = Version.class, mixinStandardHelpOptions = true)
+@Command(
+    name = "Encrypt",
+    header = "${COMMAND-NAME} - encrypts a PDF file.%n",
+    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"
+    },
+    versionProvider = Version.class,
+    mixinStandardHelpOptions = true
+)
 public final class Encrypt implements Callable<Integer>
 {
     // Expected for CLI app to write to System.out/Sytem.err
@@ -92,7 +101,7 @@ public final class Encrypt implements Ca
     @Parameters(paramLabel = "inputfile", arity="1", description = "the PDF file to encyrpt.")
     private File infile;
 
-    @Parameters(paramLabel = "outputfile", index = "1", description = "the encrypted PDF file. If left blank the original file will be overwritten.")
+    @Parameters(paramLabel = "outputfile", index = "1", arity="0..1", description = "the encrypted PDF file. If left blank the original file will be overwritten.")
     private File outfile;
 
     private Encrypt()