X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/b178c7c67aea7bf334cbf0d54a4666af0a65b5d9..fea19c9e20ed07228420dae93399911a659e51b1:/man/signal-cli.1.adoc diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 1ccb067c..4509f08f 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. @@ -76,6 +79,9 @@ Choose when to trust new identities: - `always`: Trust any new identity key without verification - `never`: Don't trust any unknown identity key, every key must be verified manually +*--disable-send-log*:: +Disable message send log (for resending messages that recipient couldn't decrypt). + == Commands === register @@ -224,13 +230,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). @@ -255,8 +264,7 @@ 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. +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). @@ -305,6 +313,9 @@ Specify the timestamp of the message to which to react. *-r*, *--remove*:: Remove a reaction. +*--story*:: +React to a story instead of a normal message + === sendReceipt Send a read or viewed receipt to a previously received message. @@ -354,9 +365,17 @@ In json mode this is outputted as one json object per line. *-t* TIMEOUT, *--timeout* TIMEOUT:: Number of seconds to wait for new messages (negative values disable timeout). Default is 5 seconds. + *--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) + === joinGroup Join a group via an invitation link. @@ -519,8 +538,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). @@ -628,6 +650,12 @@ 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) + *--no-receive-stdout*:: Don’t print received messages to stdout.