]> nmode's Git Repositories - signal-cli/blobdiff - man/signal-cli.1.adoc
Change meaning of -v flag from --version to --verbose
[signal-cli] / man / signal-cli.1.adoc
index 7d1aa6f1cb3903e7a12658f10217ab5a4863c09d..fabca9d4f87d82b94a4713c07f24da0e2e64d68a 100644 (file)
@@ -31,10 +31,10 @@ In daemon mode messages are continuously received.
 *-h*, *--help*::
 Show help message and quit.
 
-*-v*, *--version*::
+*--version*::
 Print the version and quit.
 
-*--verbose*::
+*-v*, *--verbose*::
 Raise log level and include lib signal logs.
 
 *--log-file* LOG_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.
@@ -231,6 +231,9 @@ Read the message from standard input.
 
 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 Add one or more files as attachment.
+Can be either a file path or a data URI. Data URI encoded attachments must follow the RFC 2397.
+Additionally a file name can be added:
+e.g.: `data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>`
 
 *--sticker* STICKER::
 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
@@ -253,9 +256,36 @@ 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.
 
+=== sendPaymentNotification
+
+Send a payment notification.
+
+RECIPIENT::
+Specify the recipient’s phone number.
+
+*--receipt* RECEIPT::
+The base64 encoded receipt blob.
+
+*--note* NOTE::
+Specify a note for the payment notification.
+
 === sendReaction
 
 Send reaction to a previously received or sent message.
@@ -330,6 +360,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.
@@ -480,6 +513,9 @@ Path to the new avatar image file.
 *--remove-avatar*::
 Remove the avatar
 
+*--mobile-coin-address*::
+New MobileCoin address (Base64 encoded public address)
+
 === updateContact
 
 Update the info associated to a number on our contact list.
@@ -489,8 +525,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).
@@ -531,12 +570,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
 
@@ -598,6 +637,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.