Extend logging in RecipientStore

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index f2a1a960d78981070b55c1373a12fd5c6633a550..c04651121e94729f363101d2b173854f70342156 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -11,7 +11,7 @@ signal-cli - A commandline and dbus interface for the Signal messenger
 
 == Synopsis
 
 
 == Synopsis
 

-*signal-cli* [--config CONFIG] [-h | -v | -u USERNAME | --dbus | --dbus-system] command [command-options]
+*signal-cli* [--config CONFIG] [-h | -v | -a ACCOUNT | --dbus | --dbus-system] command [command-options]

 
 == Description
 
 
 == Description
 


@@ -40,7 +40,7 @@ Set the path, where to store the config.
 Make sure you have full read/write access to the given directory.
 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
 
 Make sure you have full read/write access to the given directory.
 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
 

-*-u* USERNAME, *--username* USERNAME::
+*-a* ACCOUNT, *--account* ACCOUNT::

 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.
 
 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.
 


@@ -144,7 +144,7 @@ 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::


@@ -158,7 +158,7 @@ Only works, if this is the master 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=...")
+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
 Make sure to enclose it in quotation marks for shells.
 
 === listDevices


@@ -205,6 +205,24 @@ Send the message to self without notification.
 *-e*, *--end-session*::
 Clear session state and send end session message.
 
 *-e*, *--end-session*::
 Clear session state and send end session message.
 

+*--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.
+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.
+
+*--quote-author*::
+Specify the number of the author of the original message.
+
+*--quote-message*::
+Specify the message of the original message.
+
+*--quote-mention*::
+Specify the mentions of the original message (same format as `--mention`).
+

 === sendReaction
 
 Send reaction to a previously received or sent message.
 === sendReaction
 
 Send reaction to a previously received or sent message.


@@ -424,6 +442,15 @@ Specify the new name for this contact.
 Set expiration time of messages (seconds).
 To disable expiration set expiration time to 0.
 
 Set expiration time of messages (seconds).
 To disable expiration set expiration time to 0.
 

+=== removeContact
+Remove the info of a given contact
+
+NUMBER::
+Specify the contact phone number.
+
+*--forget*::
+Delete all data associated with this contact, including identity keys and sessions.
+

 === block
 
 Block the given contacts or groups (no messages will be received).
 === block
 
 Block the given contacts or groups (no messages will be received).


@@ -495,7 +522,7 @@ 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.
 === 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
+If no `-a` account is given, all local accounts will be exported as separate dbus

 objects under the same bus name.
 
 *--system*::
 objects under the same bus name.
 
 *--system*::


@@ -506,37 +533,37 @@ Don’t download attachments of received messages.
 == Examples
 
 Register a number (with SMS verification)::
 == Examples
 
 Register a number (with SMS verification)::

-signal-cli -u USERNAME register
+signal-cli -a ACCOUNT register

 
 Verify the number using the code received via SMS or voice::
 
 Verify the number using the code received via SMS or voice::

-signal-cli -u USERNAME verify CODE
+signal-cli -a ACCOUNT verify CODE

 
 Send a message to one or more recipients::
 
 Send a message to one or more recipients::

-signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
+signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]

 
 Pipe the message content from another process::
 
 Pipe the message content from another process::

-uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
+uname -a | signal-cli -a ACCOUNT send [RECIPIENT [RECIPIENT ...]]

 
 Create a group::
 
 Create a group::

-signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
+signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]

 
 Add member to a group::
 
 Add member to a group::

-signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
+signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"

 
 Accept a group invitation::
 
 Accept a group invitation::

-signal-cli -u USERNAME updateGroup -g GROUP_ID
+signal-cli -a ACCOUNT updateGroup -g GROUP_ID

 
 Leave a group::
 
 Leave a group::

-signal-cli -u USERNAME quitGroup -g GROUP_ID
+signal-cli -a ACCOUNT quitGroup -g GROUP_ID

 
 Send a message to a group::
 
 Send a message to a group::

-signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
+signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID

 
 Trust new key, after having verified it::
 
 Trust new key, after having verified it::

-signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
+signal-cli -a ACCOUNT trust -v SAFETY_NUMBER NUMBER

 
 Trust new key, without having verified it. Only use this if you don't care about security::
 
 Trust new key, without having verified it. Only use this if you don't care about security::

-signal-cli -u USERNAME trust -a NUMBER
+signal-cli -a ACCOUNT trust -a NUMBER

 
 == Exit codes
 * *1*: Error is probably caused and fixable by the user
 
 == Exit codes
 * *1*: Error is probably caused and fixable by the user