# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1715428363 -7200
# Node ID 05f01ac1d5b2e44dcb654ec29369c25629e05171
# Parent  e47e29511d574a25abb552d46c557a355b700d89
doc (cli): remote-control documentation

Document the new remote control commands.

rel 436

diff -r e47e29511d57 -r 05f01ac1d5b2 doc/libervia-cli/remote-control.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libervia-cli/remote-control.rst	Sat May 11 13:52:43 2024 +0200
@@ -0,0 +1,45 @@
+.. _libervia-cli_remote-control:
+
+==============================
+remote-control: Remote Control
+==============================
+
+The ``remote-control`` feature allows you to control another device or be controlled by another device.
+
+send
+====
+
+Send control events to another device. For now, it only sends keyboard events.
+
+example
+-------
+
+Louise wants to control Pierre's device::
+
+  $ li remote-control send pierre@example.net
+
+
+receive
+=======
+
+Use ``receive`` to establish a connection with another device and accept incoming control
+events. This feature uses the freedesktop.org's Remote Desktop portal, which must be
+installed on your system and compatible with your platform. On most Wayland-based desktop
+environments, this portal is usually available.
+
+Immediately upon connecting, Libervia CLI requests permission to initiate the remote
+control session, event if not request has been received yet. This ensures that the
+connection can be established without requiring manual intervention to authorize access.
+
+After a connection has been accepted and terminated, the command quits.
+
+``--verbose, -v`` can be used to show received input events.
+If you don't expect to share screen, use ``S {yes,no,auto}, --share-screen {yes,no,auto}``
+with a value of ``no``.
+
+example
+-------
+
+Louise is expecting Piotr to control her device and wants to automatically accept control from him::
+
+  $ li remote-control receive louise@example.org