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 c04651121e94729f363101d2b173854f70342156..ad510dfe994eaff53cc5b80917fb8adb7cb61a17 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -1,13 +1,15 @@
 /////
 vim:set ts=4 sw=4 tw=82 noet:
 /////
 /////
 vim:set ts=4 sw=4 tw=82 noet:
 /////

+

 :quotes.~:
 
 = signal-cli (1)
 :quotes.~:
 
 = signal-cli (1)

+:doctype: manpage

 
 == Name
 
 
 == Name
 

-signal-cli - A commandline and dbus interface for the Signal messenger
+signal-cli - A commandline interface for the Signal messenger

 
 == Synopsis
 
 
 == Synopsis
 


@@ -19,22 +21,30 @@ signal-cli is a commandline interface for libsignal-service-java.
 It supports registering, verifying, sending and receiving messages.
 For registering you need a phone number where you can receive SMS or incoming calls.
 signal-cli was primarily developed to be used on servers to notify admins of important events.
 It supports registering, verifying, sending and receiving messages.
 For registering you need a phone number where you can receive SMS or incoming calls.
 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 this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.

 
 For some functionality the Signal protocol requires that all messages have been received from the server.
 
 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.
+The `receive` command should be regularly executed.
+In daemon mode messages are continuously received.

 
 == Options
 
 *-h*, *--help*::
 Show help message and quit.
 
 
 == Options
 
 *-h*, *--help*::
 Show help message and quit.
 

-*-v*, *--version*::
+*--version*::

 Print the version and quit.
 
 Print the version and quit.
 

-*--verbose*::
+*-v*, *--verbose*::

 Raise log level and include lib signal logs.
 
 Raise log level and include lib signal logs.
 

+*--log-file* LOG_FILE::
+Write log output to the given file.
+If `--verbose` is also given, the detailed logs will only be written to the log file.
+
+*--scrub-log*::
+Scrub possibly sensitive information from the log, like phone numbers and UUIDs.
+

 *--config* CONFIG::
 Set the path, where to store the config.
 Make sure you have full read/write access to the given directory.
 *--config* CONFIG::
 Set the path, where to store the config.
 Make sure you have full read/write access to the given directory.


@@ -46,8 +56,13 @@ The phone number must include the country calling code, i.e. the number must sta
 
 This flag must not be given for the `link` command.
 It is optional for the `daemon` command.
 
 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.
+For all other commands it is only optional if there is exactly one local user in the config directory.
+
+*--service-environment* ENVIRONMENT::
+Choose the server environment to use:
+
+- `live` (default)
+- `staging`

 
 *--dbus*::
 Make request via user dbus.
 
 *--dbus*::
 Make request via user dbus.


@@ -56,15 +71,18 @@ Make request via user dbus.
 Make request via system dbus.
 
 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
 Make request via system dbus.
 
 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::

-Specify if you want commands to output in either "plain-text" mode or in "json". Defaults to "plain-text"
+Specify if you want commands to output in either "plain-text" mode or in "json".
+Defaults to "plain-text"

 
 *--trust-new-identities* TRUST-MODE::
 Choose when to trust new identities:
 
 *--trust-new-identities* TRUST-MODE::
 Choose when to trust new identities:

-- `on-first-use` (default): Trust the first seen identity key from new users,
-  changed keys must be verified manually
+- `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually

 - `always`: Trust any new identity key without verification
 - `never`: Don't trust any unknown identity key, every key must be verified manually
 
 - `always`: Trust any new identity key without verification
 - `never`: Don't trust any unknown identity key, every key must be verified manually
 

+*--disable-send-log*::
+Disable message send log (for resending messages that recipient couldn't decrypt).
+

 == Commands
 
 === register
 == Commands
 
 === register


@@ -72,14 +90,18 @@ Choose when to trust new identities:
 Register a phone number with SMS or voice verification.
 Use the verify command to complete the verification.
 
 Register a phone number with SMS or voice verification.
 Use the verify command to complete the verification.
 

+If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification.
+By default the unregister command just deactivates the account, in which case it can be reactivated without sms verification if the local data is still available.
+If the account was deleted (with --delete-account) it cannot be reactivated.
+

 *-v*, *--voice*::
 The verification should be done over voice, not SMS.
 
 *--captcha*::
 The captcha token, required if registration failed with a captcha required error.
 To get the token, go to https://signalcaptchas.org/registration/generate.html
 *-v*, *--voice*::
 The verification should be done over voice, not SMS.
 
 *--captcha*::
 The captcha token, required if registration failed with a captcha required error.
 To get the token, go to https://signalcaptchas.org/registration/generate.html

-Check the developer tools for a redirect starting with signalcaptcha://
-Everything after signalcaptcha:// is the captcha token.
+For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
+Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.

 
 === verify
 
 
 === verify
 


@@ -95,28 +117,39 @@ Only required if a PIN was set.
 === unregister
 
 Disable push support for this device, i.e. this device won't receive any more messages.
 === 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.
 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*::

-Delete account completely from server. Cannot be undone without loss. You will
-have to be readded to each group.
+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!
 
 
 CAUTION: Only delete your account if you won't use this number again!
 

+=== deleteLocalAccountData
+
+Delete all local data for this account.
+Data should only be deleted if the account is unregistered.
+
+CAUTION: This cannot be undone.
+
+*--ignore-registered*::
+Delete the account data even though the account is still registered on the Signal servers.
+

 === updateAccount
 
 Update the account attributes on the signal server.
 Can fix problems with receiving messages.
 
 *-n* NAME, *--device-name* NAME::
 === updateAccount
 
 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.
 
 === 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.
 
 *--read-receipts* {true,false}::
 Indicates if Signal should send read receipts.


@@ -144,7 +177,8 @@ Remove the registration lock pin.
 === link
 
 Link to an existing device, instead of registering a new number.
 === link
 
 Link to an existing device, instead of registering a new number.

-This shows a "sgnl://linkdevice?uuid=..." URI. If you want to connect to another signal-cli instance, you can just use this URI.
+This shows a "sgnl://linkdevice?uuid=..." 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::
 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::


@@ -154,12 +188,11 @@ By default "cli" will be used.
 === addDevice
 
 Link another device to this device.
 === 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.
 
 *--uri* URI::
 Specify the uri contained in the QR code shown by the new device.

-You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...")
-Make sure to enclose it in quotation marks for shells.
+You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.

 
 === listDevices
 
 
 === listDevices
 


@@ -168,7 +201,7 @@ Show a list of linked devices.
 === removeDevice
 
 Remove a linked device.
 === 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.
 
 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
 Specify the device you want to remove.


@@ -190,29 +223,36 @@ Send a message to another user or group.
 RECIPIENT::
 Specify the recipients’ phone number.
 
 RECIPIENT::
 Specify the recipients’ phone number.
 

+*--note-to-self*::
+Send the message to self without notification.
+

 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
 *-m* MESSAGE, *--message* MESSAGE::
 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
 *-m* MESSAGE, *--message* MESSAGE::

-Specify the message, if missing, standard input is used.
+Specify the message.
+
+*--message-from-stdin*::
+Read the message from standard input.

 
 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 Add one or more files as attachment.
 
 *-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>`

 
 

-*--note-to-self*::
-Send the message to self without notification.
-
-*-e*, *--end-session*::
-Clear session state and send end session message.
+*--sticker* STICKER::
+Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
+Shouldn't be used together with `-m` as the official clients don't support this.
+e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`

 
 *--mention*::
 
 *--mention*::

-Mention another group member (syntax: start:length:recipientNumber)
-In the apps the mention replaces part of the message text, which is specified by the start and length values.
+Mention another group member (syntax: start:length:recipientNumber) In the apps the mention replaces part of the message text, which is specified by the start and length values.

 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 
 *--quote-timestamp*::
 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 
 *--quote-timestamp*::

-Specify the timestamp of a previous message with the recipient or group to add a
-quote to the new message.
+Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.

 
 *--quote-author*::
 Specify the number of the author of the original message.
 
 *--quote-author*::
 Specify the number of the author of the original message.


@@ -223,6 +263,41 @@ Specify the message of the original message.
 *--quote-mention*::
 Specify the mentions of the original message (same format as `--mention`).
 
 *--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).
+
+*--story-timestamp*::
+Specify the timestamp of a story to reply to.
+
+*--story-author*::
+Specify the number of the author of the story.
+
+*-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.
 === sendReaction
 
 Send reaction to a previously received or sent message.


@@ -245,6 +320,9 @@ Specify the timestamp of the message to which to react.
 *-r*, *--remove*::
 Remove a reaction.
 
 *-r*, *--remove*::
 Remove a reaction.
 

+*--story*::
+React to a story instead of a normal message
+

 === sendReceipt
 
 Send a read or viewed receipt to a previously received message.
 === sendReceipt
 
 Send a read or viewed receipt to a previously received message.


@@ -294,9 +372,20 @@ 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).
 Default is 5 seconds.
 *-t* TIMEOUT, *--timeout* TIMEOUT::
 Number of seconds to wait for new messages (negative values disable timeout).
 Default is 5 seconds.

+
+*--max-messages*::
+Maximum number of messages to receive, before returning.
+

 *--ignore-attachments*::
 Don’t download attachments of received messages.
 
 *--ignore-attachments*::
 Don’t download attachments of received messages.
 

+*--ignore-stories*::
+Don’t receive story messages from the server.
+
+
+*--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.
 === joinGroup
 
 Join a group via an invitation link.


@@ -334,6 +423,13 @@ Specify one or more members to make a group admin
 *--remove-admin* [MEMBER [MEMBER ...]]::
 Specify one or more members to remove group admin privileges
 
 *--remove-admin* [MEMBER [MEMBER ...]]::
 Specify one or more members to remove group admin privileges
 

+*--ban* [MEMBER [MEMBER ...]]::
+Specify one or more members to ban from joining the group.
+Banned members cannot join or request to join via a group link.
+
+*--unban* [MEMBER [MEMBER ...]]::
+Specify one or more members to remove from the ban list
+

 *--reset-link*::
 Reset group link and create new link password
 
 *--reset-link*::
 Reset group link and create new link password
 


@@ -373,9 +469,25 @@ In json mode this is outputted as an list of objects and is always in detailed m
 *-d*, *--detailed*::
 Include the list of members of each group and the group invite link.
 
 *-d*, *--detailed*::
 Include the list of members of each group and the group invite link.
 

+*-g*, *--group-id*::
+Filter the group list by one or more group IDs.
+

 === listContacts
 
 === listContacts
 

-Show a list of known contacts with names.
+Show a list of known contacts with names and profiles.
+When a specific recipient is given, its profile will be refreshed.
+
+RECIPIENT::
+Specify the recipients’ phone number.
+
+*-a*, *--all-recipients*::
+Include all known recipients, not only contacts.
+
+*--blocked*::
+Specify if only blocked or unblocked contacts should be shown (default: all contacts)
+
+*--name*::
+Find contacts with the given contact or profile name.

 
 === listIdentities
 
 
 === listIdentities
 


@@ -398,15 +510,13 @@ Trust all known keys of this user, only use this for testing.
 
 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 Specify the safety number of the key, only use this option if you have verified the safety number.
 
 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 Specify the safety number of the key, only use this option if you have verified the safety number.

-Can be either the plain text numbers shown in the app or the bytes from the QR-code,
-encoded as base64.
+Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.

 
 === updateProfile
 
 Update the profile information shown to message recipients.
 The profile is stored encrypted on the Signal servers.
 
 === updateProfile
 
 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 and included
-in every group.
+The decryption key is sent with every outgoing messages to contacts and included in every group.

 
 *--given-name* NAME, *--name* NAME::
 New (given) name.
 
 *--given-name* NAME, *--name* NAME::
 New (given) name.


@@ -426,6 +536,9 @@ Path to the new avatar image file.
 *--remove-avatar*::
 Remove the avatar
 
 *--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.
 === updateContact
 
 Update the info associated to a number on our contact list.


@@ -435,14 +548,18 @@ If the contact doesn't exist yet, it will be added.
 NUMBER::
 Specify the contact phone number.
 
 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).
 To disable expiration set expiration time to 0.
 
 === removeContact
 
 *-e*, *--expiration* EXPIRATION_SECONDS::
 Set expiration time of messages (seconds).
 To disable expiration set expiration time to 0.
 
 === removeContact

+

 Remove the info of a given contact
 
 NUMBER::
 Remove the info of a given contact
 
 NUMBER::


@@ -476,18 +593,18 @@ 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.
 === 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
 
 
 === 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
 
 
 === uploadStickerPack
 

-Upload a new sticker pack, consisting of a manifest file and the sticker images.
+Upload a new sticker pack, consisting of a manifest file and the sticker images. +

 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )

+

 - Static stickers in PNG or WebP format
 - Animated stickers in APNG format,
 - Maximum file size for a sticker file is 300KiB
 - Static stickers in PNG or WebP format
 - Animated stickers in APNG format,
 - Maximum file size for a sticker file is 300KiB


@@ -519,17 +636,63 @@ The required manifest.json has the following format:
 PATH::
 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 
 PATH::
 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 

+=== getAttachment
+
+Gets the raw data for a specified attachment.
+This is done using the ID of the attachment the recipient or group ID.
+The attachment data is returned as a Base64 String.
+
+*--id* [ID]::
+The ID of the attachment as given in the attachment list of the message.
+
+*--recipient* [RECIPIENT]::
+Specify the number which sent the attachment.
+Referred to generally as recipient.
+
+*-g* [GROUP], *--group-id* [GROUP]::
+Alternatively, specify the group IDs for which to get the attachment.
+

 === daemon
 
 === daemon
 

-signal-cli can run in daemon mode and provides an experimental dbus interface.
-If no `-a` account is given, all local accounts will be exported as separate dbus
-objects under the same bus name.
+signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC interface.
+If no `-a` account is given, all local accounts will be exported as separate dbus objects under the same bus name.
+
+*--dbus*::
+Export DBus interface on user bus. +
+See **signal-cli-dbus**(5) for info on the dbus interface.
+
+*--dbus-system*::
+Export DBus interface on system bus. +
+See **signal-cli-dbus**(5) for info on the dbus interface.
+
+*--socket [SOCKET]*::
+Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
+
+*--tcp [HOST:PORT]*::
+Export a JSON-RPC interface on a TCP socket (default localhost:7583). +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
+
+*--http [HOST:PORT]*::
+Expose a JSON-RPC interface as http endpoint (default localhost:8080).
+The JSON-RPC endpoint is `/api/v1/rpc`. +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.

 
 

-*--system*::
-Use DBus system bus instead of user bus.

 *--ignore-attachments*::
 Don’t download attachments of received messages.
 
 *--ignore-attachments*::
 Don’t download attachments of received messages.
 

+*--ignore-stories*::
+Don’t receive story messages from the server.
+
+*--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.
+
+*--receive-mode*::
+Specify when to start receiving messages (on-start, on-connection, manual)
+

 == Examples
 
 Register a number (with SMS verification)::
 == Examples
 
 Register a number (with SMS verification)::


@@ -542,7 +705,7 @@ Send a message to one or more recipients::
 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 
 Pipe the message content from another process::
 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 
 Pipe the message content from another process::

-uname -a | signal-cli -a ACCOUNT send [RECIPIENT [RECIPIENT ...]]
+uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]

 
 Create a group::
 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 
 Create a group::
 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]


@@ -566,6 +729,7 @@ Trust new key, without having verified it. Only use this if you don't care about
 signal-cli -a ACCOUNT trust -a NUMBER
 
 == Exit codes
 signal-cli -a ACCOUNT trust -a NUMBER
 
 == Exit codes

+

 * *1*: Error is probably caused and fixable by the user
 * *2*: Some unexpected error
 * *3*: Server or IO error
 * *1*: Error is probably caused and fixable by the user
 * *2*: Some unexpected error
 * *3*: Server or IO error