summaryrefslogtreecommitdiffstats
path: root/client/SDL/man/sdl-freerdp-config.1.xml.in
blob: 3bace734f523924a9857b9d19816cf391df39957 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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>