X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/9ad24614cb800c0e3f853dc985d8d4180bbdd04d..1d77153a2bc5c6c7a8d7bc7b72fe8fc7db1208c8:/man/signal-cli.1.adoc diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 9b54635e..f1e9e79a 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -31,16 +31,19 @@ In daemon mode messages are continuously received. *-h*, *--help*:: Show help message and quit. -*-v*, *--version*:: +*--version*:: Print the version and quit. -*--verbose*:: +*-v*, *--verbose*:: Raise log level and include lib signal logs. *--log-file* LOG_FILE:: Write log output to the given file. If `--verbose` is also given, the detailed logs will only be written to the log file. +*--scrub-log*:: +Scrub possibly sensitive information from the log, like phone numbers and UUIDs. + *--config* CONFIG:: Set the path, where to store the config. Make sure you have full read/write access to the given directory. @@ -224,13 +227,16 @@ Specify the recipient group ID in base64 encoding. *-m* MESSAGE, *--message* MESSAGE:: Specify the message. -Currently, signal-cli reads the message from stdin if `-m` is missing, but this will change in a future version and the explicit flag `--message-from-stdin` should be used instead. *--message-from-stdin*:: Read the message from standard input. *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]:: Add one or more files as attachment. +Can be either a file path or a data URI. +Data URI encoded attachments must follow the RFC 2397. +Additionally a file name can be added: +e.g.: `data:;filename=;base64,` *--sticker* STICKER:: Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId). @@ -253,6 +259,19 @@ Specify the message of the original message. *--quote-mention*:: Specify the mentions of the original message (same format as `--mention`). +*--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. + +*--preview-title*:: +Specify the title for the link preview (mandatory). + +*--preview-description*:: +Specify the description for the link preview (optional). + +*--preview-image*:: +Specify the image file for the link preview (optional). + *-e*, *--end-session*:: Clear session state and send end session message. @@ -343,6 +362,9 @@ Default is 5 seconds. *--ignore-attachments*:: Don’t download attachments of received messages. +*--send-read-receipts*:: +Send read receipts for all incoming data messages (in addition to the default delivery receipts) + === joinGroup Join a group via an invitation link. @@ -505,8 +527,11 @@ If the contact doesn't exist yet, it will be added. NUMBER:: Specify the contact phone number. -*-n*, *--name*:: -Specify the new name for this contact. +*--given-name* NAME, *--name* NAME:: +New (given) name. + +*--family-name* FAMILY_NAME:: +New family name. *-e*, *--expiration* EXPIRATION_SECONDS:: Set expiration time of messages (seconds). @@ -614,6 +639,9 @@ See signal-cli-jsonrpc (5) for info on the JSON-RPC interface. *--ignore-attachments*:: Don’t download attachments of received messages. +*--send-read-receipts*:: +Send read receipts for all incoming data messages (in addition to the default delivery receipts) + *--no-receive-stdout*:: Don’t print received messages to stdout.