X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/3587d1c3973a084ea779e34959c28c7814e0e5c9..2a20e70aabaad0106774157a78eba60428604ac1:/man/signal-cli.1.adoc diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index b71f549c..0562fcca 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -8,7 +8,7 @@ vim:set ts=4 sw=4 tw=82 noet: == Name -signal-cli - A commandline and dbus interface for the Signal messenger +signal-cli - A commandline interface for the Signal messenger == Synopsis @@ -20,7 +20,7 @@ signal-cli is a commandline interface for libsignal-service-java. It supports registering, verifying, sending and receiving messages. For registering you need a phone number where you can receive SMS or incoming calls. signal-cli was primarily developed to be used on servers to notify admins of important events. -For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings. +For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs. For some functionality the Signal protocol requires that all messages have been received from the server. The `receive` command should be regularly executed. @@ -37,6 +37,10 @@ Print the version and quit. *--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. + *--config* CONFIG:: Set the path, where to store the config. Make sure you have full read/write access to the given directory. @@ -50,8 +54,9 @@ This flag must not be given for the `link` command. It is optional for the `daemon` command. For all other commands it is only optional if there is exactly one local user in the config directory. -*--service-environment* ENVIRONMENT +*--service-environment* ENVIRONMENT:: Choose the server environment to use: + - `live` (default) - `staging` @@ -88,6 +93,7 @@ The verification should be done over voice, not SMS. *--captcha*:: 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. === verify @@ -207,7 +213,11 @@ Send the message to self without notification. Specify the recipient group ID in base64 encoding. *-m* MESSAGE, *--message* MESSAGE:: -Specify the message, if missing, standard input is used. +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. @@ -347,6 +357,13 @@ Specify one or more members to make a group admin *--remove-admin* [MEMBER [MEMBER ...]]:: Specify one or more members to remove group admin privileges +*--ban* [MEMBER [MEMBER ...]]:: +Specify one or more members to ban from joining the group. +Banned members cannot join or request to join via a group link. + +*--unban* [MEMBER [MEMBER ...]]:: +Specify one or more members to remove from the ban list + *--reset-link*:: Reset group link and create new link password @@ -573,7 +590,7 @@ Send a message to one or more recipients:: signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]] Pipe the message content from another process:: -uname -a | signal-cli -a ACCOUNT send [RECIPIENT [RECIPIENT ...]] +uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]] Create a group:: signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]