Mercurial > libervia-backend

comparison doc/libervia-cli/remote-control.rst @ 4244:05f01ac1d5b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (cli): remote-control documentation Document the new remote control commands. rel 436
author Goffi <goffi@goffi.org>
date Sat, 11 May 2024 13:52:43 +0200
parents
children
comparison
equal deleted inserted replaced
4243:e47e29511d57 4244:05f01ac1d5b2
1 .. _libervia-cli_remote-control:
2
3 ==============================
4 remote-control: Remote Control
5 ==============================
6
7 The ``remote-control`` feature allows you to control another device or be controlled by another device.
8
9 send
10 ====
11
12 Send control events to another device. For now, it only sends keyboard events.
13
14 example
15 -------
16
17 Louise wants to control Pierre's device::
18
19 $ li remote-control send pierre@example.net
20
21
22 receive
23 =======
24
25 Use ``receive`` to establish a connection with another device and accept incoming control
26 events. This feature uses the freedesktop.org's Remote Desktop portal, which must be
27 installed on your system and compatible with your platform. On most Wayland-based desktop
28 environments, this portal is usually available.
29
30 Immediately upon connecting, Libervia CLI requests permission to initiate the remote
31 control session, event if not request has been received yet. This ensures that the
32 connection can be established without requiring manual intervention to authorize access.
33
34 After a connection has been accepted and terminated, the command quits.
35
36 ``--verbose, -v`` can be used to show received input events.
37 If you don't expect to share screen, use ``S {yes,no,auto}, --share-screen {yes,no,auto}``
38 with a value of ``no``.
39
40 example
41 -------
42
43 Louise is expecting Piotr to control her device and wants to automatically accept control from him::
44
45 $ li remote-control receive louise@example.org