X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/24069c8277cca7f8e94aa3f083980e85dca25269..bea659f9484a2aba47c4d8dad503f18b0aaff19b:/man/signal-cli.1.adoc?ds=sidebyside diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 2b545fa2..110f8021 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -25,7 +25,7 @@ For this use-case, it has a dbus and a JSON-RPC interface, that can be used to s 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. +In daemon mode messages are by default continuously received. == Options @@ -44,6 +44,7 @@ If `--verbose` is also given, the detailed logs will only be written to the log *--scrub-log*:: Scrub possibly sensitive information from the log, like phone numbers and UUIDs. +Doesn't work reliably on dbus logs with very verbose logging (`-vvv`) *--config* CONFIG:: Set the path, where to store the config. @@ -102,7 +103,7 @@ Voice verification only works if an SMS verification has been attempted before. 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. +After solving the captcha, right-click on the "Open Signal" link and copy the link. === verify @@ -147,6 +148,9 @@ Can fix problems with receiving messages. *-n* NAME, *--device-name* NAME:: Set a new device name for the primary or linked device +*--unrestricted-unidentified-sender* {true,false}:: +Enable if anyone should be able to send you unidentified sender messages. + === startChangeNumber Change an account to a new phone number with SMS or voice verification. @@ -163,7 +167,7 @@ Voice verification only works if an SMS verification has been attempted before. 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. +After solving the captcha, right-click on the "Open Signal" link and copy the link. === finishChangeNumber @@ -288,7 +292,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!" --text-style "10:3:BOLD"` +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"` *--quote-timestamp*:: Specify the timestamp of a previous message with the recipient or group to add a quote to the new message. @@ -613,6 +617,9 @@ Remove the info of a given contact NUMBER:: Specify the contact phone number. +*--hide*:: +Hide the contact in the contact list, but keep the data. + *--forget*:: Delete all data associated with this contact, including identity keys and sessions. @@ -694,7 +701,7 @@ 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)" +e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX === getAttachment @@ -714,16 +721,9 @@ Alternatively, specify the group IDs for which to get the attachment. === daemon -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. +signal-cli can run in daemon mode and provides JSON-RPC or an experimental dbus interface. +If no `-a` account is given, all local accounts will be loaded. +Multiple interfaces can be used at the same time, e.g. `daemon --socket --dbus` *--socket [SOCKET]*:: Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). + @@ -738,6 +738,14 @@ 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. +*--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. + *--ignore-attachments*:: Don’t download attachments of received messages.