Adapt code style

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index 712d4976347a0e1ee6add41596eee7ad86cf4f5a..a892a296ffcd7473f06299161f8f541926ae5563 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -23,6 +23,11 @@ For registering you need a phone number where you can receive SMS or incoming ca
 signal-cli was primarily developed to be used on servers to notify admins of important events.
 For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.
 
+Originally the Signal protocol only allowed sending messages to other phone numbers.
+Now with the introduction of phone number privacy, the phone number of a recipient is not always known.
+Only the recipient's ServiceId, ACI/PNI (a special UUID) is known.
+This special identifier can be used instead of the phone number in signal-cli's interface.
+
 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 by default continuously received.
@@ -102,12 +107,15 @@ If the account was deleted (with --delete-account) it cannot be reactivated.
 The verification should be done over voice, not SMS.
 Voice verification only works if an SMS verification has been attempted before.
 
-*--captcha*::
+*--captcha* 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
 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
 After solving the captcha, right-click on the "Open Signal" link and copy the link.
 
+*--reregister*::
+Register even if account is already registered.
+
 === verify
 
 Verify the number using the code received via SMS or voice.
@@ -151,6 +159,14 @@ Can fix problems with receiving messages.
 *-n* NAME, *--device-name* NAME::
 Set a new device name for the primary or linked device
 
+*-u* NAME *--username* NAME::
+Specify a username that can then be used to contact this account.
+This can either be just the nickname (e.g. test) or the complete username with discriminator (e.g. test.000).
+Returns the new username with discriminator and the username link.
+
+*--delete-username*::
+Delete the username associated with this account.
+
 *--unrestricted-unidentified-sender* {true,false}::
 Enable if anyone should be able to send you unidentified sender messages.
 
@@ -238,7 +254,7 @@ Only works, if this is the primary 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=...&pub_key=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
 
 === listDevices
 
@@ -255,13 +271,16 @@ Use listDevices to see the deviceIds.
 
 === getUserStatus
 
-Uses a list of phone numbers to determine the statuses of those users.
+Uses a list of phone numbers or usernames to determine the statuses of those users.
 Shows if they are registered on the Signal Servers or not.
 In json mode this is outputted as a list of objects.
 
-[NUMBER [NUMBER ...]]::
+[RECIPIENT [RECIPIENT ...]]::
 One or more numbers to check.
 
+[--username [USERNAME ...]]::
+One or more usernames to check.
+
 === send
 
 Send a message to another user or group.
@@ -275,6 +294,9 @@ Send the message to self without notification.
 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
+*-u* USERNAME, *--username* USERNAME::
+Specify the recipient username or username link.
+
 *-m* MESSAGE, *--message* MESSAGE::
 Specify the message.
 
@@ -295,10 +317,13 @@ e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
 
 *--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.
+The units of start and length should be UTF-16 code units, NOT Unicode code points.
+For more information, see https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units
 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 
 *--text-style*::
 Style parts of the message text (syntax: start:length:STYLE).
+Like `--mention`, the units are UTF-16 code units.
 Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE
 
 e.g.: `-m "Something BIG!" --text-style "10:3:BOLD"` or for a mixed text style `-m "Something BIG!" --text-style "0:9:ITALIC" "10:3:BOLD"`
@@ -356,6 +381,9 @@ Specify the recipients’ phone number.
 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
+*-u* USERNAME, *--username* USERNAME::
+Specify the recipient username or username link.
+
 *--type* TYPE::
 Type of message request response (accept, delete)
 
@@ -382,6 +410,9 @@ Specify the recipients’ phone number.
 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
+*-u* USERNAME, *--username* USERNAME::
+Specify the recipient username or username link.
+
 *-e* EMOJI, *--emoji* EMOJI::
 Specify the emoji, should be a single unicode grapheme cluster.
 
@@ -434,6 +465,9 @@ Specify the recipients’ phone number.
 *-g* GROUP, *--group-id* GROUP::
 Specify the recipient group ID in base64 encoding.
 
+*-u* USERNAME, *--username* USERNAME::
+Specify the recipient username or username link.
+
 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 Specify the timestamp of the message to delete.
 
@@ -563,6 +597,13 @@ Specify if only blocked or unblocked contacts should be shown (default: all cont
 *--name*::
 Find contacts with the given contact or profile name.
 
+*--detailed*::
+List the contacts with more details.
+If output=json, then this is always set
+
+*--internal*::
+Include internal information that's normally not user visible
+
 === listIdentities
 
 List all known identity keys and their trust status, fingerprint and safety number.