Add --scrub-log flag to remove possibly sensitive information from the log

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index 4d32ea5f3b664dd24ff326d61f7830758be25f73..f1e9e79ad5b203e266341e2845493f1da16084c3 100644 (file)
--- 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.
 
 *-h*, *--help*::
 Show help message and quit.
 

-*-v*, *--version*::
+*--version*::

 Print the version and quit.
 
 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.
 
 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.
 *--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.
 
 *-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.
 
 *--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:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>`

 
 *--sticker* STICKER::
 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
 
 *--sticker* STICKER::
 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).


@@ -255,8 +261,7 @@ Specify the mentions of the original message (same format as `--mention`).
 
 *--preview-url*::
 Specify the url for the link preview.
 
 *--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).
 
 *--preview-title*::
 Specify the title for the link preview (mandatory).


@@ -522,8 +527,11 @@ If the contact doesn't exist yet, it will be added.
 NUMBER::
 Specify the contact phone number.
 
 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).
 
 *-e*, *--expiration* EXPIRATION_SECONDS::
 Set expiration time of messages (seconds).