Update man page

[signal-cli] / man / signal-cli.1.adoc

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index ba0d72d49fad79d316c4f3ffa2144c7b1243f452..bd51033fada4fb6fd420217bec7e1a1c817ce71a 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -21,6 +21,9 @@ For registering you need a phone number where you can receive SMS or incoming ca
 signal-cli was primarily developed to be used on servers to notify admins of important events.
 For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
 
+For some functionality the Signal protocol requires that all messages have been received from the server.
+The `receive` command should be regularly executed. In daemon mode messages are continuously received.
+
 == Options
 
 *-h*, *--help*::
@@ -29,6 +32,9 @@ Show help message and quit.
 *-v*, *--version*::
 Print the version and quit.
 
+*--verbose*::
+Raise log level and include lib signal logs.
+
 *--config* CONFIG::
 Set the path, where to store the config.
 Make sure you have full read/write access to the given directory.
@@ -100,7 +106,8 @@ Remove the registration lock pin.
 === 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.
@@ -112,7 +119,8 @@ Link another device to this device.
 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
 
@@ -129,7 +137,9 @@ Use listDevices to see the deviceIds.
 
 === 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.
@@ -178,7 +188,8 @@ Remove a reaction.
 === 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).
@@ -189,6 +200,8 @@ Don’t download attachments of received messages.
 === joinGroup
 
 Join a group via an invitation link.
+To be able to join a v2 group the account needs to have a profile (can be created
+with the `updateProfile` command)
 
 *--uri*::
 The invitation link URI (starts with `https://signal.group/#`)
@@ -197,6 +210,8 @@ The invitation link URI (starts with `https://signal.group/#`)
 
 Create or update a group.
 If the user is a pending member, this command will accept the group invitation.
+To be able to join or create a v2 group the account needs to have a profile (can
+be created with the `updateProfile` command)
 
 *-g* GROUP, *--group* GROUP::
 Specify the recipient group ID in base64 encoding.
@@ -221,7 +236,8 @@ Specify the recipient group ID in base64 encoding.
 
 === 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.