Document submitRateLimitChallenge

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index be940418e001044f6eecabdee3048f3e803aaba5..a9ccbad4550ce71cb78ff8393c9b6dc6673e93d8 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -5,6 +5,7 @@ vim:set ts=4 sw=4 tw=82 noet:
 :quotes.~:
 
 = signal-cli (1)
+:doctype: manpage
 
 == Name
 
@@ -601,7 +602,7 @@ The primary device will respond with synchronization messages with full contact
 
 === 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 )
 
 - Static stickers in PNG or WebP format
@@ -637,17 +638,19 @@ The path of the manifest.json or a zip file containing the sticker pack you wish
 
 === getAttachment
 
-Gets teh raw data for a specified attachment. This is done using the ID of the attachment the recipient or group ID.
+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.
+Specify the number which sent the attachment.
+Referred to generally as recipient.
 
 *-g* [GROUP], *--group-id* [GROUP]::
-Alternatively, specify the group IDs that for which to get the attachment.
+Alternatively, specify the group IDs for which to get the attachment.
 
 === daemon
 
@@ -655,20 +658,25 @@ signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC
 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.
+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.
+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.
+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.
+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.
 
 *--ignore-attachments*::
 Don’t download attachments of received messages.
@@ -685,6 +693,18 @@ Don’t print received messages to stdout.
 *--receive-mode*::
 Specify when to start receiving messages (on-start, on-connection, manual)
 
+=== submitRateLimitChallenge
+
+When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA.
+To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html
+For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
+
+*--challenge* CHALLENGE_TOKEN::
+The challenge token from the failed send attempt.
+
+*--captcha* CAPTCHA::
+The captcha result, starting with signalcaptcha://
+
 == Examples
 
 Register a number (with SMS verification)::