Use PlainTextWriter for all cli stdout output

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

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index 350702701b6148ed75e17d48a157bc89d180e81e..16b684eaabb50ca2252a9f42862732d624bf14d9 100644 (file)
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -21,6 +21,9 @@ For registering you need a phone number where you can receive SMS or incoming ca
 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.
 
 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 some functionality the Signal protocol requires that all messages have been received from the server.
+The `receive` command should be regularly executed. In daemon mode messages are continuously received.
+

 == Options
 
 *-h*, *--help*::
 == Options
 
 *-h*, *--help*::


@@ -29,6 +32,9 @@ Show help message and quit.
 *-v*, *--version*::
 Print the version and quit.
 
 *-v*, *--version*::
 Print the version and quit.
 

+*--verbose*::
+Raise log level and include lib signal logs.
+

 *--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.


@@ -38,6 +44,11 @@ Make sure you have full read/write access to the given directory.
 Specify your phone number, that will be your identifier.
 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
 
 Specify your phone number, that will be your identifier.
 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
 

+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.
+

 *--dbus*::
 Make request via user dbus.
 
 *--dbus*::
 Make request via user dbus.
 


@@ -154,6 +165,9 @@ Specify the message, if missing, standard input is used.
 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 Add one or more files as attachment.
 
 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 Add one or more files as attachment.
 

+*--note-to-self*::
+Send the message to self without notification.
+

 *-e*, *--endsession*::
 Clear session state and send end session message.
 
 *-e*, *--endsession*::
 Clear session state and send end session message.
 


@@ -194,6 +208,8 @@ Don’t download attachments of received messages.
 === joinGroup
 
 Join a group via an invitation link.
 === joinGroup
 
 Join a group via an invitation link.

+To be able to join a v2 group the account needs to have a profile (can be created
+with the `updateProfile` command)

 
 *--uri*::
 The invitation link URI (starts with `https://signal.group/#`)
 
 *--uri*::
 The invitation link URI (starts with `https://signal.group/#`)


@@ -202,6 +218,8 @@ The invitation link URI (starts with `https://signal.group/#`)
 
 Create or update a group.
 If the user is a pending member, this command will accept the group invitation.
 
 Create or update a group.
 If the user is a pending member, this command will accept the group invitation.

+To be able to join or create a v2 group the account needs to have a profile (can
+be created with the `updateProfile` command)

 
 *-g* GROUP, *--group* GROUP::
 Specify the recipient group ID in base64 encoding.
 
 *-g* GROUP, *--group* GROUP::
 Specify the recipient group ID in base64 encoding.


@@ -342,6 +360,8 @@ The path of the manifest.json or a zip file containing the sticker pack you wish
 === daemon
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.
 === daemon
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.

+If no `-u` username is given, all local users will be exported as separate dbus
+objects under the same bus name.

 
 *--system*::
 Use DBus system bus instead of user bus.
 
 *--system*::
 Use DBus system bus instead of user bus.


@@ -380,6 +400,12 @@ signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 Trust new key, without having verified it. Only use this if you don't care about security::
 signal-cli -u USERNAME trust -a NUMBER
 
 Trust new key, without having verified it. Only use this if you don't care about security::
 signal-cli -u USERNAME trust -a NUMBER
 

+== Exit codes
+* *1*: Error is probably caused and fixable by the user
+* *2*: Some unexpected error
+* *3*: Server or IO error
+* *4*: Sending failed due to untrusted key
+

 == 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*:
 == 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*: