summaryrefslogtreecommitdiffstats
path: root/client/SDL/man/sdl-freerdp-config.1.xml.in
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 01:24:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 01:24:41 +0000
commita9bcc81f821d7c66f623779fa5147e728eb3c388 (patch)
tree98676963bcdd537ae5908a067a8eb110b93486a6 /client/SDL/man/sdl-freerdp-config.1.xml.in
parentInitial commit. (diff)
downloadfreerdp3-a9bcc81f821d7c66f623779fa5147e728eb3c388.tar.xz
freerdp3-a9bcc81f821d7c66f623779fa5147e728eb3c388.zip
Adding upstream version 3.3.0+dfsg1.upstream/3.3.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'client/SDL/man/sdl-freerdp-config.1.xml.in')
-rw-r--r--client/SDL/man/sdl-freerdp-config.1.xml.in81
1 files changed, 81 insertions, 0 deletions
diff --git a/client/SDL/man/sdl-freerdp-config.1.xml.in b/client/SDL/man/sdl-freerdp-config.1.xml.in
new file mode 100644
index 0000000..3bace73
--- /dev/null
+++ b/client/SDL/man/sdl-freerdp-config.1.xml.in
@@ -0,0 +1,81 @@
+<refsect1>
+ <title>Configuration file</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>Format and Location:</term>
+ <listitem>
+ <para>The configuration file is stored per user.<sbr/>
+ The <replaceable>XDG_CONFIG_HOME</replaceable> environment variable can be used to override the base directory.<sbr/>
+ This defaults to <replaceable>~/.config</replaceable>
+ The location relative to <replaceable>XDG_CONFIG_HOME</replaceable> is <replaceable>$XDG_CONFIG_HOME/@VENDOR@/@PRODUCT@/@PROJECT_NAME@.json</replaceable><sbr/>
+ The configuration is stored in JSON format</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Supported options:</term>
+ <listitem>
+ <varlistentry>
+ <term><replaceable>SDL_KeyModMask</replaceable></term>
+ <listitem>
+ <varlistentry>
+ <listitem>
+ <para>Defines the key combination required for SDL client shortcuts.<sbr/>
+ Default <replaceable>KMOD_RSHIFT</replaceable><sbr/>
+ An array of <replaceable>SDL_Keymod</replaceable> strings as defined at <replaceable>https://wiki.libsdl.org/SDL2/SDL_Keymod</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>SDL_Fullscreen</replaceable></term>
+ <listitem>
+ <varlistentry>
+ <listitem>
+ <para>Toggles client fullscreen state.<sbr/>
+ Default <replaceable>SDL_SCANCODE_RETURN</replaceable>.<sbr/>
+ A string as defined at <replaceable>https://wiki.libsdl.org/SDL2/SDLScancodeLookup</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>SDL_Resizeable</replaceable></term>
+ <listitem>
+ <varlistentry>
+ <listitem>
+ <para>Toggles local window resizeable state.<sbr/>
+ Default <replaceable>SDL_SCANCODE_R</replaceable>.<sbr/>
+ A string as defined at <replaceable>https://wiki.libsdl.org/SDL2/SDLScancodeLookup</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>SDL_Grab</replaceable></term>
+ <listitem>
+ <varlistentry>
+ <listitem>
+ <para>Toggles keyboard and mouse grab state.<sbr/>
+ Default <replaceable>SDL_SCANCODE_G</replaceable>.<sbr/>
+ A string as defined at <replaceable>https://wiki.libsdl.org/SDL2/SDLScancodeLookup</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>SDL_Disconnect</replaceable></term>
+ <listitem>
+ <varlistentry>
+ <listitem>
+ <para>Disconnects from the RDP session.<sbr/>
+ Default <replaceable>SDL_SCANCODE_D</replaceable>.<sbr/>
+ A string as defined at <replaceable>https://wiki.libsdl.org/SDL2/SDLScancodeLookup</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>