mirror of
https://github.com/AsamK/signal-cli
synced 2025-08-29 18:40:39 +00:00
Update documentation
This commit is contained in:
parent
69b7e73063
commit
4e69b34efe
2 changed files with 4 additions and 4 deletions
|
@ -58,7 +58,7 @@ link(newDeviceName<s>) -> deviceLinkUri<s>::
|
||||||
* newDeviceName : Name to give new device (defaults to "cli" if no name is given)
|
* newDeviceName : Name to give new device (defaults to "cli" if no name is given)
|
||||||
* deviceLinkUri : URI of newly linked device
|
* deviceLinkUri : URI of newly linked device
|
||||||
|
|
||||||
Returns a URI of the form "sgnl://linkdevice/?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:
|
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`
|
`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`
|
||||||
|
@ -311,7 +311,7 @@ The following methods listen to the recipient's object path, which is constructe
|
||||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||||
|
|
||||||
addDevice(deviceUri<s>) -> <>::
|
addDevice(deviceUri<s>) -> <>::
|
||||||
* 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.
|
* 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.
|
||||||
|
|
||||||
getDevice(deviceId<x>) -> devicePath<o>::
|
getDevice(deviceId<x>) -> devicePath<o>::
|
||||||
* deviceId : Long representing a deviceId
|
* deviceId : Long representing a deviceId
|
||||||
|
|
|
@ -144,7 +144,7 @@ Remove the registration lock pin.
|
||||||
=== link
|
=== link
|
||||||
|
|
||||||
Link to an existing device, instead of registering a new number.
|
Link to an existing device, instead of registering a new number.
|
||||||
This shows a "sgnl://linkdevice/?uuid=..." 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.
|
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::
|
*-n* NAME, *--name* NAME::
|
||||||
|
@ -158,7 +158,7 @@ Only works, if this is the master device.
|
||||||
|
|
||||||
*--uri* URI::
|
*--uri* URI::
|
||||||
Specify the uri contained in the QR code shown by the new device.
|
Specify the uri contained in the QR code shown by the new device.
|
||||||
You will need the full URI such as "sgnl://linkdevice/?uuid=..." (formerly "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.
|
Make sure to enclose it in quotation marks for shells.
|
||||||
|
|
||||||
=== listDevices
|
=== listDevices
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue