Reformat man doc and clarify help text

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index ba0d72d49fad79d316c4f3ffa2144c7b1243f452..350702701b6148ed75e17d48a157bc89d180e81e 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -100,7 +100,8 @@ Remove the registration lock pin.
 === link
 
 Link to an existing device, instead of registering a new number.
 === link
 
 Link to an existing device, instead of registering a new number.

-This shows a "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can just use this URI. If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app.
+This shows a "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can just use this URI.
+If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app.

 
 *-n* NAME, *--name* NAME::
 Optionally specify a name to describe this new device.
 
 *-n* NAME, *--name* NAME::
 Optionally specify a name to describe this new device.


@@ -112,7 +113,8 @@ Link another device to this device.
 Only works, if this is the master device.
 
 *--uri* URI::
 Only works, if this is the master device.
 
 *--uri* URI::

-Specify the uri contained in the QR code shown by the new device. You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid=....."
+Specify the uri contained in the QR code shown by the new device.
+You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid=....."

 
 === listDevices
 
 
 === listDevices
 


@@ -129,7 +131,9 @@ Use listDevices to see the deviceIds.
 
 === getUserStatus
 
 
 === getUserStatus
 

-Uses a list of phone numbers to determine the statuses of those users. Shows if they are registered on the Signal Servers or not. In json mode this is outputted as a list of objects.
+Uses a list of phone numbers to determine the statuses of those users.
+Shows if they are registered on the Signal Servers or not.
+In json mode this is outputted as a list of objects.

 
 [NUMBER [NUMBER ...]]::
 One or more numbers to check.
 
 [NUMBER [NUMBER ...]]::
 One or more numbers to check.


@@ -178,7 +182,8 @@ Remove a reaction.
 === receive
 
 Query the server for new messages.
 === receive
 
 Query the server for new messages.

-New messages are printed on standard output and attachments are downloaded to the config directory. In json mode this is outputted as one json object per line.
+New messages are printed on standard output and attachments are downloaded to the config directory.
+In json mode this is outputted as one json object per line.

 
 *-t* TIMEOUT, *--timeout* TIMEOUT::
 Number of seconds to wait for new messages (negative values disable timeout).
 
 *-t* TIMEOUT, *--timeout* TIMEOUT::
 Number of seconds to wait for new messages (negative values disable timeout).


@@ -221,7 +226,8 @@ Specify the recipient group ID in base64 encoding.
 
 === listGroups
 
 
 === listGroups
 

-Show a list of known groups and related information. In json mode this is outputted as an list of objects and is always in detailed mode.
+Show a list of known groups and related information.
+In json mode this is outputted as an list of objects and is always in detailed mode.

 
 *-d*, *--detailed*::
 Include the list of members of each group and the group invite link.
 
 *-d*, *--detailed*::
 Include the list of members of each group and the group invite link.

diff --git a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
index 8078de107d8852d593281087fb1e96a9c22e0715..cd347137d181fb8c3824deadfdd234c447aed7e2 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
+++ b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
@@ -27,7 +27,7 @@ public class GetUserStatusCommand implements LocalCommand {
         subparser.addArgument("number").help("Phone number").nargs("+");
         subparser.help("Check if the specified phone number/s have been registered");
         subparser.addArgument("--json")
         subparser.addArgument("number").help("Phone number").nargs("+");
         subparser.help("Check if the specified phone number/s have been registered");
         subparser.addArgument("--json")

-                .help("WARNING: This parameter is now deprecated! Please use the \"output\" option instead.\n\nOutput received messages in json format, one json object per line.")
+                .help("WARNING: This parameter is now deprecated! Please use the global \"--output=json\" option instead.\n\nOutput received messages in json format, one json object per line.")

                 .action(Arguments.storeTrue());
     }
 
                 .action(Arguments.storeTrue());
     }
 


@@ -37,11 +37,11 @@ public class GetUserStatusCommand implements LocalCommand {
         ObjectMapper jsonProcessor = new ObjectMapper();
         jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
 
         ObjectMapper jsonProcessor = new ObjectMapper();
         jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
 

-        boolean inJson = ns.getString("output").equals("json");
+        boolean inJson = ns.getString("output").equals("json") || ns.getBoolean("json");

 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {
 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {

-            logger.warn("\"--json\" option has been deprecated, please use \"output\" instead.");
+            logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead.");

         }
 
         // Get a map of registration statuses
         }
 
         // Get a map of registration statuses

diff --git a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
index f7a491570722cf60dc63553f22e192533d409a1a..4d4fdc10f33fd3644053b03ddda16dcd7dc97a95 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
+++ b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
@@ -18,11 +18,9 @@ import org.asamk.signal.manager.Manager;
 import org.asamk.signal.util.DateUtils;
 import org.freedesktop.dbus.connections.impl.DBusConnection;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.asamk.signal.util.DateUtils;
 import org.freedesktop.dbus.connections.impl.DBusConnection;
 import org.freedesktop.dbus.exceptions.DBusException;

-import org.whispersystems.util.Base64;
-
-// TODO delete later when "json" variable is removed

 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

+import org.whispersystems.util.Base64;

 
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;


@@ -43,7 +41,7 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--json")
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--json")

-                .help("WARNING: This parameter is now deprecated! Please use the \"output\" option instead.\n\nOutput received messages in json format, one json object per line.")
+                .help("WARNING: This parameter is now deprecated! Please use the global \"--output=json\" option instead.\n\nOutput received messages in json format, one json object per line.")

                 .action(Arguments.storeTrue());
     }
 
                 .action(Arguments.storeTrue());
     }
 


@@ -54,7 +52,7 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {
 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {

-            logger.warn("\"--json\" option has been deprecated, please use \"output\" instead.");
+            logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead.");

         }
 
         if (inJson) {
         }
 
         if (inJson) {


@@ -165,7 +163,7 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {
 
         // TODO delete later when "json" variable is removed
         if (ns.getBoolean("json")) {

-            logger.warn("\"--json\" option has been deprecated, please use \"output\" instead.");
+            logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead.");

         }
 
         double timeout = 5;
         }
 
         double timeout = 5;