Prevent NPE during migration, when profile key is null

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index bd51033fada4fb6fd420217bec7e1a1c817ce71a..7c2e9ea601236c31e5009873034d8ee2bc5d473a 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -44,6 +44,11 @@ Make sure you have full read/write access to the given directory.
 Specify your phone number, that will be your identifier.
 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
 
+This flag must not be given for the `link` command.
+It is optional for the `daemon` command.
+For all other commands it is only optional if there is exactly one local user in the
+config directory.
+
 *--dbus*::
 Make request via user dbus.
 
@@ -87,6 +92,12 @@ If this is the master device, other users can't send messages to this number any
 Use "updateAccount" to undo this.
 To remove a linked device, use "removeDevice" from the master device.
 
+*--delete-account*::
+Delete account completely from server. Cannot be undone without loss. You will
+have to be readded to each group.
+
+CAUTION: Only delete your account if you won't use this number again!
+
 === updateAccount
 
 Update the account attributes on the signal server.
@@ -160,6 +171,9 @@ Specify the message, if missing, standard input is used.
 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 Add one or more files as attachment.
 
+*--note-to-self*::
+Send the message to self without notification.
+
 *-e*, *--endsession*::
 Clear session state and send end session message.
 
@@ -185,6 +199,19 @@ Specify the timestamp of the message to which to react.
 *-r*, *--remove*::
 Remove a reaction.
 
+=== remoteDelete
+
+Remotely delete a previously sent message.
+
+RECIPIENT::
+Specify the recipients’ phone number.
+
+*-g* GROUP, *--group* GROUP::
+Specify the recipient group ID in base64 encoding.
+
+*-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
+Specify the timestamp of the message to delete.
+
 === receive
 
 Query the server for new messages.
@@ -200,8 +227,6 @@ 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/#`)
@@ -210,8 +235,6 @@ 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.
@@ -266,18 +289,28 @@ Specify the safety number of the key, only use this option if you have verified
 
 === updateProfile
 
-Update the name and avatar image visible by message recipients for the current users.
+Update the profile information shown to message recipients.
 The profile is stored encrypted on the Signal servers.
-The decryption key is sent with every outgoing messages to contacts.
+The decryption key is sent with every outgoing messages to contacts and included
+in every group.
+
+*--given-name* NAME, *--name* NAME::
+New (given) name.
 
-*--name*::
-New name visible by message recipients.
+*--family-name* FAMILY_NAME::
+New family name.
 
-*--avatar*::
-Path to the new avatar visible by message recipients.
+*--about* ABOUT_TEXT::
+New profile status text.
+
+*--about-emoji* EMOJI::
+New profile status emoji.
+
+*--avatar* AVATAR_FILE::
+Path to the new avatar image file.
 
 *--remove-avatar*::
-Remove the avatar visible by message recipients.
+Remove the avatar
 
 === updateContact
 
@@ -322,6 +355,12 @@ Specify the group IDs that should be unblocked in base64 encoding.
 Send a synchronization message with the local contacts list to all linked devices.
 This command should only be used if this is the master device.
 
+=== sendSyncRequest
+
+Send a synchronization request message to the master device (for group, contacts, ...).
+The master device will respond with synchronization messages with full contact and
+group lists.
+
 === uploadStickerPack
 
 Upload a new sticker pack, consisting of a manifest file and the stickers in WebP format (maximum size for a sticker file is 100KiB).
@@ -352,6 +391,8 @@ The path of the manifest.json or a zip file containing the sticker pack you wish
 === daemon
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.
+If no `-u` username is given, all local users will be exported as separate dbus
+objects under the same bus name.
 
 *--system*::
 Use DBus system bus instead of user bus.
@@ -390,6 +431,12 @@ signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 Trust new key, without having verified it. Only use this if you don't care about security::
 signal-cli -u USERNAME trust -a NUMBER
 
+== Exit codes
+* *1*: Error is probably caused and fixable by the user
+* *2*: Some unexpected error
+* *3*: Server or IO error
+* *4*: Sending failed due to untrusted key
+
 == Files
 
 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*: