webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-08-29 02:20:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reformat man doc and clarify help text

Browse source
This commit is contained in:
AsamK 2021-01-13 17:04:58 +01:00
parent 90f5cd79c9
commit f0834c7a47
3 changed files with 18 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

16
man/signal-cli.1.adoc
View file

@ -100,7 +100,8 @@ Remove the registration lock pin.
=== link === link
Link to an existing device, instead of registering a new number. 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:: *-n* NAME, *--name* NAME::
Optionally specify a name to describe this new device. 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. Only works, if this is the master device.
*--uri* URI:: *--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 ...]]:: [NUMBER [NUMBER ...]]::
One or more numbers to check. One or more numbers to check.
@ -178,7 +182,8 @@ Remove a reaction.
=== receive === receive
Query the server for new messages. 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:: *-t* TIMEOUT, *--timeout* TIMEOUT::
Number of seconds to wait for new messages (negative values disable 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*:: *-d*, *--detailed*::
Include the list of members of each group and the group invite link. Include the list of members of each group and the group invite link.

6
src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
View file

@ -27,7 +27,7 @@ public class GetUserStatusCommand implements LocalCommand {
subparser.addArgument("number").help("Phone number").nargs("+"); subparser.addArgument("number").help("Phone number").nargs("+");
subparser.help("Check if the specified phone number/s have been registered"); subparser.help("Check if the specified phone number/s have been registered");
subparser.addArgument("--json") 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(); ObjectMapper jsonProcessor = new ObjectMapper();
jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET); 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 // TODO delete later when "json" variable is removed
if (ns.getBoolean("json")) { 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

10
src/main/java/org/asamk/signal/commands/ReceiveCommand.java
View file

@ -18,11 +18,9 @@ import org.asamk.signal.manager.Manager;
import org.asamk.signal.util.DateUtils; import org.asamk.signal.util.DateUtils;
import org.freedesktop.dbus.connections.impl.DBusConnection; import org.freedesktop.dbus.connections.impl.DBusConnection;
import org.freedesktop.dbus.exceptions.DBusException; 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.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import org.whispersystems.util.Base64;
import java.io.IOException; import java.io.IOException;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
@ -43,7 +41,7 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
.help("Don’t download attachments of received messages.") .help("Don’t download attachments of received messages.")
.action(Arguments.storeTrue()); .action(Arguments.storeTrue());
subparser.addArgument("--json") 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 // TODO delete later when "json" variable is removed
if (ns.getBoolean("json")) { 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 // TODO delete later when "json" variable is removed
if (ns.getBoolean("json")) { 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;