Update README, man page

[signal-cli] / README.md

diff --git a/README.md b/README.md
index 77c4c8c2093c167fa27764e9dd8138bd6e471723..3e354013ec7a11f398dcf24e02feff0bb07f8331 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # signal-cli
 
-signal-cli is a commandline interface for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering, verifying, sending and receiving messages. To be able to receiving messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For registering you need a phone number where you can receive SMS or incoming calls.
+signal-cli is a commandline interface for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering, verifying, sending and receiving messages. To be able to receive messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For registering you need a phone number where you can receive SMS or incoming calls.
 It is primarily intended 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.
 
 ## Installation
@@ -20,6 +20,10 @@ sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
 
 usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,listIdentities,trust,receive,daemon} ...
 
+See also: [man page in asciidoc format](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.txt)
+
+The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.
+
 * Register a number (with SMS verification)
 
         signal-cli -u USERNAME register
@@ -105,6 +109,12 @@ usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-sys
 
           signal-cli -u USERNAME trust -a NUMBER
 
+* Set configuration directory
+
+          signal-cli --config=/home/other_user/.config/signal
+
+      This is particularily useful in the case, when you would like to run the signal-cli tool as a different user as the one, that was used to register the account. You should make sure, that the caller has full read/write access to the given directory.
+        
 ## DBus service
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.
@@ -124,6 +134,9 @@ To run on the system bus you need to take some additional steps.
 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
 These steps, executed as root, should work on all distributions using systemd.
 
+Mind the fact that signal.service executes the signal-cli with "--config /var/lib/signal-cli".
+If you registered with user signal-cli, remove the config option.
+
 ```bash
 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
@@ -134,7 +147,7 @@ systemctl enable signal.service
 systemctl reload dbus.service
 ```
 
-Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
+Make sure to use "--dbus-system" with the send command, the service will be autostarted by dbus the first time it is requested.
 
 ## Storage