From fb687ee5d196010e5ae931ea18a5eae284c2cb57 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Tue, 22 Dec 2020 23:07:53 +0100
Subject: [PATCH] Improve subcommand descriptions

---
 .../src/main/java/org/pgpainless/sop/commands/Armor.java       | 3 ++-
 .../src/main/java/org/pgpainless/sop/commands/Dearmor.java     | 3 ++-
 .../src/main/java/org/pgpainless/sop/commands/Encrypt.java     | 3 ++-
 .../src/main/java/org/pgpainless/sop/commands/ExtractCert.java | 3 ++-
 .../src/main/java/org/pgpainless/sop/commands/Sign.java        | 3 ++-
 .../src/main/java/org/pgpainless/sop/commands/Verify.java      | 3 ++-
 6 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Armor.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Armor.java
index 7f028401..7ddf047c 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Armor.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Armor.java
@@ -26,7 +26,8 @@ import java.util.Arrays;
 
 import static org.pgpainless.sop.Print.err_ln;
 
-@CommandLine.Command(name = "armor", description = "Add ASCII Armor")
+@CommandLine.Command(name = "armor",
+        description = "Add ASCII Armor to standard input")
 public class Armor implements Runnable {
 
     private static final byte[] BEGIN_ARMOR = "-----BEGIN PGP".getBytes(StandardCharsets.UTF_8);
diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Dearmor.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Dearmor.java
index 9db81bc0..737049bb 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Dearmor.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Dearmor.java
@@ -23,7 +23,8 @@ import java.io.IOException;
 
 import static org.pgpainless.sop.Print.err_ln;
 
-@CommandLine.Command(name = "dearmor", description = "Remove ASCII Armor")
+@CommandLine.Command(name = "dearmor",
+        description = "Remove ASCII Armor from standard input")
 public class Dearmor implements Runnable {
 
     @Override
diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Encrypt.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Encrypt.java
index 07475bf1..ac1a7c89 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Encrypt.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Encrypt.java
@@ -36,7 +36,8 @@ import java.util.Scanner;
 import static org.pgpainless.sop.Print.err_ln;
 import static org.pgpainless.sop.Print.print_ln;
 
-@CommandLine.Command(name = "encrypt", description = "Encrypt a message")
+@CommandLine.Command(name = "encrypt",
+        description = "Encrypt a message from standard input")
 public class Encrypt implements Runnable {
 
     public enum Type {
diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/ExtractCert.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/ExtractCert.java
index 47ae21ce..6814d630 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/ExtractCert.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/ExtractCert.java
@@ -28,7 +28,8 @@ import picocli.CommandLine;
 import static org.pgpainless.sop.Print.err_ln;
 import static org.pgpainless.sop.Print.print_ln;
 
-@CommandLine.Command(name = "extract-cert", description = "Extract a public key certificate from a secret key")
+@CommandLine.Command(name = "extract-cert",
+        description = "Extract a public key certificate from a secret key from standard input")
 public class ExtractCert implements Runnable {
 
     @CommandLine.Option(names = "--no-armor",
diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Sign.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Sign.java
index f83b5447..7984e141 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Sign.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Sign.java
@@ -34,7 +34,8 @@ import java.io.IOException;
 import static org.pgpainless.sop.Print.err_ln;
 import static org.pgpainless.sop.Print.print_ln;
 
-@CommandLine.Command(name = "sign", description = "Create a detached signature")
+@CommandLine.Command(name = "sign",
+        description = "Create a detached signature on the data from standard input")
 public class Sign implements Runnable {
 
     public enum Type {
diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Verify.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Verify.java
index 22c43586..f8ec16aa 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Verify.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/commands/Verify.java
@@ -42,7 +42,8 @@ import java.util.TimeZone;
 import static org.pgpainless.sop.Print.err_ln;
 import static org.pgpainless.sop.Print.print_ln;
 
-@CommandLine.Command(name = "verify", description = "Verify a detached signature")
+@CommandLine.Command(name = "verify",
+        description = "Verify a detached signature over the data from standard input")
 public class Verify implements Runnable {
 
     private static final TimeZone tz = TimeZone.getTimeZone("UTC");