Update documentation
This commit is contained in:
		
							parent
							
								
									d82f4a8717
								
							
						
					
					
						commit
						abd0e71814
					
				@ -58,7 +58,7 @@ link(newDeviceName<s>) -> deviceLinkUri<s>::
 | 
			
		||||
* 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<s>) -> <>::
 | 
			
		||||
* 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<a(oxs)>::
 | 
			
		||||
* devices      : Array of structs (objectPath, id, name)
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user