X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/8cd782ef942a2bfd69d6fa56fda5d7b7b3923627..9d836414f0a1f2ade2957cfc2abb0791a092f691:/man/signal-cli.1.adoc diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index cdd56d62..2f1b2ac2 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -34,7 +34,8 @@ Options *--config* CONFIG:: Set the path, where to store the config. - (Default: $HOME/.config/signal) + Make sure you have full read/write access to the given directory. + (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`)) *-u* USERNAME, *--username* USERNAME:: Specify your phone number, that will be your identifier. @@ -65,6 +66,9 @@ Verify the number using the code received via SMS or voice. VERIFICATIONCODE:: The verification code. +*-p* PIN, *--pin* PIN:: + The registration lock PIN, that was set by the user. Only required if a PIN was set. + unregister ~~~~~~~~~~ Disable push support for this device, i.e. this device won't receive any more messages. @@ -77,6 +81,17 @@ updateAccount Update the account attributes on the signal server. Can fix problems with receiving messages. +setPin +~~~~~~ +Set a registration lock pin, to prevent others from registering this number. + +REGISTRATION_LOCK_PIN:: + The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity) + +removePin +~~~~~~~~~ +Remove the registration lock pin. + link ~~~~ Link to an existing device, instead of registering a new number. This shows a @@ -135,6 +150,8 @@ attachments are downloaded to the config directory. Default is 5 seconds. *--ignore-attachments*:: Don’t download attachments of received messages. +*--json*:: + Output received messages in json format, one object per line. updateGroup ~~~~~~~~~~~ @@ -191,6 +208,38 @@ number:: Specify the safety number or fingerprint of the key, only use this option if you have verified the fingerprint. +updateProfile +-------------- +Update the name and/or avatar image visible by message recipients for the current users. +The profile is stored encrypted on the Signal servers. The decryption key is sent +with every outgoing messages (excluding group messages). + +*--name*:: + New name visible by message recipients. + +*--avatar*:: + Path to the new avatar visible by message recipients. + +*--remove-avatar*:: + Remove the avatar visible by message recipients. + +updateContact +-------------- +Update the info associated to a number on our contact list. This change is only +local but can be synchronized to other devices by using `sendContacts` (see +below). +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. + +sendContacts +------------ +Send a synchronization message with the local contacts list to all linked devices. +This command should only be used if this is the master device. daemon ~~~~~~ @@ -242,9 +291,11 @@ Files The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*: - $HOME/.config/signal/ +`$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`) -For legacy users, the old config directory is used as a fallback: +For legacy users, the old config directories are used as a fallback: + + $HOME/.config/signal/ $HOME/.config/textsecure/