]> nmode's Git Repositories - signal-cli/blobdiff - man/signal-cli.1.adoc
Split given/family name in updateContact command
[signal-cli] / man / signal-cli.1.adoc
index 456c6f1a772442cc12a13e3f683d6fc0bf47d6c2..6258243a5a6387177216556775f8e065a0e6b8db 100644 (file)
@@ -110,9 +110,9 @@ Only required if a PIN was set.
 === unregister
 
 Disable push support for this device, i.e. this device won't receive any more messages.
-If this is the master device, other users can't send messages to this number anymore.
+If this is the primary device, other users can't send messages to this number anymore.
 Use "updateAccount" to undo this.
-To remove a linked device, use "removeDevice" from the master device.
+To remove a linked device, use "removeDevice" from the primary device.
 
 *--delete-account*::
 Delete account completely from server.
@@ -137,12 +137,12 @@ Update the account attributes on the signal server.
 Can fix problems with receiving messages.
 
 *-n* NAME, *--device-name* NAME::
-Set a new device name for the main or linked device
+Set a new device name for the primary or linked device
 
 === updateConfiguration
 
 Update signal configs and sync them to linked devices.
-This command only works on the main devices.
+This command only works on the primary devices.
 
 *--read-receipts* {true,false}::
 Indicates if Signal should send read receipts.
@@ -181,7 +181,7 @@ By default "cli" will be used.
 === addDevice
 
 Link another device to this device.
-Only works, if this is the master device.
+Only works, if this is the primary device.
 
 *--uri* URI::
 Specify the uri contained in the QR code shown by the new device.
@@ -194,7 +194,7 @@ Show a list of linked devices.
 === removeDevice
 
 Remove a linked device.
-Only works, if this is the master device.
+Only works, if this is the primary device.
 
 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
 Specify the device you want to remove.
@@ -253,6 +253,20 @@ Specify the message of the original message.
 *--quote-mention*::
 Specify the mentions of the original message (same format as `--mention`).
 
+*--preview-url*::
+Specify the url for the link preview.
+The same url must also appear in the message body, otherwise the preview won't be
+displayed by the apps.
+
+*--preview-title*::
+Specify the title for the link preview (mandatory).
+
+*--preview-description*::
+Specify the description for the link preview (optional).
+
+*--preview-image*::
+Specify the image file for the link preview (optional).
+
 *-e*, *--end-session*::
 Clear session state and send end session message.
 
@@ -343,6 +357,9 @@ Default is 5 seconds.
 *--ignore-attachments*::
 Don’t download attachments of received messages.
 
+*--send-read-receipts*::
+Send read receipts for all incoming data messages (in addition to the default delivery receipts)
+
 === joinGroup
 
 Join a group via an invitation link.
@@ -505,8 +522,11 @@ If the contact doesn't exist yet, it will be added.
 NUMBER::
 Specify the contact phone number.
 
-*-n*, *--name*::
-Specify the new name for this contact.
+*--given-name* NAME, *--name* NAME::
+New (given) name.
+
+*--family-name* FAMILY_NAME::
+New family name.
 
 *-e*, *--expiration* EXPIRATION_SECONDS::
 Set expiration time of messages (seconds).
@@ -547,12 +567,12 @@ Specify the group IDs that should be unblocked in base64 encoding.
 === sendContacts
 
 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.
+This command should only be used if this is the primary 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.
+Send a synchronization request message to the primary device (for group, contacts, ...).
+The primary device will respond with synchronization messages with full contact and group lists.
 
 === uploadStickerPack
 
@@ -614,6 +634,9 @@ See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
 *--ignore-attachments*::
 Don’t download attachments of received messages.
 
+*--send-read-receipts*::
+Send read receipts for all incoming data messages (in addition to the default delivery receipts)
+
 *--no-receive-stdout*::
 Don’t print received messages to stdout.