1 '\" t
2 .\" Title: xfreerdp
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2018-08-19
6 .\" Manual: xfreerdp
7 .\" Source: freerdp
8 .\" Language: English
9 .\"
10 .TH "XFREERDP" "1" "2018\-08\-19" "freerdp" "xfreerdp"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30
31
32
33 .SH "NAME"
34 xfreerdp \- FreeRDP X11 client
35
36 .SH "SYNOPSIS"
37
38
39 .PP
40 \fBxfreerdp\fR
41 [file] [options] [/v:server[:port]]
42
43
44 .SH "DESCRIPTION"
45
46
47
48 .PP
49 \fBxfreerdp\fR
50 is an X11 Remote Desktop Protocol (RDP) client which is part of the FreeRDP project\&. An RDP server is built\-in to many editions of Windows\&. Alternative servers included xrdp and VRDP (VirtualBox)\&.
51
52
53
54 .SH "OPTIONS"
55
56
57
58
59 .PP
60 \fB/a\fR:\fIaddin\fR[,\fIoptions\fR], \fB/addin\fR:\fIaddin\fR[,\fIoptions\fR]
61 .RS 4
62
63
64
65
66 Addin
67
68
69 .RE
70 .PP
71 \fB/action\-script\fR:\fIfile\-name\fR
72 .RS 4
73
74
75
76 Action script (default:~/\&.config/freerdp/action\&.sh)
77
78
79 .RE
80 .PP
81 \fB/admin\fR, \fB/console\fR
82 .RS 4
83
84
85
86
87 Admin (or console) session
88
89
90 .RE
91 .PP
92 \fB+aero\fR
93 .RS 4
94
95
96
97 desktop composition (default:off)
98
99
100 .RE
101 .PP
102 \fB/app\fR:\fIpath\fR or ||\fIalias\fR
103 .RS 4
104
105
106
107 Remote application program
108
109
110 .RE
111 .PP
112 \fB/app\-cmd\fR:\fIparameters\fR
113 .RS 4
114
115
116
117 Remote application command\-line parameters
118
119
120 .RE
121 .PP
122 \fB/app\-file\fR:\fIfile\-name\fR
123 .RS 4
124
125
126
127 File to open with remote application
128
129
130 .RE
131 .PP
132 \fB/app\-guid\fR:\fIapp\-guid\fR
133 .RS 4
134
135
136
137 Remote application GUID
138
139
140 .RE
141 .PP
142 \fB/app\-icon\fR:\fIicon\-path\fR
143 .RS 4
144
145
146
147 Remote application icon for user interface
148
149
150 .RE
151 .PP
152 \fB/app\-name\fR:\fIapp\-name\fR
153 .RS 4
154
155
156
157 Remote application name for user interface
158
159
160 .RE
161 .PP
162 \fB/assistance\fR:\fIpassword\fR
163 .RS 4
164
165
166
167 Remote assistance password
168
169
170 .RE
171 .PP
172 \fB+async\-channels\fR
173 .RS 4
174
175
176
177 Asynchronous channels (experimental) (default:off)
178
179
180 .RE
181 .PP
182 \fB+async\-input\fR
183 .RS 4
184
185
186
187 Asynchronous input (default:off)
188
189
190 .RE
191 .PP
192 \fB+async\-transport\fR
193 .RS 4
194
195
196
197 Asynchronous transport (experimental) (default:off)
198
199
200 .RE
201 .PP
202 \fB+async\-update\fR
203 .RS 4
204
205
206
207 Asynchronous update (default:off)
208
209
210 .RE
211 .PP
212 \fB/audio\-mode\fR:\fImode\fR
213 .RS 4
214
215
216
217 Audio output mode
218
219
220 .RE
221 .PP
222 \fB+auth\-only\fR
223 .RS 4
224
225
226
227 Authenticate only (default:off)
228
229
230 .RE
231 .PP
232 \fB\-authentication\fR
233 .RS 4
234
235
236
237 Authentication (expermiental) (default:on)
238
239
240 .RE
241 .PP
242 \fB+auto\-reconnect\fR
243 .RS 4
244
245
246
247 Automatic reconnection (default:off)
248
249
250 .RE
251 .PP
252 \fB/auto\-reconnect\-max\-retries\fR:\fIretries\fR
253 .RS 4
254
255
256
257 Automatic reconnection maximum retries, 0 for unlimited [0,1000]
258
259
260 .RE
261 .PP
262 \fB\-bitmap\-cache\fR
263 .RS 4
264
265
266
267 bitmap cache (default:on)
268
269
270 .RE
271 .PP
272 \fB/bpp\fR:\fIdepth\fR
273 .RS 4
274
275
276
277 Session bpp (color depth) (default:16)
278
279
280 .RE
281 .PP
282 \fB/buildconfig\fR
283 .RS 4
284
285
286
287 Print the build configuration
288
289
290 .RE
291 .PP
292 \fB/cert\-ignore\fR
293 .RS 4
294
295
296
297 Ignore certificate
298
299
300 .RE
301 .PP
302 \fB/cert\-name\fR:\fIname\fR
303 .RS 4
304
305
306
307 Certificate name
308
309
310 .RE
311 .PP
312 \fB/cert\-tofu\fR
313 .RS 4
314
315
316
317 Automatically accept certificate on first connect
318
319
320 .RE
321 .PP
322 \fB/client\-hostname\fR:\fIname\fR
323 .RS 4
324
325
326
327 Client Hostname to send to server
328
329
330 .RE
331 .PP
332 \fB\-clipboard\fR
333 .RS 4
334
335
336
337 Redirect clipboard (default:on)
338
339
340 .RE
341 .PP
342 \fB/codec\-cache\fR:rfx|nsc|jpeg
343 .RS 4
344
345
346
347 Bitmap codec cache
348
349
350 .RE
351 .PP
352 \fB\-compression\fR, \fB\-z\fR
353 .RS 4
354
355
356
357
358 compression (default:on)
359
360
361 .RE
362 .PP
363 \fB/compression\-level\fR:\fIlevel\fR
364 .RS 4
365
366
367
368 Compression level (0,1,2)
369
370
371 .RE
372 .PP
373 \fB+credentials\-delegation\fR
374 .RS 4
375
376
377
378 credentials delegation (default:off)
379
380
381 .RE
382 .PP
383 \fB/d\fR:\fIdomain\fR
384 .RS 4
385
386
387
388 Domain
389
390
391 .RE
392 .PP
393 \fB\-decorations\fR
394 .RS 4
395
396
397
398 Window decorations (default:on)
399
400
401 .RE
402 .PP
403 \fB/disp\fR
404 .RS 4
405
406
407
408 Display control
409
410
411 .RE
412 .PP
413 \fB/drive\fR:\fIname\fR,\fIpath\fR
414 .RS 4
415
416
417
418 Redirect directory <path< as named share <name<
419
420
421 .RE
422 .PP
423 \fB+drives\fR
424 .RS 4
425
426
427
428 Redirect all mount points as shares (default:off)
429
430
431 .RE
432 .PP
433 \fB/dvc\fR:\fIchannel\fR[,\fIoptions\fR]
434 .RS 4
435
436
437
438 Dynamic virtual channel
439
440
441 .RE
442 .PP
443 \fB/dynamic\-resolution\fR
444 .RS 4
445
446
447
448 Send resolution updates when the window is resized
449
450
451 .RE
452 .PP
453 \fB/echo\fR, \fB/echo\fR
454 .RS 4
455
456
457
458
459 Echo channel
460
461
462 .RE
463 .PP
464 \fB\-encryption\fR
465 .RS 4
466
467
468
469 Encryption (experimental) (default:on)
470
471
472 .RE
473 .PP
474 \fB/encryption\-methods\fR:[40,][56,][128,][FIPS]
475 .RS 4
476
477
478
479 RDP standard security encryption methods
480
481
482 .RE
483 .PP
484 \fB/f\fR
485 .RS 4
486
487
488
489 Fullscreen mode (<Ctrl<+<Alt<+<Enter< toggles fullscreen)
490
491
492 .RE
493 .PP
494 \fB\-fast\-path\fR
495 .RS 4
496
497
498
499 fast\-path input/output (default:on)
500
501
502 .RE
503 .PP
504 \fB+fipsmode\fR
505 .RS 4
506
507
508
509 FIPS mode (default:off)
510
511
512 .RE
513 .PP
514 \fB+fonts\fR
515 .RS 4
516
517
518
519 smooth fonts (ClearType) (default:off)
520
521
522 .RE
523 .PP
524 \fB/frame\-ack\fR:\fInumber\fR
525 .RS 4
526
527
528
529 Number of frame acknowledgement
530
531
532 .RE
533 .PP
534 \fB/from\-stdin\fR[:force]
535 .RS 4
536
537
538
539 Read credentials from stdin\&. With <force< the prompt is done before connection, otherwise on server request\&.
540
541
542 .RE
543 .PP
544 \fB/g\fR:\fIgateway\fR[:\fIport\fR]
545 .RS 4
546
547
548
549 Gateway Hostname
550
551
552 .RE
553 .PP
554 \fB/gateway\-usage\-method\fR:direct|detect, \fB/gum\fR:direct|detect
555 .RS 4
556
557
558
559
560 Gateway usage method
561
562
563 .RE
564 .PP
565 \fB/gd\fR:\fIdomain\fR
566 .RS 4
567
568
569
570 Gateway domain
571
572
573 .RE
574 .PP
575 \fB/gdi\fR:sw|hw
576 .RS 4
577
578
579
580 GDI rendering
581
582
583 .RE
584 .PP
585 \fB/geometry\fR
586 .RS 4
587
588
589
590 Geometry tracking channel
591
592
593 .RE
594 .PP
595 \fB+gestures\fR
596 .RS 4
597
598
599
600 Consume multitouch input locally (default:off)
601
602
603 .RE
604 .PP
605 \fB/gfx\fR[:RFX]
606 .RS 4
607
608
609
610 RDP8 graphics pipeline (experimental)
611
612
613 .RE
614 .PP
615 \fB+gfx\-progressive\fR
616 .RS 4
617
618
619
620 RDP8 graphics pipeline using progressive codec (default:off)
621
622
623 .RE
624 .PP
625 \fB+gfx\-small\-cache\fR
626 .RS 4
627
628
629
630 RDP8 graphics pipeline using small cache mode (default:off)
631
632
633 .RE
634 .PP
635 \fB+gfx\-thin\-client\fR
636 .RS 4
637
638
639
640 RDP8 graphics pipeline using thin client mode (default:off)
641
642
643 .RE
644 .PP
645 \fB+glyph\-cache\fR
646 .RS 4
647
648
649
650 Glyph cache (experimental) (default:off)
651
652
653 .RE
654 .PP
655 \fB/gp\fR:\fIpassword\fR
656 .RS 4
657
658
659
660 Gateway password
661
662
663 .RE
664 .PP
665 \fB\-grab\-keyboard\fR
666 .RS 4
667
668
669
670 Grab keyboard (default:on)
671
672
673 .RE
674 .PP
675 \fB/gt\fR:rpc|http|auto
676 .RS 4
677
678
679
680 Gateway transport type
681
682
683 .RE
684 .PP
685 \fB/gu\fR:[\fIdomain\fR\e]\fIuser\fR or \fIuser\fR[@\fIdomain\fR]
686 .RS 4
687
688
689
690 Gateway username
691
692
693 .RE
694 .PP
695 \fB/gat\fR:\fIaccess token\fR
696 .RS 4
697
698
699
700 Gateway Access Token
701
702
703 .RE
704 .PP
705 \fB/h\fR:\fIheight\fR
706 .RS 4
707
708
709
710 Height (default:768)
711
712
713 .RE
714 .PP
715 \fB+heartbeat\fR
716 .RS 4
717
718
719
720 Support heartbeat PDUs (default:off)
721
722
723 .RE
724 .PP
725 \fB/help\fR, \fB/?\fR
726 .RS 4
727
728
729
730
731 Print help
732
733
734 .RE
735 .PP
736 \fB+home\-drive\fR
737 .RS 4
738
739
740
741 Redirect user home as share (default:off)
742
743
744 .RE
745 .PP
746 \fB/ipv6\fR, \fB/6\fR
747 .RS 4
748
749
750
751
752 Prefer IPv6 AAA record over IPv4 A record
753
754
755 .RE
756 .PP
757 \fB/kbd\fR:0x\fIid\fR or \fIname\fR
758 .RS 4
759
760
761
762 Keyboard layout
763
764
765 .RE
766 .PP
767 \fB/kbd\-fn\-key\fR:\fIvalue\fR
768 .RS 4
769
770
771
772 Function key value
773
774
775 .RE
776 .PP
777 \fB/kbd\-list\fR
778 .RS 4
779
780
781
782 List keyboard layouts
783
784
785 .RE
786 .PP
787 \fB/kbd\-subtype\fR:\fIid\fR
788 .RS 4
789
790
791
792 Keyboard subtype
793
794
795 .RE
796 .PP
797 \fB/kbd\-type\fR:\fIid\fR
798 .RS 4
799
800
801
802 Keyboard type
803
804
805 .RE
806 .PP
807 \fB/load\-balance\-info\fR:\fIinfo\-string\fR
808 .RS 4
809
810
811
812 Load balance info
813
814
815 .RE
816 .PP
817 \fB/log\-filters\fR:\fItag\fR:\fIlevel\fR[,\fItag\fR:\fIlevel\fR[,\&.\&.\&.]]
818 .RS 4
819
820
821
822 Set logger filters, see wLog(7) for details
823
824
825 .RE
826 .PP
827 \fB/log\-level\fR:OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE
828 .RS 4
829
830
831
832 Set the default log level, see wLog(7) for details
833
834
835 .RE
836 .PP
837 \fB/max\-fast\-path\-size\fR:\fIsize\fR
838 .RS 4
839
840
841
842 Specify maximum fast\-path update size
843
844
845 .RE
846 .PP
847 \fB/max\-loop\-time\fR:\fItime\fR
848 .RS 4
849
850
851
852 Specify maximum time in milliseconds spend treating packets
853
854
855 .RE
856 .PP
857 \fB+menu\-anims\fR
858 .RS 4
859
860
861
862 menu animations (default:off)
863
864
865 .RE
866 .PP
867 \fB/microphone\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR]], \fB/mic\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR]]
868 .RS 4
869
870
871
872
873 Audio input (microphone)
874
875
876 .RE
877 .PP
878 \fB/monitor\-list\fR
879 .RS 4
880
881
882
883 List detected monitors
884
885
886 .RE
887 .PP
888 \fB/monitors\fR:\fIid\fR[,\fIid\fR[,\&.\&.\&.]]
889 .RS 4
890
891
892
893 Select monitors to use
894
895
896 .RE
897 .PP
898 \fB\-mouse\-motion\fR
899 .RS 4
900
901
902
903 Send mouse motion (default:on)
904
905
906 .RE
907 .PP
908 \fB/multimedia\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][decoder:\fIdecoder\fR]], \fB/mmr\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][decoder:\fIdecoder\fR]]
909 .RS 4
910
911
912
913
914 Redirect multimedia (video)
915
916
917 .RE
918 .PP
919 \fB/multimon\fR[:force]
920 .RS 4
921
922
923
924 Use multiple monitors
925
926
927 .RE
928 .PP
929 \fB+multitouch\fR
930 .RS 4
931
932
933
934 Redirect multitouch input (default:off)
935
936
937 .RE
938 .PP
939 \fB+multitransport\fR
940 .RS 4
941
942
943
944 Support multitransport protocol (default:off)
945
946
947 .RE
948 .PP
949 \fB\-nego\fR
950 .RS 4
951
952
953
954 protocol security negotiation (default:on)
955
956
957 .RE
958 .PP
959 \fB/network\fR:modem|broadband|broadband\-low|broadband\-high|wan|lan|auto
960 .RS 4
961
962
963
964 Network connection type
965
966
967 .RE
968 .PP
969 \fB/nsc\fR, \fB/nscodec\fR
970 .RS 4
971
972
973
974
975 NSCodec support
976
977
978 .RE
979 .PP
980 \fB\-offscreen\-cache\fR
981 .RS 4
982
983
984
985 offscreen bitmap cache (default:on)
986
987
988 .RE
989 .PP
990 \fB/orientation\fR:0|90|180|270
991 .RS 4
992
993
994
995 Orientation of display in degrees
996
997
998 .RE
999 .PP
1000 \fB/p\fR:\fIpassword\fR
1001 .RS 4
1002
1003
1004
1005 Password
1006
1007
1008 .RE
1009 .PP
1010 \fB/parallel\fR[:\fIname\fR[,\fIpath\fR]]
1011 .RS 4
1012
1013
1014
1015 Redirect parallel device
1016
1017
1018 .RE
1019 .PP
1020 \fB/parent\-window\fR:\fIwindow\-id\fR
1021 .RS 4
1022
1023
1024
1025 Parent window id
1026
1027
1028 .RE
1029 .PP
1030 \fB+password\-is\-pin\fR
1031 .RS 4
1032
1033
1034
1035 Use smart card authentication with password as smart card PIN (default:off)
1036
1037
1038 .RE
1039 .PP
1040 \fB/pcb\fR:\fIblob\fR
1041 .RS 4
1042
1043
1044
1045 Preconnection Blob
1046
1047
1048 .RE
1049 .PP
1050 \fB/pcid\fR:\fIid\fR
1051 .RS 4
1052
1053
1054
1055 Preconnection Id
1056
1057
1058 .RE
1059 .PP
1060 \fB/pheight\fR:\fIheight\fR
1061 .RS 4
1062
1063
1064
1065 Physical height of display (in millimeters)
1066
1067
1068 .RE
1069 .PP
1070 \fB/play\-rfx\fR:\fIpcap\-file\fR
1071 .RS 4
1072
1073
1074
1075 Replay rfx pcap file
1076
1077
1078 .RE
1079 .PP
1080 \fB/port\fR:\fInumber\fR
1081 .RS 4
1082
1083
1084
1085 Server port
1086
1087
1088 .RE
1089 .PP
1090 \fB+print\-reconnect\-cookie\fR
1091 .RS 4
1092
1093
1094
1095 Print base64 reconnect cookie after connecting (default:off)
1096
1097
1098 .RE
1099 .PP
1100 \fB/printer\fR[:\fIname\fR[,\fIdriver\fR]]
1101 .RS 4
1102
1103
1104
1105 Redirect printer device
1106
1107
1108 .RE
1109 .PP
1110 \fB/proxy\fR:[\fIproto\fR://][\fIuser\fR:\fIpassword\fR@]\fIhost\fR:\fIport\fR
1111 .RS 4
1112
1113
1114
1115 Proxy settings: override env\&.var (see also environment variable below)\&. Protocol "socks5" should be given explicitly where "http" is default\&. Note: socks proxy is not supported by env\&. variable
1116
1117
1118 .RE
1119 .PP
1120 \fB/pth\fR:\fIpassword\-hash\fR, \fB/pass\-the\-hash\fR:\fIpassword\-hash\fR
1121 .RS 4
1122
1123
1124
1125
1126 Pass the hash (restricted admin mode)
1127
1128
1129 .RE
1130 .PP
1131 \fB/pwidth\fR:\fIwidth\fR
1132 .RS 4
1133
1134
1135
1136 Physical width of display (in millimeters)
1137
1138
1139 .RE
1140 .PP
1141 \fB/reconnect\-cookie\fR:\fIbase64\-cookie\fR
1142 .RS 4
1143
1144
1145
1146 Pass base64 reconnect cookie to the connection
1147
1148
1149 .RE
1150 .PP
1151 \fB/restricted\-admin\fR, \fB/restrictedAdmin\fR
1152 .RS 4
1153
1154
1155
1156
1157 Restricted admin mode
1158
1159
1160 .RE
1161 .PP
1162 \fB/rfx\fR
1163 .RS 4
1164
1165
1166
1167 RemoteFX
1168
1169
1170 .RE
1171 .PP
1172 \fB/rfx\-mode\fR:image|video
1173 .RS 4
1174
1175
1176
1177 RemoteFX mode
1178
1179
1180 .RE
1181 .PP
1182 \fB/scale\fR:100|140|180
1183 .RS 4
1184
1185
1186
1187 Scaling factor of the display (default:100)
1188
1189
1190 .RE
1191 .PP
1192 \fB/scale\-desktop\fR:\fIpercentage\fR
1193 .RS 4
1194
1195
1196
1197 Scaling factor for desktop applications (value between 100 and 500) (default:100)
1198
1199
1200 .RE
1201 .PP
1202 \fB/scale\-device\fR:100|140|180
1203 .RS 4
1204
1205
1206
1207 Scaling factor for app store applications (default:100)
1208
1209
1210 .RE
1211 .PP
1212 \fB/sec\fR:rdp|tls|nla|ext
1213 .RS 4
1214
1215
1216
1217 Force specific protocol security
1218
1219
1220 .RE
1221 .PP
1222 \fB+sec\-ext\fR
1223 .RS 4
1224
1225
1226
1227 NLA extended protocol security (default:off)
1228
1229
1230 .RE
1231 .PP
1232 \fB\-sec\-nla\fR
1233 .RS 4
1234
1235
1236
1237 NLA protocol security (default:on)
1238
1239
1240 .RE
1241 .PP
1242 \fB\-sec\-rdp\fR
1243 .RS 4
1244
1245
1246
1247 RDP protocol security (default:on)
1248
1249
1250 .RE
1251 .PP
1252 \fB\-sec\-tls\fR
1253 .RS 4
1254
1255
1256
1257 TLS protocol security (default:on)
1258
1259
1260 .RE
1261 .PP
1262 \fB/serial\fR[:\fIname\fR[,\fIpath\fR[,\fIdriver\fR[,permissive]]]], \fB/tty\fR[:\fIname\fR[,\fIpath\fR[,\fIdriver\fR[,permissive]]]]
1263 .RS 4
1264
1265
1266
1267
1268 Redirect serial device
1269
1270
1271 .RE
1272 .PP
1273 \fB/shell\fR:\fIshell\fR
1274 .RS 4
1275
1276
1277
1278 Alternate shell
1279
1280
1281 .RE
1282 .PP
1283 \fB/shell\-dir\fR:\fIdir\fR
1284 .RS 4
1285
1286
1287
1288 Shell working directory
1289
1290
1291 .RE
1292 .PP
1293 \fB/size\fR:\fIwidth\fRx\fIheight\fR or \fIpercent\fR%[wh]
1294 .RS 4
1295
1296
1297
1298 Screen size (default:1024x768)
1299
1300
1301 .RE
1302 .PP
1303 \fB/smart\-sizing\fR[:\fIwidth\fRx\fIheight\fR]
1304 .RS 4
1305
1306
1307
1308 Scale remote desktop to window size
1309
1310
1311 .RE
1312 .PP
1313 \fB/smartcard\fR[:\fIname\fR[,\fIpath\fR]]
1314 .RS 4
1315
1316
1317
1318 Redirect smartcard device
1319
1320
1321 .RE
1322 .PP
1323 \fB/sound\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR,][latency:\fIlatency\fR,][quality:\fIquality\fR]], \fB/audio\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR,][latency:\fIlatency\fR,][quality:\fIquality\fR]]
1324 .RS 4
1325
1326
1327
1328
1329 Audio output (sound)
1330
1331
1332 .RE
1333 .PP
1334 \fB/span\fR
1335 .RS 4
1336
1337
1338
1339 Span screen over multiple monitors
1340
1341
1342 .RE
1343 .PP
1344 \fB/spn\-class\fR:\fIservice\-class\fR
1345 .RS 4
1346
1347
1348
1349 SPN authentication service class
1350
1351
1352 .RE
1353 .PP
1354 \fB/ssh\-agent\fR, \fB/ssh\-agent\fR
1355 .RS 4
1356
1357
1358
1359
1360 SSH Agent forwarding channel
1361
1362
1363 .RE
1364 .PP
1365 \fB/t\fR:\fItitle\fR, \fB/title\fR:\fItitle\fR
1366 .RS 4
1367
1368
1369
1370
1371 Window title
1372
1373
1374 .RE
1375 .PP
1376 \fB\-themes\fR
1377 .RS 4
1378
1379
1380
1381 themes (default:on)
1382
1383
1384 .RE
1385 .PP
1386 \fB/tls\-ciphers\fR:netmon|ma|ciphers
1387 .RS 4
1388
1389
1390
1391 Allowed TLS ciphers
1392
1393
1394 .RE
1395 .PP
1396 \fB\-toggle\-fullscreen\fR
1397 .RS 4
1398
1399
1400
1401 Alt+Ctrl+Enter toggles fullscreen (default:on)
1402
1403
1404 .RE
1405 .PP
1406 \fB/u\fR:[\fIdomain\fR\e]\fIuser\fR or \fIuser\fR[@\fIdomain\fR]
1407 .RS 4
1408
1409
1410
1411 Username
1412
1413
1414 .RE
1415 .PP
1416 \fB+unmap\-buttons\fR
1417 .RS 4
1418
1419
1420
1421 Let server see real physical pointer button (default:off)
1422
1423
1424 .RE
1425 .PP
1426 \fB/usb\fR:[dbg,][dev:\fIdev\fR,][id|addr,][auto]
1427 .RS 4
1428
1429
1430
1431 Redirect USB device
1432
1433
1434 .RE
1435 .PP
1436 \fB/v\fR:\fIserver\fR[:port]
1437 .RS 4
1438
1439
1440
1441 Server hostname
1442
1443
1444 .RE
1445 .PP
1446 \fB/vc\fR:\fIchannel\fR[,\fIoptions\fR]
1447 .RS 4
1448
1449
1450
1451 Static virtual channel
1452
1453
1454 .RE
1455 .PP
1456 \fB/version\fR
1457 .RS 4
1458
1459
1460
1461 Print version
1462
1463
1464 .RE
1465 .PP
1466 \fB/video\fR
1467 .RS 4
1468
1469
1470
1471 Video optimized remoting channel
1472
1473
1474 .RE
1475 .PP
1476 \fB/vmconnect\fR[:\fIvmid\fR]
1477 .RS 4
1478
1479
1480
1481 Hyper\-V console (use port 2179, disable negotiation)
1482
1483
1484 .RE
1485 .PP
1486 \fB/w\fR:\fIwidth\fR
1487 .RS 4
1488
1489
1490
1491 Width (default:1024)
1492
1493
1494 .RE
1495 .PP
1496 \fB\-wallpaper\fR
1497 .RS 4
1498
1499
1500
1501 wallpaper (default:on)
1502
1503
1504 .RE
1505 .PP
1506 \fB+window\-drag\fR
1507 .RS 4
1508
1509
1510
1511 full window drag (default:off)
1512
1513
1514 .RE
1515 .PP
1516 \fB/wm\-class\fR:\fIclass\-name\fR
1517 .RS 4
1518
1519
1520
1521 Set the WM_CLASS hint for the window instance
1522
1523
1524 .RE
1525 .PP
1526 \fB/workarea\fR
1527 .RS 4
1528
1529
1530
1531 Use available work area
1532
1533
1534 .RE
1535
1536
1537
1538
1539
1540
1541 .SH "ENVIRONMENT VARIABLES"
1542
1543
1544
1545
1546
1547 .PP
1548 wlog environment variable
1549 .RS 4
1550
1551
1552
1553 xfreerdp uses wLog as its log facility, you can refer to the corresponding man page (wlog(7)) for more informations\&. Arguments passed via the
1554 \fI/log\-level\fR
1555 or
1556 \fI/log\-filters\fR
1557 have precedence over the environment variables\&.
1558
1559
1560 .RE
1561
1562
1563
1564
1565 .SH "EXAMPLES"
1566
1567
1568
1569
1570 .PP
1571 \fBxfreerdp connection\&.rdp /p:Pwd123! /f\fR
1572 .RS 4
1573
1574
1575
1576 Connect in fullscreen mode using a stored configuration
1577 \fIconnection\&.rdp\fR
1578 and the password
1579 \fIPwd123!\fR
1580
1581
1582 .RE
1583 .PP
1584 \fBxfreerdp /u:USER /size:50%h /v:rdp\&.contoso\&.com\fR
1585 .RS 4
1586
1587
1588
1589 Connect to host
1590 \fIrdp\&.contoso\&.com\fR
1591 with user
1592 \fIUSER\fR
1593 and a size of
1594 \fI50 percent of the height\fR\&. If width (w) is set instead of height (h) like /size:50%w\&. 50 percent of the width is used\&.
1595
1596
1597 .RE
1598 .PP
1599 \fBxfreerdp /u:CONTOSO\e\eJohnDoe /p:Pwd123! /v:rdp\&.contoso\&.com\fR
1600 .RS 4
1601
1602
1603
1604 Connect to host
1605 \fIrdp\&.contoso\&.com\fR
1606 with user
1607 \fICONTOSO\e\eJohnDoe\fR
1608 and password
1609 \fIPwd123!\fR
1610
1611
1612 .RE
1613 .PP
1614 \fBxfreerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:192\&.168\&.1\&.100:4489\fR
1615 .RS 4
1616
1617
1618
1619 Connect to host
1620 \fI192\&.168\&.1\&.100\fR
1621 on port
1622 \fI4489\fR
1623 with user
1624 \fIJohnDoe\fR, password
1625 \fIPwd123!\fR\&. The screen width is set to
1626 \fI1366\fR
1627 and the height to
1628 \fI768\fR
1629
1630
1631 .RE
1632 .PP
1633 \fBxfreerdp /u:JohnDoe /p:Pwd123! /vmconnect:C824F53E\-95D2\-46C6\-9A18\-23A5BB403532 /v:192\&.168\&.1\&.100\fR
1634 .RS 4
1635
1636
1637
1638 Establish a connection to host
1639 \fI192\&.168\&.1\&.100\fR
1640 with user
1641 \fIJohnDoe\fR, password
1642 \fIPwd123!\fR
1643 and connect to Hyper\-V console (use port 2179, disable negotiation) with VMID
1644 \fIC824F53E\-95D2\-46C6\-9A18\-23A5BB403532\fR
1645
1646
1647 .RE
1648 .PP
1649 \fB+clipboard\fR
1650 .RS 4
1651
1652
1653
1654 Activate clipboard redirection
1655
1656
1657 .RE
1658 .PP
1659 \fB/drive:home,/home/user\fR
1660 .RS 4
1661
1662
1663
1664 Activate drive redirection of
1665 \fI/home/user\fR
1666 as home drive
1667
1668
1669 .RE
1670 .PP
1671 \fB/smartcard:<device>\fR
1672 .RS 4
1673
1674
1675
1676 Activate smartcard redirection for device
1677 \fIdevice\fR
1678
1679
1680 .RE
1681 .PP
1682 \fB/printer:<device>,<driver>\fR
1683 .RS 4
1684
1685
1686
1687 Activate printer redirection for printer
1688 \fIdevice\fR
1689 using driver
1690 \fIdriver\fR
1691
1692
1693 .RE
1694 .PP
1695 \fB/serial:<device>\fR
1696 .RS 4
1697
1698
1699
1700 Activate serial port redirection for port
1701 \fIdevice\fR
1702
1703
1704 .RE
1705 .PP
1706 \fB/parallel:<device>\fR
1707 .RS 4
1708
1709
1710
1711 Activate parallel port redirection for port
1712 \fIdevice\fR
1713
1714
1715 .RE
1716 .PP
1717 \fB/sound:sys:alsa\fR
1718 .RS 4
1719
1720
1721
1722 Activate audio output redirection using device
1723 \fIsys:alsa\fR
1724
1725
1726 .RE
1727 .PP
1728 \fB/microphone:sys:alsa\fR
1729 .RS 4
1730
1731
1732
1733 Activate audio input redirection using device
1734 \fIsys:alsa\fR
1735
1736
1737 .RE
1738 .PP
1739 \fB/multimedia:sys:alsa\fR
1740 .RS 4
1741
1742
1743
1744 Activate multimedia redirection using device
1745 \fIsys:alsa\fR
1746
1747
1748 .RE
1749 .PP
1750 \fB/usb:id,dev:054c:0268\fR
1751 .RS 4
1752
1753
1754
1755 Activate USB device redirection for the device identified by
1756 \fI054c:0268\fR
1757
1758
1759 .RE
1760
1761
1762
1763
1764 .SH "LINKS"
1765
1766
1767 .PP
1768 \m[blue]\fBhttp://www\&.freerdp\&.com/\fR\m[]
1769
1770
1771 .SH "AUTHOR"
1772 .br
1773 .PP
1774 The FreeRDP Team
|
