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