FreeRDP
Loading...
Searching...
No Matches
client/common/cmdline.h
1
20#ifndef CLIENT_COMMON_CMDLINE_H
21#define CLIENT_COMMON_CMDLINE_H
22
23#include <freerdp/config.h>
24
25#include <winpr/cmdline.h>
26
27static const COMMAND_LINE_ARGUMENT_A global_cmd_args[] = {
28 { "a", COMMAND_LINE_VALUE_REQUIRED, "<addin>[,<options>]", nullptr, nullptr, -1, "addin",
29 "Addin" },
30 { "azure", COMMAND_LINE_VALUE_REQUIRED,
31 "[tenantid:<id>],[use-tenantid[:[on|off]],[ad:<url>]"
32 "[avd-access:<format string>],[avd-token:<format string>],[avd-scope:<format string>]",
33 nullptr, nullptr, -1, nullptr, "AzureAD options" },
34 { "action-script", COMMAND_LINE_VALUE_REQUIRED, "<file-name>", "~/.config/freerdp/action.sh",
35 nullptr, -1, nullptr, "Action script" },
36 { "admin", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "console",
37 "Admin (or console) session" },
38 { "aero", COMMAND_LINE_VALUE_BOOL, nullptr, nullptr, BoolValueFalse, -1, nullptr,
39 "desktop composition" },
40 { "app", COMMAND_LINE_VALUE_REQUIRED,
41 "program:[<path>|<||alias>],cmd:<command>,file:<filename>,guid:<guid>,icon:<filename>,name:<"
42 "name>,workdir:<directory>,hidef:[on|off]",
43 nullptr, nullptr, -1, nullptr, "Remote application program" },
44#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
45 { "app-cmd", COMMAND_LINE_VALUE_REQUIRED, "<parameters>", nullptr, nullptr, -1, nullptr,
46 "[DEPRECATED, use /app:cmd:<command>] Remote application command-line parameters" },
47 { "app-file", COMMAND_LINE_VALUE_REQUIRED, "<file-name>", nullptr, nullptr, -1, nullptr,
48 "[DEPRECATED, use /app:file:<filename>] File to open with remote application" },
49 { "app-guid", COMMAND_LINE_VALUE_REQUIRED, "<app-guid>", nullptr, nullptr, -1, nullptr,
50 "[DEPRECATED, use /app:guid:<guid>] Remote application GUID" },
51 { "app-icon", COMMAND_LINE_VALUE_REQUIRED, "<icon-path>", nullptr, nullptr, -1, nullptr,
52 "[DEPRECATED, use /app:icon:<filename>] Remote application icon for user interface" },
53 { "app-name", COMMAND_LINE_VALUE_REQUIRED, "<app-name>", nullptr, nullptr, -1, nullptr,
54 "[DEPRECATED, use /app:name:<name>] Remote application name for user interface" },
55 { "app-workdir", COMMAND_LINE_VALUE_REQUIRED, "<workspace path>", nullptr, nullptr, -1, nullptr,
56 "[DEPRECATED, use /app:workdir:<directory>] Remote application workspace path" },
57#endif
58 { "assistance", COMMAND_LINE_VALUE_REQUIRED, "<password>", nullptr, nullptr, -1, nullptr,
59 "Remote assistance password" },
60 { "auto-request-control", COMMAND_LINE_VALUE_FLAG, "", nullptr, nullptr, -1, nullptr,
61 "Automatically request remote assistance input control" },
62 { "async-channels", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
63 "Asynchronous channels (experimental)" },
64 { "async-update", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
65 "Asynchronous update" },
66 { "audio-mode", COMMAND_LINE_VALUE_REQUIRED, "[[none|0]|[redirect|1]|[server|2]]", nullptr,
67 nullptr, -1, nullptr, "Audio output mode" },
68 { "auth-only", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
69 "Authenticate only" },
70 { "auth-pkg-list", COMMAND_LINE_VALUE_REQUIRED, "[[none],]<!ntlm,kerberos,!u2u>", nullptr,
71 nullptr, -1, nullptr,
72 "Authentication package filter (comma-separated list, use '!' to disable). By default "
73 "all methods are enabled. Use explicit 'none' as first argument to disable all methods, "
74 "selectively enabling only the ones following." },
75 { "authentication", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
76 "Authentication (experimental)" },
77 { "auto-reconnect", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
78 "Automatic reconnection" },
79 { "auto-reconnect-max-retries", COMMAND_LINE_VALUE_REQUIRED, "<retries>", nullptr, nullptr, -1,
80 nullptr, "Automatic reconnection maximum retries, 0 for unlimited [0,1000]" },
81#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
82 { "bitmap-cache", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
83 "[DEPRECATED, use /cache:bitmap[:on|off]] bitmap cache" },
84 { "persist-cache", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
85 "[DEPRECATED, use /cache:persist[:on|off]] persistent bitmap cache" },
86 { "persist-cache-file", COMMAND_LINE_VALUE_REQUIRED, "<filename>", nullptr, nullptr, -1,
87 nullptr, "[DEPRECATED, use /cache:persist-file:<filename>] persistent bitmap cache file" },
88#endif
89 { "bpp", COMMAND_LINE_VALUE_REQUIRED, "<depth>", "16", nullptr, -1, nullptr,
90 "Session bpp (color depth)" },
91 { "buildconfig", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT_BUILDCONFIG, nullptr, nullptr,
92 nullptr, -1, nullptr, "Print the build configuration" },
93 { "cache", COMMAND_LINE_VALUE_REQUIRED,
94 "[bitmap[:on|off],codec[:rfx|nsc],glyph[:on|off],offscreen[:on|off],persist,persist-file:<"
95 "filename>]",
96 nullptr, nullptr, -1, nullptr, "" },
97 { "cert", COMMAND_LINE_VALUE_REQUIRED,
98 "[deny,ignore,name:<name>,tofu,fingerprint:<hash>:<hash as hex>[,fingerprint:<hash>:<another "
99 "hash>]]",
100 nullptr, nullptr, -1, nullptr,
101 "Certificate accept options. Use with care!\n"
102 " * deny ... Automatically abort connection if the certificate does not match, no "
103 "user interaction.\n"
104 " * ignore ... Ignore the certificate checks altogether (overrules all other options)\n"
105 " * name ... Use the alternate <name> instead of the certificate subject to match "
106 "locally stored certificates\n"
107 " * tofu ... Accept certificate unconditionally on first connect and deny on "
108 "subsequent connections if the certificate does not match\n"
109 " * fingerprints ... A list of certificate hashes that are accepted unconditionally for a "
110 "connection" },
111#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
112 { "cert-deny", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
113 "[DEPRECATED, use /cert:deny] Automatically abort connection for any certificate that can "
114 "not be validated." },
115 { "cert-ignore", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
116 "[DEPRECATED, use /cert:ignore] Ignore certificate" },
117 { "cert-name", COMMAND_LINE_VALUE_REQUIRED, "<name>", nullptr, nullptr, -1, nullptr,
118 "[DEPRECATED, use /cert:name:<name>] Certificate name" },
119 { "cert-tofu", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
120 "[DEPRECATED, use /cert:tofu] Automatically accept certificate on first connect" },
121#endif
122#ifdef _WIN32
123 { "connect-child-session", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, "",
124 "connect to child session (win32)" },
125#endif
126 { "client-build-number", COMMAND_LINE_VALUE_REQUIRED, "<number>", nullptr, nullptr, -1, nullptr,
127 "Client Build Number sent to server (influences smartcard behaviour, see [MS-RDPESC])" },
128 { "client-hostname", COMMAND_LINE_VALUE_REQUIRED, "<name>", nullptr, nullptr, -1, nullptr,
129 "Client Hostname to send to server" },
130 { "clipboard", COMMAND_LINE_VALUE_BOOL | COMMAND_LINE_VALUE_OPTIONAL,
131 "[[use-selection:<atom>],[direction-to:[all|local|remote|off]],[files-to[:all|local|remote|"
132 "off]]]",
133 BoolValueTrue, nullptr, -1, nullptr,
134 "Redirect clipboard:\n"
135 " * use-selection:<atom> ... (X11) Specify which X selection to access. Default is "
136 "CLIPBOARD. PRIMARY is the X-style middle-click selection.\n"
137 " * direction-to:[all|local|remote|off] control enabled clipboard direction\n"
138 " * files-to:[all|local|remote|off] control enabled file clipboard direction" },
139#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
140 { "codec-cache", COMMAND_LINE_VALUE_REQUIRED, "[rfx|nsc|jpeg]", nullptr, nullptr, -1, nullptr,
141 "[DEPRECATED, use /cache:codec:[rfx|nsc|jpeg]] Bitmap codec cache" },
142#endif
143 { "compression", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, "z",
144 "compression" },
145 { "compression-level", COMMAND_LINE_VALUE_REQUIRED, "<level>", nullptr, nullptr, -1, nullptr,
146 "Compression level (0,1,2)" },
147 { "credentials-delegation", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1,
148 nullptr, "credentials delegation" },
149 { "d", COMMAND_LINE_VALUE_REQUIRED, "<domain>", nullptr, nullptr, -1, nullptr, "Domain" },
150 { "decorations", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
151 "Window decorations" },
152 { "disp", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr, "Display control" },
153 { "drive", COMMAND_LINE_VALUE_REQUIRED, "<name>,<path>", nullptr, nullptr, -1, nullptr,
154 "Redirect directory <path> as named share <name>. Hotplug support is enabled with "
155 "/drive:hotplug,*. This argument provides the same function as \"Drives that I plug in "
156 "later\" option in MSTSC." },
157 { "drives", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
158 "Redirect all mount points as shares" },
159 { "dump", COMMAND_LINE_VALUE_REQUIRED, "<record|replay>,file:<file>[,nodelay]", nullptr,
160 nullptr, -1, nullptr, "record or replay dump" },
161 { "dvc", COMMAND_LINE_VALUE_REQUIRED, "<channel>[,<options>]", nullptr, nullptr, -1, nullptr,
162 "Dynamic virtual channel" },
163 { "dynamic-resolution", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
164 "Send resolution updates when the window is resized" },
165 { "echo", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "echo", "Echo channel" },
166 { "encryption", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
167 "Encryption (experimental)" },
168 { "encryption-methods", COMMAND_LINE_VALUE_REQUIRED, "[40,][56,][128,][FIPS]", nullptr, nullptr,
169 -1, nullptr, "RDP standard security encryption methods" },
170 { "endpointfedauth", COMMAND_LINE_VALUE_REQUIRED, "<token>", nullptr, nullptr, -1, nullptr,
171 "Endpoint FedAuth token for Hyper-V VM console-connect scenarios" },
172 { "f", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
173 "Fullscreen mode (<Ctrl>+<Alt>+<Enter> toggles fullscreen)" },
174 { "fipsmode", COMMAND_LINE_VALUE_BOOL, nullptr, nullptr, nullptr, -1, nullptr, "FIPS mode" },
175 { "floatbar", COMMAND_LINE_VALUE_OPTIONAL,
176 "sticky:[on|off],default:[visible|hidden],show:[always|fullscreen|window]", nullptr, nullptr,
177 -1, nullptr,
178 "floatbar is disabled by default (when enabled defaults to sticky in fullscreen mode)" },
179 { "fonts", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
180 "smooth fonts (ClearType)" },
181 { "force-console-callbacks", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1,
182 nullptr, "Use default callbacks (console) for certificate/credential/..." },
183 { "frame-ack", COMMAND_LINE_VALUE_REQUIRED, "<number>", nullptr, nullptr, -1, nullptr,
184 "Number of frame acknowledgement" },
185 { "args-from", COMMAND_LINE_VALUE_REQUIRED, "file:<file>|stdin|fd:<number>|env:<name>", nullptr,
186 nullptr, -1, nullptr,
187 "Read command line from a file, stdin or file descriptor. This argument can not be combined "
188 "with any other. "
189 "Provide one argument per line." },
190 { "from-stdin", COMMAND_LINE_VALUE_OPTIONAL, "force", nullptr, nullptr, -1, nullptr,
191 "Read credentials from stdin. With <force> the prompt is done before connection, otherwise "
192 "on server request." },
193 { "gateway", COMMAND_LINE_VALUE_REQUIRED,
194 "g:<gateway>[:<port>],u:<user>,d:<domain>,p:<password>,usage-method:["
195 "direct|detect],access-token:<"
196 "token>,type:[rpc|http[,no-websockets][,extauth-sspi-ntlm]|auto[,no-websockets][,extauth-"
197 "sspi-ntlm]]|arm,url:<wss://url>,bearer:<oauth2-bearer-token>",
198 nullptr, nullptr, -1, "gw", "Gateway Hostname" },
199#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
200 { "g", COMMAND_LINE_VALUE_REQUIRED, "<gateway>[:<port>]", nullptr, nullptr, -1, nullptr,
201 "[DEPRECATED, use /gateway:g:<url>] Gateway Hostname" },
202 { "gateway-usage-method", COMMAND_LINE_VALUE_REQUIRED, "[direct|detect]", nullptr, nullptr, -1,
203 "gum", "[DEPRECATED, use /gateway:usage-method:<method>] Gateway usage method" },
204 { "gd", COMMAND_LINE_VALUE_REQUIRED, "<domain>", nullptr, nullptr, -1, nullptr,
205 "[DEPRECATED, use /gateway:d:<domain>] Gateway domain" },
206#endif
207 { "gdi", COMMAND_LINE_VALUE_REQUIRED, "sw|hw", nullptr, nullptr, -1, nullptr, "GDI rendering" },
208 { "geometry", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
209 "Geometry tracking channel" },
210 { "gestures", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
211 "Consume multitouch input locally" },
212#ifdef WITH_GFX_H264
213 { "gfx", COMMAND_LINE_VALUE_OPTIONAL,
214 "[[progressive[:on|off]|RFX[:on|off]|AVC420[:on|off]AVC444[:on|off]],mask:<value>,small-"
215 "cache[:on|off],thin-client[:on|off],progressive[:on|"
216 "off],frame-ack[:on|off]"
217#if defined(WITH_GFX_AV1)
218 ",AV1[:on|off|i444|i420]]"
219#endif
220 ,
221 nullptr, nullptr, -1, nullptr, "RDP8 graphics pipeline" },
222#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
223 { "gfx-h264", COMMAND_LINE_VALUE_OPTIONAL, "[[AVC420|AVC444],mask:<value>]", nullptr, nullptr,
224 -1, nullptr, "[DEPRECATED, use /gfx:avc420] RDP8.1 graphics pipeline using H264 codec" },
225#endif
226#else
227 { "gfx", COMMAND_LINE_VALUE_OPTIONAL,
228 "[progressive[:on|off]|RFX[:on|off]|AVC420[:on|off]AVC444[:on|off]],mask:<value>,small-cache["
229 ":on|off],thin-client[:on|off],progressive[:on|off]]",
230 nullptr, nullptr, -1, nullptr, "RDP8 graphics pipeline" },
231#endif
232#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
233 { "gfx-progressive", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
234 "[DEPRECATED, use /gfx:progressive] RDP8 graphics pipeline using progressive codec" },
235 { "gfx-small-cache", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
236 "[DEPRECATED, use /gfx:small-cache] RDP8 graphics pipeline using small cache mode" },
237 { "gfx-thin-client", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
238 "[DEPRECATED, use /gfx:thin-client] RDP8 graphics pipeline using thin client mode" },
239 { "glyph-cache", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
240 "[DEPRECATED, use /cache:glyph[:on|off]] Glyph cache (experimental)" },
241#endif
242#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
243 { "gp", COMMAND_LINE_VALUE_REQUIRED, "<password>", nullptr, nullptr, -1, nullptr,
244 "[DEPRECATED, use /gateway:p:<password>] Gateway password" },
245#endif
246 { "grab-keyboard", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
247 "Grab keyboard focus, forward all keys to remote" },
248 { "grab-mouse", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
249 "Grab mouse focus, forward all events to remote" },
250#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
251 { "gt", COMMAND_LINE_VALUE_REQUIRED,
252 "[rpc|http[,no-websockets][,extauth-sspi-ntlm]|auto[,no-websockets][,extauth-sspi-ntlm]]",
253 nullptr, nullptr, -1, nullptr,
254 "[DEPRECATED, use /gateway:type:<type>] Gateway transport type" },
255 { "gu", COMMAND_LINE_VALUE_REQUIRED, "[[<domain>\\]<user>|<user>[@<domain>]]", nullptr, nullptr,
256 -1, nullptr, "[DEPRECATED, use /gateway:u:<user>] Gateway username" },
257 { "gat", COMMAND_LINE_VALUE_REQUIRED, "<access token>", nullptr, nullptr, -1, nullptr,
258 "[DEPRECATED, use /gateway:access-token:<token>] Gateway Access Token" },
259#endif
260 { "h", COMMAND_LINE_VALUE_REQUIRED, "<height>", "768", nullptr, -1, nullptr, "Height" },
261 { "heartbeat", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
262 "Support heartbeat PDUs" },
263 { "help", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT_HELP, nullptr, nullptr, nullptr, -1, "?",
264 "Print help" },
265 { "home-drive", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
266 "Redirect user home as share" },
267 { "ipv4", COMMAND_LINE_VALUE_OPTIONAL, "[:force]", nullptr, nullptr, -1, "4",
268 "Prefer IPv4 A record over IPv6 AAAA record" },
269 { "ipv6", COMMAND_LINE_VALUE_OPTIONAL, "[:force]", nullptr, nullptr, -1, "6",
270 "Prefer IPv6 AAAA record over IPv4 A record" },
271#if defined(WITH_JPEG)
272 { "jpeg", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
273 "JPEG codec support" },
274 { "jpeg-quality", COMMAND_LINE_VALUE_REQUIRED, "<percentage>", nullptr, nullptr, -1, nullptr,
275 "JPEG quality" },
276#endif
277 { "kbd", COMMAND_LINE_VALUE_REQUIRED,
278 "[layout:[0x<id>|<name>],lang:<0x<id>>,fn-key:<value>,type:<value>,subtype:<value>,unicode[:"
279 "on|off],remap:<key1>=<value1>,remap:<key2>=<value2>,pipe:<filename>]",
280 nullptr, nullptr, -1, nullptr,
281 "Keyboard related options:\n"
282 " * layout: set the keybouard layout announced to the server\n"
283 " * lang: set the keyboard language identifier sent to the server\n"
284 " * fn-key: Function key value\n"
285 " * remap: RDP scancode to another one. Use /list:kbd-scancode to get the mapping. Example: "
286 "To switch "
287 "'a' and 's' on a US keyboard: /kbd:remap:0x1e=0x1f,remap:0x1f=0x1e\n"
288 " * pipe: Name of a named pipe that can be used to type text into the RDP session\n" },
289#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
290 { "kbd-lang", COMMAND_LINE_VALUE_REQUIRED, "0x<id>", nullptr, nullptr, -1, nullptr,
291 "[DEPRECATED, use / kbd:lang:<value>] Keyboard active language identifier" },
292 { "kbd-fn-key", COMMAND_LINE_VALUE_REQUIRED, "<value>", nullptr, nullptr, -1, nullptr,
293 "[DEPRECATED, use /kbd:fn-key:<value>] Function key value" },
294 { "kbd-list", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr, -1,
295 nullptr, "[DEPRECATED, use /list:kbd] List keyboard layouts" },
296 { "kbd-scancode-list", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr,
297 -1, nullptr, "[DEPRECATED, use list:kbd-scancode] List keyboard RDP scancodes" },
298 { "kbd-lang-list", COMMAND_LINE_VALUE_OPTIONAL | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr,
299 -1, nullptr, "[DEPRECATED, use /list:kbd-lang] List keyboard languages" },
300 { "kbd-remap", COMMAND_LINE_VALUE_REQUIRED,
301 "[DEPRECATED, use /kbd:remap] List of <key>=<value>,... pairs to remap scancodes", nullptr,
302 nullptr, -1, nullptr, "Keyboard scancode remapping" },
303 { "kbd-subtype", COMMAND_LINE_VALUE_REQUIRED, "<id>", nullptr, nullptr, -1, nullptr,
304 "[DEPRECATED, use /kbd:subtype]Keyboard subtype" },
305 { "kbd-type", COMMAND_LINE_VALUE_REQUIRED, "<id>", nullptr, nullptr, -1, nullptr,
306 "[DEPRECATED, use /kbd:type] Keyboard type" },
307 { "kbd-unicode", COMMAND_LINE_VALUE_FLAG, "", nullptr, nullptr, -1, nullptr,
308 "[DEPRECATED, use /kbd:unicode[:on|off]] Send unicode symbols, e.g. use the local "
309 "keyboard map. ATTENTION: Does not work with every "
310 "RDP server!" },
311#endif
312 { "kerberos", COMMAND_LINE_VALUE_REQUIRED,
313 "[kdc-url:<url>,lifetime:<time>,start-time:<time>,renewable-lifetime:<time>,cache:<path>,"
314 "armor:<path>,pkinit-anchors:<path>,pkcs11-module:<name>]",
315 nullptr, nullptr, -1, nullptr, "Kerberos options" },
316 { "load-balance-info", COMMAND_LINE_VALUE_REQUIRED, "<info-string>", nullptr, nullptr, -1,
317 nullptr, "Load balance info" },
318 { "list", COMMAND_LINE_VALUE_REQUIRED | COMMAND_LINE_PRINT,
319 "[kbd|kbd-scancode|kbd-lang[:<value>]|smartcard[:[pkinit-anchors:<path>][,pkcs11-module:<"
320 "name>]]|"
321 "monitor|tune|timezones]",
322 "List available options for subcommand", nullptr, -1, nullptr,
323 "List available options for subcommand" },
324 { "log-filters", COMMAND_LINE_VALUE_REQUIRED, "<tag>:<level>[,<tag>:<level>[,...]]", nullptr,
325 nullptr, -1, nullptr, "Set logger filters, see wLog(7) for details" },
326 { "log-level", COMMAND_LINE_VALUE_REQUIRED, "[OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE]", nullptr,
327 nullptr, -1, nullptr, "Set the default log level, see wLog(7) for details" },
328 { "max-fast-path-size", COMMAND_LINE_VALUE_REQUIRED, "<size>", nullptr, nullptr, -1, nullptr,
329 "Specify maximum fast-path update size" },
330 { "max-loop-time", COMMAND_LINE_VALUE_REQUIRED, "<time>", nullptr, nullptr, -1, nullptr,
331 "Specify maximum time in milliseconds spend treating packets" },
332 { "menu-anims", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
333 "menu animations" },
334 { "microphone", COMMAND_LINE_VALUE_OPTIONAL,
335 "[sys:<sys>,][dev:<dev>,][format:<format>,][rate:<rate>,][channel:<channel>]", nullptr,
336 nullptr, -1, "mic", "Audio input (microphone)" },
337#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
338 { "smartcard-list", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr, -1,
339 nullptr, "[DEPRECATED, use /list:smartcard] List smartcard information" },
340 { "monitor-list", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr, -1,
341 nullptr, "[DEPRECATED, use /list:monitor] List detected monitors" },
342#endif
343 { "monitors", COMMAND_LINE_VALUE_REQUIRED, "<id>[,<id>[,...]]", nullptr, nullptr, -1, nullptr,
344 "[experimental] Select monitors to use (only effective in fullscreen or multimonitor mode)" },
345 { "mouse-motion", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
346 "Send mouse motion events" },
347 { "mouse-relative", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
348 "Send mouse motion with relative addressing" },
349 { "mouse", COMMAND_LINE_VALUE_REQUIRED, "[relative:[on|off],grab:[on|off]]", nullptr, nullptr,
350 -1, nullptr,
351 "Mouse related options:\n"
352 " * relative: send relative mouse movements if supported by server\n"
353 " * grab: grab the mouse if within the window" },
354#if defined(CHANNEL_TSMF_CLIENT)
355 { "multimedia", COMMAND_LINE_VALUE_OPTIONAL, "[sys:<sys>,][dev:<dev>,][decoder:<decoder>]",
356 nullptr, nullptr, -1, "mmr", "[DEPRECATED], use /video] Redirect multimedia (video)" },
357#endif
358 { "multimon", COMMAND_LINE_VALUE_OPTIONAL, "force", nullptr, nullptr, -1, nullptr,
359 "Use multiple monitors" },
360 { "multitouch", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
361 "Redirect multitouch input" },
362 { "multitransport", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
363 "Support multitransport protocol" },
364 { "nego", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
365 "protocol security negotiation" },
366 { "network", COMMAND_LINE_VALUE_REQUIRED,
367 "[invalid|modem|broadband|broadband-low|broadband-high|wan|lan|auto]", nullptr, nullptr, -1,
368 nullptr, "Network connection type" },
369 { "nsc", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "nscodec", "NSCodec support" },
370#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
371 { "offscreen-cache", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
372 "[DEPRECATED, use /cache:offscreen[:on|off]] offscreen bitmap cache" },
373#endif
374 { "orientation", COMMAND_LINE_VALUE_REQUIRED, "[0|90|180|270]", nullptr, nullptr, -1, nullptr,
375 "Orientation of display in degrees" },
376 { "old-license", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
377 "Use the old license workflow (no CAL and hwId set to 0)" },
378 { "p", COMMAND_LINE_VALUE_OPTIONAL, "<password>", nullptr, nullptr, -1, nullptr,
379 "Password. Pass /p without arguments to silences interactive password prompts if no "
380 "credentials are required for the connection." },
381#if defined(CHANNEL_PARALLEL_CLIENT)
382 { "parallel", COMMAND_LINE_VALUE_OPTIONAL, "<name>[,<path>]", nullptr, nullptr, -1, nullptr,
383 "Redirect parallel device" },
384#endif
385 { "parent-window", COMMAND_LINE_VALUE_REQUIRED, "<window-id>", nullptr, nullptr, -1, nullptr,
386 "Parent window id" },
387 { "pcb", COMMAND_LINE_VALUE_REQUIRED, "<blob>", nullptr, nullptr, -1, nullptr,
388 "Preconnection Blob" },
389 { "pcid", COMMAND_LINE_VALUE_REQUIRED, "<id>", nullptr, nullptr, -1, nullptr,
390 "Preconnection Id" },
391 { "pheight", COMMAND_LINE_VALUE_REQUIRED, "<height>", nullptr, nullptr, -1, nullptr,
392 "Physical height of display (in millimeters)" },
393 { "play-rfx", COMMAND_LINE_VALUE_REQUIRED, "<pcap-file>", nullptr, nullptr, -1, nullptr,
394 "Replay rfx pcap file" },
395 { "port", COMMAND_LINE_VALUE_REQUIRED, "<number>", nullptr, nullptr, -1, nullptr,
396 "Server port" },
397 { "suppress-output", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
398 "suppress output when minimized" },
399 { "print-reconnect-cookie", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1,
400 nullptr, "Print base64 reconnect cookie after connecting" },
401 { "printer", COMMAND_LINE_VALUE_OPTIONAL, "<name>[,<driver>[,default]]", nullptr, nullptr, -1,
402 nullptr, "Redirect printer device" },
403 { "proxy", COMMAND_LINE_VALUE_REQUIRED, "[<proto>://][<user>:<password>@]<host>[:<port>]",
404 nullptr, nullptr, -1, nullptr,
405 "Proxy settings: override env. var (see also environment variable below). Protocol "
406 "\"socks5\" should be given explicitly where \"http\" is default." },
407 { "pth", COMMAND_LINE_VALUE_REQUIRED, "<password-hash>", nullptr, nullptr, -1, "pass-the-hash",
408 "Pass the hash (restricted admin mode)" },
409 { "pwidth", COMMAND_LINE_VALUE_REQUIRED, "<width>", nullptr, nullptr, -1, nullptr,
410 "Physical width of display (in millimeters)" },
411#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
412 { "rdp2tcp", COMMAND_LINE_VALUE_REQUIRED, "<executable path[:arg...]>", nullptr, nullptr, -1,
413 nullptr, "TCP redirection" },
414#endif
415 { "reconnect-cookie", COMMAND_LINE_VALUE_REQUIRED, "<base64-cookie>", nullptr, nullptr, -1,
416 nullptr, "Pass base64 reconnect cookie to the connection" },
417 { "redirect-prefer", COMMAND_LINE_VALUE_REQUIRED, "<FQDN|IP|NETBIOS>,[...]", nullptr, nullptr,
418 -1, nullptr, "Override the preferred redirection order" },
419 { "relax-order-checks", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1,
420 "relax-order-checks",
421 "Do not check if a RDP order was announced during capability exchange, only use when "
422 "connecting to a buggy server" },
423 { "restricted-admin", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "restrictedAdmin",
424 "Restricted admin mode" },
425#ifdef CHANNEL_RDPEAR_CLIENT
426 { "remoteGuard", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "remoteGuard",
427 "Remote guard credentials" },
428#endif
429 { "rfx", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr, "RemoteFX" },
430 { "rfx-mode", COMMAND_LINE_VALUE_REQUIRED, "[image|video]", nullptr, nullptr, -1, nullptr,
431 "RemoteFX mode" },
432 { "scale", COMMAND_LINE_VALUE_REQUIRED, "[100|140|180]", "100", nullptr, -1, nullptr,
433 "Scaling factor of the display" },
434 { "scale-desktop", COMMAND_LINE_VALUE_REQUIRED, "<percentage>", "100", nullptr, -1, nullptr,
435 "Scaling factor for desktop applications (value between 100 and 500)" },
436 { "scale-device", COMMAND_LINE_VALUE_REQUIRED, "100|140|180", "100", nullptr, -1, nullptr,
437 "Scaling factor for app store applications" },
438 { "sec", COMMAND_LINE_VALUE_REQUIRED,
439 "rdp[:[on|off]]|tls[:[on|off]]|nla[:[on|off]]|ext[:[on|off]]|aad[:[on|off]]", nullptr,
440 nullptr, -1, nullptr,
441 "Force specific protocol security. e.g. /sec:nla enables NLA and disables all others, while "
442 "/sec:nla:[on|off] just toggles NLA" },
443#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
444 { "sec-ext", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
445 "[DEPRECATED, use /sec:ext] NLA extended protocol security" },
446 { "sec-nla", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
447 "[DEPRECATED, use /sec:nla] NLA protocol security" },
448 { "sec-rdp", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
449 "[DEPRECATED, use /sec:rdp] RDP protocol security" },
450 { "sec-tls", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
451 "[DEPRECATED, use /sec:tls] TLS protocol security" },
452#endif
453#if defined(CHANNEL_SERIAL_CLIENT)
454 { "serial", COMMAND_LINE_VALUE_OPTIONAL, "<name>[,<path>[,<driver>[,permissive]]]", nullptr,
455 nullptr, -1, "tty", "Redirect serial device" },
456#endif
457 { "server-name", COMMAND_LINE_VALUE_REQUIRED, "<name>", nullptr, nullptr, -1, nullptr,
458 "User-specified server name to use for validation (TLS, Kerberos)" },
459 { "shell", COMMAND_LINE_VALUE_REQUIRED, "<shell>", nullptr, nullptr, -1, nullptr,
460 "Alternate shell" },
461 { "shell-dir", COMMAND_LINE_VALUE_REQUIRED, "<dir>", nullptr, nullptr, -1, nullptr,
462 "Shell working directory" },
463 { "size", COMMAND_LINE_VALUE_REQUIRED, "<width>x<height> or <percent>%[wh]", "1024x768",
464 nullptr, -1, nullptr, "Screen size" },
465 { "smart-sizing", COMMAND_LINE_VALUE_OPTIONAL, "<width>x<height>", nullptr, nullptr, -1,
466 nullptr, "Scale remote desktop to window size" },
467 { "smartcard", COMMAND_LINE_VALUE_OPTIONAL, "<str>[,<str>...]", nullptr, nullptr, -1, nullptr,
468 "Redirect the smartcard devices containing any of the <str> in their names." },
469 { "smartcard-logon", COMMAND_LINE_VALUE_OPTIONAL,
470 "[[cert:<path>|cert:<base64(PEM)>],[key:<path>|key:<base64(PEM)>],pin:<pin>,csp:<csp "
471 "name>,reader:<reader>,card:<card>]",
472 nullptr, nullptr, -1, nullptr,
473 "Activates Smartcard (optional certificate) Logon authentication." },
474 { "sound", COMMAND_LINE_VALUE_OPTIONAL,
475 "[sys:<sys>,][dev:<dev>,][format:<format>,][rate:<rate>,][channel:<channel>,][latency:<"
476 "latency>,][quality:<quality>]",
477 nullptr, nullptr, -1, "audio", "Audio output (sound)" },
478 { "span", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
479 "Span screen over multiple monitors" },
480 { "spn-class", COMMAND_LINE_VALUE_REQUIRED, "<service-class>", nullptr, nullptr, -1, nullptr,
481 "SPN authentication service class" },
482 { "ssh-agent", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, "ssh-agent",
483 "SSH Agent forwarding channel" },
484 { "sspi-module", COMMAND_LINE_VALUE_REQUIRED, "<SSPI module path>", nullptr, nullptr, -1,
485 nullptr, "SSPI shared library module file path" },
486 { "winscard-module", COMMAND_LINE_VALUE_REQUIRED, "<WinSCard module path>", nullptr, nullptr,
487 -1, nullptr, "WinSCard shared library module file path" },
488 { "disable-output", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
489 "Deactivate all graphics decoding in the client session. Useful for load tests with many "
490 "simultaneous connections" },
491 { "t", COMMAND_LINE_VALUE_REQUIRED, "<title>", nullptr, nullptr, -1, "title", "Window title" },
492 { "themes", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr, "themes" },
493 { "timeout", COMMAND_LINE_VALUE_REQUIRED, "<time in ms>", "9000", nullptr, -1, "timeout",
494 "Advanced setting for high latency links: Adjust connection timeout, use if you encounter "
495 "timeout failures with your connection" },
496 { "timezone", COMMAND_LINE_VALUE_REQUIRED, "<windows timezone>", nullptr, nullptr, -1, nullptr,
497 "Use supplied windows timezone for connection (requires server support), see /list:timezones "
498 "for allowed values" },
499 { "tls", COMMAND_LINE_VALUE_REQUIRED, "[ciphers|seclevel|secrets-file|enforce]", nullptr,
500 nullptr, -1, nullptr,
501 "TLS configuration options:"
502 " * ciphers:[netmon|ma|<cipher names>]\n"
503 " * seclevel:<level>, default: 1, range: [0-5] Override the default TLS security level, "
504 "might be required for older target servers. Details at "
505 "https://docs.openssl.org/3.0/man3/SSL_CTX_set_security_level/\n"
506 " * secrets-file:<filename>\n"
507 " * enforce[:[ssl3|1.0|1.1|1.2|1.3]] Force use of SSL/TLS version for a connection. Some "
508 "servers have a buggy TLS "
509 "version negotiation and might fail without this. Defaults to TLS 1.2 if no argument is "
510 "supplied. Use 1.0 for windows 7" },
511#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
512 { "tls-ciphers", COMMAND_LINE_VALUE_REQUIRED, "[netmon|ma|ciphers]", nullptr, nullptr, -1,
513 nullptr, "[DEPRECATED, use /tls:ciphers] Allowed TLS ciphers" },
514 { "tls-seclevel", COMMAND_LINE_VALUE_REQUIRED, "<level>", "1", nullptr, -1, nullptr,
515 "[DEPRECATED, use /tls:seclevel] TLS security level - defaults to 1" },
516 { "tls-secrets-file", COMMAND_LINE_VALUE_REQUIRED, "<filename>", nullptr, nullptr, -1, nullptr,
517 "[DEPRECATED, use /tls:secrets:file] File were TLS secrets will be stored in the "
518 "SSLKEYLOGFILE format" },
519 { "enforce-tlsv1_2", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
520 "[DEPRECATED, use /tls:enforce:1.2] Force use of TLS1.2 for connection. Some "
521 "servers have a buggy TLS version negotiation and "
522 "might fail without this" },
523#endif
524 { "toggle-fullscreen", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
525 "Alt+Ctrl+Enter to toggle fullscreen" },
526 { "tune", COMMAND_LINE_VALUE_REQUIRED, "<setting:value>,<setting:value>", "", nullptr, -1,
527 nullptr, "[experimental] directly manipulate freerdp settings, use with extreme caution!" },
528#if defined(WITH_FREERDP_DEPRECATED_COMMANDLINE)
529 { "tune-list", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT, nullptr, nullptr, nullptr, -1,
530 nullptr, "[DEPRECATED, use /list:tune] Print options allowed for /tune" },
531#endif
532 { "u", COMMAND_LINE_VALUE_REQUIRED, "[[<domain>\\]<user>|<user>[@<domain>]]", nullptr, nullptr,
533 -1, nullptr, "Username" },
534 { "unmap-buttons", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
535 "Let server see real physical pointer button" },
536#ifdef CHANNEL_URBDRC_CLIENT
537 { "usb", COMMAND_LINE_VALUE_REQUIRED,
538 "[dbg,][id:<vid>:<pid>#...,][addr:<bus>:<addr>#...,][auto]", nullptr, nullptr, -1, nullptr,
539 "Redirect USB device" },
540#endif
541 { "v", COMMAND_LINE_VALUE_REQUIRED, "<server>[:port]", nullptr, nullptr, -1, nullptr,
542 "Server hostname|URL|IPv4|IPv6 or vsock://<number> or /some/path/to/pipe or |:1234 to pass a "
543 "TCP socket to use" },
544 { "vc", COMMAND_LINE_VALUE_REQUIRED, "<channel>[,<options>]", nullptr, nullptr, -1, nullptr,
545 "Static virtual channel" },
546 { "version", COMMAND_LINE_VALUE_FLAG | COMMAND_LINE_PRINT_VERSION, nullptr, nullptr, nullptr,
547 -1, nullptr, "Print version" },
548 { "video", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
549 "Video optimized remoting channel" },
550 { "prevent-session-lock", COMMAND_LINE_VALUE_OPTIONAL, "<time in sec>", nullptr, nullptr, -1,
551 nullptr,
552 "Prevent session locking by injecting fake mouse motion events to the server "
553 "when the connection is idle (default interval: 180 seconds)" },
554 { "vmconnect", COMMAND_LINE_VALUE_OPTIONAL, "<vmid>", nullptr, nullptr, -1, nullptr,
555 "Hyper-V console (use port 2179, disable negotiation)" },
556 { "w", COMMAND_LINE_VALUE_REQUIRED, "<width>", "1024", nullptr, -1, nullptr, "Width" },
557 { "wallpaper", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueTrue, nullptr, -1, nullptr,
558 "wallpaper" },
559 { "window-drag", COMMAND_LINE_VALUE_BOOL, nullptr, BoolValueFalse, nullptr, -1, nullptr,
560 "full window drag" },
561 { "window-position", COMMAND_LINE_VALUE_REQUIRED, "<xpos>x<ypos>", nullptr, nullptr, -1,
562 nullptr, "window position" },
563 { "wm-class", COMMAND_LINE_VALUE_REQUIRED, "<class-name>", nullptr, nullptr, -1, nullptr,
564 "Set the WM_CLASS hint for the window instance" },
565 { "workarea", COMMAND_LINE_VALUE_FLAG, nullptr, nullptr, nullptr, -1, nullptr,
566 "Use available work area" },
567 { nullptr, 0, nullptr, nullptr, nullptr, -1, nullptr, nullptr }
568};
569#endif /* CLIENT_COMMON_CMDLINE_H */
COMMAND_LINE_ARGUMENT_A
Definition winpr/include/winpr/cmdline.h:100