Fix inspections

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index 56787aee96e6e9cf3d25870c432d2516dcd3d907..2b545fa20d3193ff3053b50b0a857b9275172f7a 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -96,6 +96,7 @@ If the account was deleted (with --delete-account) it cannot be reactivated.
 
 *-v*, *--voice*::
 The verification should be done over voice, not SMS.
+Voice verification only works if an SMS verification has been attempted before.
 
 *--captcha*::
 The captcha token, required if registration failed with a captcha required error.
@@ -146,6 +147,38 @@ Can fix problems with receiving messages.
 *-n* NAME, *--device-name* NAME::
 Set a new device name for the primary or linked device
 
+=== startChangeNumber
+
+Change an account to a new phone number with SMS or voice verification.
+Use the finishChangeNumber command to complete the verification.
+
+NUMBER::
+The new phone number.
+
+*-v*, *--voice*::
+The verification should be done over voice, not SMS.
+Voice verification only works if an SMS verification has been attempted before.
+
+*--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
+Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.
+
+=== finishChangeNumber
+
+Verify the number using the code received via SMS or voice.
+
+NUMBER::
+The new phone number.
+
+*-v*, *--verification-code*::
+The verification code.
+
+*-p* PIN, *--pin* PIN::
+The registration lock PIN, that was set by the user.
+Only required if a PIN was set.
+
 === updateConfiguration
 
 Update signal configs and sync them to linked devices.
@@ -255,7 +288,7 @@ e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 Style parts of the message text (syntax: start:length:STYLE).
 Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE
 
-e.g.: `-m "Something BIG!" --mention "10:3:BOLD"`
+e.g.: `-m "Something BIG!" --text-style "10:3:BOLD"`
 
 *--quote-timestamp*::
 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
@@ -272,6 +305,9 @@ Specify the mentions of the original message (same format as `--mention`).
 *--quote-text-style*::
 Style parts of the original message text (same format as `--text-style`).
 
+*--quote-attachment*::
+Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.
+
 *--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.
@@ -648,6 +684,18 @@ 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.
 
+=== listStickerPacks
+
+Show a list of known sticker packs.
+
+=== addStickerPack
+
+Install a sticker pack for this account.
+
+*--uri* [URI]::
+Specify the uri of the sticker pack.
+e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX)"
+
 === getAttachment
 
 Gets the raw data for a specified attachment.
@@ -705,6 +753,24 @@ Don’t print received messages to stdout.
 *--receive-mode*::
 Specify when to start receiving messages (on-start, on-connection, manual)
 
+=== jsonRpc
+
+Run in signal-cli in JSON-RPC mode.
+Reads JSON-RPC requests on stdin and responds on stdout.
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
+
+*--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)
+
+*--receive-mode*::
+Specify when to start receiving messages (on-start, manual)
+
 === submitRateLimitChallenge
 
 When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA.
@@ -758,6 +824,7 @@ signal-cli -a ACCOUNT trust -a NUMBER
 * *2*: Some unexpected error
 * *3*: Server or IO error
 * *4*: Sending failed due to untrusted key
+* *5*: Server rate limiting error
 
 == Files