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