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