From: AsamK Date: Sat, 9 Oct 2021 15:57:32 +0000 (+0200) Subject: Update documentation X-Git-Tag: v0.9.1~18 X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/abd0e718141bd1d4802f8801e4ae801eaa8efdc7 Update documentation --- diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index 3d977de6..c5c27fa9 100755 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -58,7 +58,7 @@ link(newDeviceName) -> deviceLinkUri:: * newDeviceName : Name to give new device (defaults to "cli" if no name is given) * deviceLinkUri : URI of newly linked device -Returns a URI of the form "tsdevice:/?uuid=...". This can be piped to a QR encoder to create a display that +Returns a URI of the form "sgnl://linkdevice/?uuid=...". This can be piped to a QR encoder to create a display that can be captured by a Signal smartphone client. For example: `dbus-send --session --dest=org.asamk.Signal --type=method_call --print-reply /org/asamk/Signal org.asamk.Signal.link string:"My secondary client"|tr '\n' '\0'|sed 's/.*string //g'|sed 's/\"//g'|qrencode -s10 -tANSI256` @@ -370,7 +370,7 @@ For unknown numbers, false is returned, but no exception is raised. If no number Exceptions: InvalidNumber addDevice(deviceUri) -> <>:: -* deviceUri : URI in the form of tsdevice:/?uuid=... Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method. +* deviceUri : URI in the form of "sgnl://linkdevice/?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method. listDevices() -> devices:: * devices : Array of structs (objectPath, id, name) diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 9829fe00..f2a1a960 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -144,7 +144,7 @@ Remove the registration lock pin. === link Link to an existing device, instead of registering a new number. -This shows a "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can just use this URI. +This shows a "sgnl://linkdevice/?uuid=..." URI. If you want to connect to another signal-cli instance, you can just use this URI. If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app. *-n* NAME, *--name* NAME:: @@ -158,7 +158,8 @@ Only works, if this is the master device. *--uri* URI:: Specify the uri contained in the QR code shown by the new device. -You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid=....." +You will need the full URI such as "sgnl://linkdevice/?uuid=..." (formerly "tsdevice:/?uuid=...") +Make sure to enclose it in quotation marks for shells. === listDevices