[client,x11] document keyboard shortcuts

This commit is contained in:
akallabeth
2024-03-11 10:24:04 +01:00
committed by akallabeth
parent c87368310a
commit 6b5f262660
4 changed files with 50 additions and 0 deletions

View File

@@ -31,6 +31,25 @@
#include "../xf_client.h"
#include "../xfreerdp.h"
static void xfreerdp_print_help(void)
{
printf("Keyboard Shortcuts:\n");
printf("\t<Right CTRL>\n");
printf("\t\treleases keyboard and mouse grab\n");
printf("\t<CTRL>+<ALT>+<Return>\n");
printf("\t\ttoggles fullscreen state of the application\n");
printf("\t<CTRL>+<ALT>+c\n");
printf("\t\ttoggles remote control in a remote assistance session\n");
printf("\tAction Script\n");
printf("\t\tExecutes a predefined script on key press.\n");
printf("\t\tShould the script not exist it is ignored.\n");
printf("\t\tScripts can be provided at the default localtion ~/.config/freerdp/action.sh or as "
"command line argument /action:script:<path>\n");
printf("\t\tThe script will receive the current key combination as argument.\n");
printf("\t\tThe output of the script is parsed for 'key-local' which tells that the script "
"used the key combination, otherwise the combination is forwarded to the remote.\n");
}
int main(int argc, char* argv[])
{
int rc = 1;
@@ -59,6 +78,8 @@ int main(int argc, char* argv[])
{
rc = freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
xfreerdp_print_help();
if (freerdp_settings_get_bool(settings, FreeRDP_ListMonitors))
xf_list_monitors(xfc);

View File

@@ -1,6 +1,7 @@
set(DEPS
xfreerdp-channels.1.xml
xfreerdp-examples.1.xml
xfreerdp-shortcuts.1.xml
xfreerdp-envvar.1.xml
)

View File

@@ -0,0 +1,25 @@
<refsect1>
<title>Keyboard Shortcuts</title>
<variablelist>
<varlistentry>
<term>&lt;Right CTRL&gt;</term>
<listitem><para>releases keyboard and mouse grab</para></listitem>
</varlistentry>
<varlistentry>
<term>&lt;CTRL&gt;+&lt;ALT&gt;+&lt;Return&gt;</term>
<listitem><para>toggles fullscreen state of the application</para></listitem>
</varlistentry>
<varlistentry>
<term>&lt;CTRL&gt;+&lt;ALT&gt;+c</term>
<listitem><para>toggles remote control in a remote assistance session</para></listitem>
</varlistentry>
<varlistentry>
<term>Action Script</term>
<listitem><para>executes a predefined script on key press.</para></listitem>
<listitem><para>Should the script not exist it is ignored.</para></listitem>
<listitem><para>Scripts can be provided at the default localtion ~/.config/freerdp/action.sh or as command line argument /action:script:&lt;path&gt;.</para></listitem>
<listitem><para>The script will receive the current key combination as argument.</para></listitem>
<listitem><para>The output of the script is parsed for key-local which tells that the script used the key combination, otherwise the combination is forwarded to the remote.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>

View File

@@ -3,6 +3,7 @@
PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY syntax SYSTEM "freerdp-argument.1.xml">
<!ENTITY shortcuts SYSTEM "xfreerdp-shortcuts.1.xml">
<!ENTITY channels SYSTEM "xfreerdp-channels.1.xml">
<!ENTITY envvar SYSTEM "xfreerdp-envvar.1.xml">
<!ENTITY examples SYSTEM "xfreerdp-examples.1.xml">
@@ -49,6 +50,8 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
&syntax;
&shortcuts;
&channels;
&envvar;