en-US/Pansies-help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Convert-ConsolePalette</command:name>
<command:verb>Convert</command:verb>
<command:noun>ConsolePalette</command:noun>
<maml:description><maml:para>Converts the current 16 Color console palette by shifting either the dark or light colors to darker or lighter shades.
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Converts a 16 Color console palette by shifting either the dark or light colors to darker or lighter shades.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Convert-ConsolePalette</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BrightShift</maml:name>
<maml:Description><maml:para>How much to shift the bright colors. Positive values make the colors brighter, negative values make them darker
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Copy</maml:name>
<maml:Description><maml:para>By default, the colors are modified in-place. If copy is set: - the dark colors start with the value of the bright colors
</maml:para>
<maml:para>- the light colors start at the value of the dark colors
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>
<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem><maml:name>Convert-ConsolePalette</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>DarkShift</maml:name>
<maml:Description><maml:para>How much to shift the dark colors. Positive values make the colors brighter, negative values make them darker
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Copy</maml:name>
<maml:Description><maml:para>By default, the colors are modified in-place. If copy is set: - the dark colors start with the value of the bright colors
</maml:para>
<maml:para>- the light colors start at the value of the dark colors
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>
<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BrightShift</maml:name>
<maml:Description><maml:para>How much to shift the bright colors. Positive values make the colors brighter, negative values make them darker
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Copy</maml:name>
<maml:Description><maml:para>By default, the colors are modified in-place. If copy is set: - the dark colors start with the value of the bright colors
</maml:para>
<maml:para>- the light colors start at the value of the dark colors
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>DarkShift</maml:name>
<maml:Description><maml:para>How much to shift the dark colors. Positive values make the colors brighter, negative values make them darker
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>
<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Convert-ConsolePalette -BrightShift 20 -Copy</dev:code>
<dev:remarks><maml:para>Copies the Dark* colors from the console palette to the bright side and brightens them by 20 (of 100) luminance.
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks></command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>ConvertFrom-iTermColors</command:name>
<command:verb>ConvertFrom</command:verb>
<command:noun>iTermColors</command:noun>
<maml:description><maml:para>Convert a .itermcolors XML file into a (partial) PANSIES theme for your PowerShell console
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Generate a PANSIES PowerShell theme from iTermColors.
</maml:para>
<maml:para>If you start with a working iTerm theme, you will get the 16 ConsoleColors plus the foreground/background, but they often include the colors for selection and emphasis in PSReadLine, as well.
</maml:para>
<maml:para>For a huge collection of iTermColors files you can use, visit https:#ithub.com/mbadolato/iTerm2-Color-Schemes
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>ConvertFrom-iTermColors</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath, Name"><maml:name>Theme</maml:name>
<maml:Description><maml:para>The name of (or full path to) an XML PList itermcolors scheme If you provide just a name, will search recursively for an .itermcolors file in the current folder
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Scope</maml:name>
<maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User.
</maml:para>
</maml:Description>
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">User</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Machine</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>User</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
<maml:Description><maml:para>Prompts you with the file names for confirmation before running the conversion.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
<maml:Description><maml:para>Overwrite any existing theme file
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name>
<maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported VSCode theme with matching ConsoleColors.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>
<maml:Description><maml:para>Shows the file names that would be converted if the conversion runs. The conversion is not run.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
<maml:Description><maml:para>Prompts you with the file names for confirmation before running the conversion.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
<maml:Description><maml:para>Overwrite any existing theme file
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Scope</maml:name>
<maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>User</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath, Name"><maml:name>Theme</maml:name>
<maml:Description><maml:para>The name of (or full path to) an XML PList itermcolors scheme If you provide just a name, will search recursively for an .itermcolors file in the current folder
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name>
<maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported VSCode theme with matching ConsoleColors.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>
<maml:Description><maml:para>Shows the file names that would be converted if the conversion runs. The conversion is not run.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>[string] the name of the theme</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>[PSCustomObject] representing the theme (if -Pasthru)</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>The conversion outputs a .theme.psd1 file to AppData or ProgramData
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>EXAMPLE 1</maml:title>
<dev:code>ConvertFrom-iTermColors Argonaut</dev:code>
<dev:remarks><maml:para>Will find the Argonaut.itermcolors file in the current directory (or in the module storage path)
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-VSCodeTheme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Export-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Import-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Get-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Show-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>ConvertFrom-VSCodeTheme</command:name>
<command:verb>ConvertFrom</command:verb>
<command:noun>VSCodeTheme</command:noun>
<maml:description><maml:para>Convert a VSCode Theme file into a partial theme
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Attempts to generate a PANSIES Powershell theme from a VSCode Theme.
</maml:para>
<maml:para>This feature is still experimental, and so far, includes theming:
</maml:para>
<maml:para>- The ConsoleColor palette (the base 16 ConsoleColors) from the `terminal.ansi*` colors in the VSCode theme
</maml:para>
<maml:para>- The PSReadLine colors (requires PSReadline 2.0.0 beta 2) from various named scopes
</maml:para>
<maml:para>- The PrivateData ConsoleColors (used for foreground of the output streams: Verbose, Error, Warning, Debug, Progress) from various named colors.
</maml:para>
<maml:para>
</maml:para>
<maml:para>NOTE: for now, even if everything works, there may be some colors for PSReadLine that aren't set, or that are set incorrectly (depending on the theme). If so, please let me know of themes you want to use or of colors that are wrong in the issues at https://GitHub.com/PoshCode/PANSIES/issues </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>ConvertFrom-VSCodeTheme</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath, Name"><maml:name>Theme</maml:name> <maml:Description><maml:para>The name of (or full path to) a vscode json theme E.g. 'Dark+' or 'Monokai' </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Scope</maml:name> <maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Machine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you with the file names for confirmation before running the conversion. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite any existing theme completely </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name> <maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name> <maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported iTerm color scheme with complementary PSReadline colors. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows the file names that would be converted if the conversion runs. The conversion is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you with the file names for confirmation before running the conversion. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite any existing theme completely </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name> <maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Scope</maml:name> <maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath, Name"><maml:name>Theme</maml:name> <maml:Description><maml:para>The name of (or full path to) a vscode json theme E.g. 'Dark+' or 'Monokai' </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name> <maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported iTerm color scheme with complementary PSReadline colors. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows the file names that would be converted if the conversion runs. The conversion is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>[string] the name of the theme</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>[PSCustomObject] representing the theme (if -Pasthru)</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>The conversion outputs a .theme.psd1 file to AppData or ProgramData </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>EXAMPLE 1</maml:title> <dev:code>PS C:\&gt; ConvertFrom-VSCodeTheme Dark+ PS C:\&gt; Import-Theme Dark+</dev:code> <dev:remarks><maml:para>This example shows how to convert the VSCode Dark+ default theme and then use it in your console. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-ITermColors</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Show-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Export-PList</command:name> <command:verb>Export</command:verb> <command:noun>PList</command:noun> <maml:description><maml:para>Convert an object to an XML or Binary PList file. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Exports simple data to an Apple-compatible Property List (PList) file. </maml:para> <maml:para>Note that this function is only lightly tested, and only supports strings, integers and doubles, dates, bytes, and booleans, as well as arrays or dictionaries of them (as long as the dictionary has string keys). </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Export-PList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath"><maml:name>Path</maml:name> <maml:Description><maml:para>The path where the export will be written </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Binary</maml:name> <maml:Description><maml:para>If set, Export-PList creates a binary file rather than an XML file </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="io"><maml:name>InputObject</maml:name> <maml:Description><maml:para>The object(s) to convert. Must be a date, string, double, integer, byte, bool, or an array or dictionary with only those in it. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Binary</maml:name> <maml:Description><maml:para>If set, Export-PList creates a binary file rather than an XML file </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="io"><maml:name>InputObject</maml:name> <maml:Description><maml:para>The object(s) to convert. Must be a date, string, double, integer, byte, bool, or an array or dictionary with only those in it. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="PSPath"><maml:name>Path</maml:name> <maml:Description><maml:para>The path where the export will be written </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\&gt; (Get-ConsolePalette).ForEach([string]) | Export-PList -Path palette.xml</dev:code> <dev:remarks><maml:para>Exports the palette as a PList XML file -- note that this isn't anything like the format that itermcolors files use -- they export colors as dictionaries of Red, Green, Blue ...
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>Import-PList</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Export-Theme</command:name>
<command:verb>Export</command:verb>
<command:noun>Theme</command:noun>
<maml:description><maml:para>Exports the current console and PSReadLine colors as a theme
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Read the current values for the 16 console colors and PSReadLine color options and exports them to a .theme.psd1 file for use with Pansies Theme commands.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Export-Theme</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Name</maml:name>
<maml:Description><maml:para>The name of the theme to export the current settings to
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
<maml:Description><maml:para>Overwrite any existing theme file with the given name
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Scope</maml:name>
<maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User.
</maml:para>
</maml:Description>
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">User</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Machine</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>User</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name>
<maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported VSCode theme with matching ConsoleColors.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
<maml:Description><maml:para>Overwrite any existing theme file with the given name
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Name</maml:name>
<maml:Description><maml:para>The name of the theme to export the current settings to
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>Output the theme after converting it so you can, for instance, pipe it to Show-Theme
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Scope</maml:name>
<maml:Description><maml:para>User or Machine (supports storing themes per-user or shared for all users). Defaults to User.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>User</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Update</maml:name>
<maml:Description><maml:para>Update any existing theme file. You can use this to complement a previously exported VSCode theme with matching ConsoleColors.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>[string] the name of the theme</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>[PSCustomObject] representing the theme (if -Pasthru)</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>Generates a .theme.psd1 file to AppData or ProgramData
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Export-Theme Default</dev:code>
<dev:remarks><maml:para>Saves your current settings as "Default" so you can re-import them later to revert
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-ITermColors</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>ConvertFrom-VSCodeTheme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Import-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Get-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Show-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Get-Complement</command:name>
<command:verb>Get</command:verb>
<command:noun>Complement</command:noun>
<maml:description><maml:para>Get the Hue complement color
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Returns a color that is 180 degrees opposite around the Hue component of the HSL color space.
</maml:para>
<maml:para>The primary reason for Get-Complement to exist is for generating contrasting colors for foreground and background. For that reason, it's usually called with `-ForceContrast` mode, which changes the lightness or darkness to increase the contrast of the returned color. </maml:para> <maml:para>It also has a `-ConsoleColor` switch that causes it to assume only 16 colors will work (PowerLine currently uses this mode by default because so many terminals don't support more --including Windows 10 prior to Creators Update). In ConsoleColor mode, it always returns White or Black.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Get-Complement</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Color</maml:name>
<maml:Description><maml:para>The source color to calculate the complement of
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleColor</maml:name>
<maml:Description><maml:para>Assume there are only 16 colors. Return either black or white to get a readable contrast color.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ForceContrast</maml:name>
<maml:Description><maml:para>Force the luminance to have "enough" contrast
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>If set, output the input $Color before the complement
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Color</maml:name>
<maml:Description><maml:para>The source color to calculate the complement of
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleColor</maml:name>
<maml:Description><maml:para>Assume there are only 16 colors. Return either black or white to get a readable contrast color.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ForceContrast</maml:name>
<maml:Description><maml:para>Force the luminance to have "enough" contrast
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Passthru</maml:name>
<maml:Description><maml:para>If set, output the input $Color before the complement
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>PoshCode.Pansies.RgbColor</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>PoshCode.Pansies.RgbColor</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Get-Complement Cyan</dev:code>
<dev:remarks><maml:para>Gets the color Red back, as the complement for Cyan.
</maml:para>
</dev:remarks>
</command:example>
<command:example><maml:title>Example 2</maml:title>
<dev:code>PS C:\&gt; $Background, $Foreground = Get-Complement Cyan -Passthru -ConsoleColor
PS C:\&gt; Write-Host " Hello World " -Foreground $Foreground.ConsoleColor -Background $Background.ConsoleColor</dev:code>
<dev:remarks><maml:para>This example shows how using `-Passthru` returns both the original color and the contrasting color, and how using `-ConsoleColor` results in a better contrast when you're being forced to use ConsoleColor (as with the built-in Write-Host command). </maml:para> <maml:para>You can try the example without `-ConsoleColor` to see the difference: with it, you'll get Black on Cyan, without, you'll get Red on Cyan. Note that using -ForceContrast will make almost no difference if you're using the `ConsoleColor` property, because downsampling to 16 colors has to result in either Red or DarkRed...
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>Get-Gradient</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Get-ConsolePalette</command:name>
<command:verb>Get</command:verb>
<command:noun>ConsolePalette</command:noun>
<maml:description><maml:para>Returns the 16 Color Palette configured for the console
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Returns the 16 Color palette defined for the current console (or the defaults for the system)
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Get-ConsolePalette</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddScreenAndPopup</maml:name>
<maml:Description><maml:para>If set, the exported palette will include 4 extra colors representing the default foreground and background and the popup foreground and background.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Default</maml:name>
<maml:Description><maml:para>If set, attempts to read the default console colortable values from the registry, rather than the palette of the current console.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddScreenAndPopup</maml:name>
<maml:Description><maml:para>If set, the exported palette will include 4 extra colors representing the default foreground and background and the popup foreground and background.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Default</maml:name>
<maml:Description><maml:para>If set, attempts to read the default console colortable values from the registry, rather than the palette of the current console.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>ConsolePalette</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Get-ConsolePalette -Default</dev:code>
<dev:remarks><maml:para>Get the default console palette
</maml:para>
</dev:remarks>
</command:example>
<command:example><maml:title>Example 2</maml:title>
<dev:code>PS C:\&gt; Get-ConsolePalette</dev:code>
<dev:remarks><maml:para>Get the current console palette
</maml:para>
</dev:remarks>
</command:example>
<command:example><maml:title>Example 3</maml:title>
<dev:code>PS C:\&gt; (Get-ConsolePalette).FindClosestColor([PoshCode.Pansies.RgbColor]"#336699")</dev:code>
<dev:remarks><maml:para>Finds the closest color in the current 16 color console palette to the specified #336699 shade of blue
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>Set-ConsolePalette</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Get-Gradient</command:name>
<command:verb>Get</command:verb>
<command:noun>Gradient</command:noun>
<maml:description><maml:para>Get a range of colors between two colors
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Get an array (or multiple arrays, one per line) of RgbColor values for a gradient from the start Color to the end Color.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Get-Gradient</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>StartColor</maml:name>
<maml:Description><maml:para>The left color to start the gradient from.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>EndColor</maml:name>
<maml:Description><maml:para>The right color to end the gradient at.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Length, Count, Steps"><maml:name>Width</maml:name>
<maml:Description><maml:para>The number of columns to generate in the gradient. Defaults to the width of the console.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>$Host.UI.RawUI.WindowSize.Width</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Height</maml:name>
<maml:Description><maml:para>The number of rows to generate in the gradient. Defaults to 1
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>$Host.UI.RawUI.WindowSize.Height</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ColorSpace</maml:name>
<maml:Description><maml:para>A color space to render the gradient in. Defaults to HunterLab, but can be any of CMY, CMYK, LAB, LCH, LUV, HunterLAB, HSL, HSV, HSB, RGB, XYZ, YXY
</maml:para>
</maml:Description>
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">CMY</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CMYK</command:parameterValue>
<command:parameterValue required="false" variableLength="false">LAB</command:parameterValue>
<command:parameterValue required="false" variableLength="false">LCH</command:parameterValue>
<command:parameterValue required="false" variableLength="false">LUV</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HunterLAB</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HSL</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HSV</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HSB</command:parameterValue>
<command:parameterValue required="false" variableLength="false">RGB</command:parameterValue>
<command:parameterValue required="false" variableLength="false">XYZ</command:parameterValue>
<command:parameterValue required="false" variableLength="false">YXY</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type><maml:name>Object</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>HunterLab</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Flatten</maml:name>
<maml:Description><maml:para>Flattens the 2D array to a single array.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Reverse</maml:name>
<maml:Description><maml:para>For color spaces with Hue (HSL, HSV, HSB), setting this generates the gradient the long way, creating a rainbow effect.
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ColorSpace</maml:name>
<maml:Description><maml:para>A color space to render the gradient in. Defaults to HunterLab, but can be any of CMY, CMYK, LAB, LCH, LUV, HunterLAB, HSL, HSV, HSB, RGB, XYZ, YXY
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type><maml:name>Object</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>HunterLab</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>EndColor</maml:name>
<maml:Description><maml:para>The right color to end the gradient at.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Flatten</maml:name>
<maml:Description><maml:para>Flattens the 2D array to a single array.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Height</maml:name>
<maml:Description><maml:para>The number of rows to generate in the gradient. Defaults to 1
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>$Host.UI.RawUI.WindowSize.Height</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Reverse</maml:name>
<maml:Description><maml:para>For color spaces with Hue (HSL, HSV, HSB), setting this generates the gradient the long way, creating a rainbow effect.
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>StartColor</maml:name>
<maml:Description><maml:para>The left color to start the gradient from.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue>
<dev:type><maml:name>RgbColor</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Length, Count, Steps"><maml:name>Width</maml:name>
<maml:Description><maml:para>The number of columns to generate in the gradient. Defaults to the width of the console.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type><maml:name>Int32</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>$Host.UI.RawUI.WindowSize.Width</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues><command:returnValue><dev:type><maml:name>PoshCode.Pansies.RgbColor[][]</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
<command:returnValue><dev:type><maml:name>PoshCode.Pansies.RgbColor[]</maml:name>
</dev:type>
<maml:description><maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Get-Gradient Red Blue -Count 10 -Flatten</dev:code>
<dev:remarks><maml:para>Gets a simple array of ten colors between Red and Blue.
</maml:para>
</dev:remarks>
</command:example>
<command:example><maml:title>Example 2</maml:title>
<dev:code>PS C:\&gt; Get-Gradient Red Blue</dev:code>
<dev:remarks><maml:para>Gets a 2D gradient from the ConsoleColor Red to Blue, with the width x height the current size of the console.
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>Get-Complement</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Get-Theme</command:name>
<command:verb>Get</command:verb>
<command:noun>Theme</command:noun>
<maml:description><maml:para>List available PANSIES themes, optionally filtering
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>List available PANSIES themes, optionally filtering by partial name or functionality. Specifically, there are switches to only return themes which have full ConsoleColors and/or PSReadline colors defined.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Get-Theme</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Name</maml:name>
<maml:Description><maml:para>The name of the theme(s) to show. Supports wildcards, and defaults to * everything.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>*</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleColors</maml:name>
<maml:Description><maml:para>If set, only returns themes that include ConsoleColor
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PSReadline</maml:name>
<maml:Description><maml:para>If set, only returns themes that include PSReadline Colors
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleColors</maml:name>
<maml:Description><maml:para>If set, only returns themes that include ConsoleColor
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Name</maml:name>
<maml:Description><maml:para>The name of the theme(s) to show. Supports wildcards, and defaults to * everything.
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>*</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PSReadline</maml:name>
<maml:Description><maml:para>If set, only returns themes that include PSReadline Colors
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes></command:inputTypes>
<command:returnValues></command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Get-Theme -ConsoleColors -PSReadline</dev:code>
<dev:remarks><maml:para>Show all themes which contain both Console colors and PSReadline colors
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-ITermColors</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>ConvertFrom-VSCodeTheme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Export-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Import-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
<maml:navigationLink><maml:linkText>Show-Theme</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Import-PList</command:name>
<command:verb>Import</command:verb>
<command:noun>PList</command:noun>
<maml:description><maml:para>Convert an XML or Binary PList (property list) file to objects (arrays, string-&gt;object dictionaries, etc).
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Import a PList (XML or binary file) as a string dictionary or array of objects.
</maml:para>
<maml:para>Note that JSON and psd1 filesare not supported, since ConvertFrom-JSON and ConvertFrom-Metadata work fine.
</maml:para>
</maml:description>
<command:syntax><command:syntaxItem><maml:name>Import-PList</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="PSPath"><maml:name>Path</maml:name>
<maml:Description><maml:para>The path to an XML or binary plist file (e.g. a .tmTheme or .itermcolors file)
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="PSPath"><maml:name>Path</maml:name>
<maml:Description><maml:para>The path to an XML or binary plist file (e.g. a .tmTheme or .itermcolors file)
</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type><maml:name>String</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes></command:inputTypes>
<command:returnValues></command:returnValues>
<maml:alertSet><maml:alert><maml:para>
</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples><command:example><maml:title>Example 1</maml:title>
<dev:code>PS C:\&gt; Import-PList argonaut.itermcolors</dev:code>
<dev:remarks><maml:para>Import a PList XML file
</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks><maml:navigationLink><maml:linkText>Export-PList</maml:linkText>
<maml:uri></maml:uri>
</maml:navigationLink>
</command:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details><command:name>Import-Theme</command:name>
<command:verb>Import</command:verb>
<command:noun>Theme</command:noun>
<maml:description><maml:para>Imports a PANSIES .theme.psd1 file to style your Console, Host, and PSReadLine
</maml:para>
</maml:description>
</command:details>
<maml:description><maml:para>Imports the theme and applies colors if they're defined to the Console, to PSReadline and to Host.PrivateData (the colors of Error/Warning/Verbose/etc) </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Import-Theme</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>A theme to import (can be the name of an installed PANSIES theme, or the full path to a psd1 file) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SkipDefault</maml:name> <maml:Description><maml:para>By default, imported themes will update the default console colors (if they define console colors) If SkipDefault is set, Import-Theme will leave the default Console Colors alone </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>A theme to import (can be the name of an installed PANSIES theme, or the full path to a psd1 file) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SkipDefault</maml:name> <maml:Description><maml:para>By default, imported themes will update the default console colors (if they define console colors) If SkipDefault is set, Import-Theme will leave the default Console Colors alone </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\&gt; Import-Theme Zenburn</dev:code> <dev:remarks><maml:para>Shows how to import the Zenburn theme by name </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-ITermColors</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>ConvertFrom-VSCodeTheme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Show-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-Text</command:name> <command:verb>New</command:verb> <command:noun>Text</command:noun> <maml:description><maml:para>Create a Text object with specified background and foreground colors </maml:para> </maml:description> </command:details> <maml:description><maml:para>Create a Text object with specified background and foreground colors, and rendering HTML-style entities like `&amp;hearts;` and `&amp;frac12;` or `&amp;uuml;` and numerical unicode character entities in both decimal (e.g. `&amp;#926;`) and hexadeximal (`&amp;#x39E;`) </maml:para> <maml:para>When this object is rendered to the host with .ToString(), it inserts ANSI Virtual Terminal escape sequences for the specified colors, and by default, outputs escape sequences to clear those colors after the text. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-Text</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Object</maml:name> <maml:Description><maml:para>Specifies objects to display in the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Bg"><maml:name>BackgroundColor</maml:name> <maml:Description><maml:para>The background color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"... </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Fg"><maml:name>ForegroundColor</maml:name> <maml:Description><maml:para>The foreground color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"... </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IgnoreEntities</maml:name> <maml:Description><maml:para>If set, don't render the HTML Entities to characters (i.e. leave "&amp;hearts;" as "&amp;hearts;" instead of as "♥")
</maml:para>
</maml:Description>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LeaveColor</maml:name>
<maml:Description><maml:para>If set, don't clear the colors at the end of the output. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Separator</maml:name> <maml:Description><maml:para>Specifies a separator string to the output between objects displayed on the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Bg"><maml:name>BackgroundColor</maml:name> <maml:Description><maml:para>The background color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"... </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Fg"><maml:name>ForegroundColor</maml:name> <maml:Description><maml:para>The foreground color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"... </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IgnoreEntities</maml:name> <maml:Description><maml:para>If set, don't render the HTML Entities to characters (i.e. leave "&amp;hearts;" as "&amp;hearts;" instead of as "♥")
</maml:para>
</maml:Description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type><maml:name>SwitchParameter</maml:name>
<maml:uri /></dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LeaveColor</maml:name>
<maml:Description><maml:para>If set, don't clear the colors at the end of the output. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Object</maml:name> <maml:Description><maml:para>Specifies objects to display in the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Separator</maml:name> <maml:Description><maml:para>Specifies a separator string to the output between objects displayed on the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>PoshCode.Pansies.RgbColor</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\&gt; New-Text "&amp;hearts;" -ForegroundColor Red BackgroundColor ForegroundColor Object ToString --------------- --------------- ------ --------   Red &amp;hearts; ?</dev:code> <dev:remarks><maml:para>Generates a text object with the hearts symbol (♥) in red. The output shows the BackgroundColor, ForegroundColor, Text (with the entity text in it) and the rendered output when the object is in a string, where the entity will be replaced with the hearts symbol and the colors will take effect. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2</maml:title> <dev:code>PS C:\&gt; "I $(New-Text "&amp;hearts;" -ForegroundColor "#F00") PS" I ? PS</dev:code> <dev:remarks><maml:para>Outputs the text "I ♥ PS" with the heart in red. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Write-Host</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-ConsolePalette</command:name> <command:verb>Set</command:verb> <command:noun>ConsolePalette</command:noun> <maml:description><maml:para>Set the 16 color console palette </maml:para> </maml:description> </command:details> <maml:description><maml:para>Set the 16 color console palette (and optionally, the default palette) </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-ConsolePalette</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Colors</maml:name> <maml:Description><maml:para>Colors to be used for the console palette. Supports piping in a collection of colors. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor[]</command:parameterValue> <dev:type><maml:name>RgbColor[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Default</maml:name> <maml:Description><maml:para>If set, set the default console palette in addition to the current palette </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-ConsolePalette</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Palette</maml:name> <maml:Description><maml:para>The palette to set the console colors. Note that a Palette is just a `List` of 16 (or more) colors. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IList[RgbColor]</command:parameterValue> <dev:type><maml:name>IList[RgbColor]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Default</maml:name> <maml:Description><maml:para>If set, set the default console palette in addition to the current palette </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Colors</maml:name> <maml:Description><maml:para>Colors to be used for the console palette. Supports piping in a collection of colors. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor[]</command:parameterValue> <dev:type><maml:name>RgbColor[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Default</maml:name> <maml:Description><maml:para>If set, set the default console palette in addition to the current palette </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>Palette</maml:name> <maml:Description><maml:para>The palette to set the console colors. Note that a Palette is just a `List` of 16 (or more) colors. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IList[RgbColor]</command:parameterValue> <dev:type><maml:name>IList[RgbColor]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>[IList[RgbColor]] A ConsolePalette or other list of 16 RGBColor values</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>[RgbColor[]]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\&gt; Get-ConsolePalette | Set-ConsolePalette -Default</dev:code> <dev:remarks><maml:para>This example shows how to use Set-ConsolePalette with pipeline input to upgrade the current palette to the default palette. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-ConsolePalette</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Show-Theme</command:name> <command:verb>Show</command:verb> <command:noun>Theme</command:noun> <maml:description><maml:para>Show a preview of a PANSIES theme </maml:para> </maml:description> </command:details> <maml:description><maml:para>Show a preview of a theme, using the old-school gYw table, a simple side-by-side view of bright and dark colors, a code sample, and optionally a larger block of text colors on common backgrounds </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Show-Theme</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Theme, PSPath"><maml:name>Name</maml:name> <maml:Description><maml:para>The name of the color theme to display </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MoreText</maml:name> <maml:Description><maml:para>Adds an additional block with more text on the most common background colors </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoCodeSample</maml:name> <maml:Description><maml:para>Supresses the code sample output </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Tiny</maml:name> <maml:Description><maml:para>Supresses the large color table </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MoreText</maml:name> <maml:Description><maml:para>Adds an additional block with more text on the most common background colors </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Theme, PSPath"><maml:name>Name</maml:name> <maml:Description><maml:para>The name of the color theme to display </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoCodeSample</maml:name> <maml:Description><maml:para>Supresses the code sample output </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Tiny</maml:name> <maml:Description><maml:para>Supresses the large color table </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>[String] (the theme name)</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>[String] (a string with embedded ANSI escape sequences to demonstrate the theme)</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>Although this is a `Show` command, it actually just returns a string for display on the console. There are lots of escape sequences, but no other formatting. </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\&gt; Show-Theme Zenburn -Tiny</dev:code> <dev:remarks><maml:para>Shows a small version of the preview with just the side-by-side colors and code preview </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>ConvertFrom-ITermColors</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>ConvertFrom-VSCodeTheme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-Theme</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Write-Host</command:name> <command:verb>Write</command:verb> <command:noun>Host</command:noun> <maml:description><maml:para>Backwards compatible Write-Host replacement which writes customized output to a host, but using full RGB color values. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Write-Host cmdlet customizes output. You can specify the color of text by using the ForegroundColor parameter, and you can specify the background color by using the BackgroundColor parameter. The Separator parameter lets you specify a string to use to separate displayed objects. The particular result depends on the program that is hosting Windows PowerShell. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Write-Host</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Object</maml:name> <maml:Description><maml:para>Specifies objects to display in the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackgroundColor</maml:name> <maml:Description><maml:para>Specifies the background color. There is no default. The acceptable values for this parameter are: </maml:para> <maml:para>CSS Hex representations of RGB colors like "#FF00FF" or "FF00FF" </maml:para> <maml:para>XTerm indexes like "xt138" or "123" </maml:para> <maml:para>Console Color names: </maml:para> <maml:para>- Black </maml:para> <maml:para>- DarkBlue </maml:para> <maml:para>- DarkGreen </maml:para> <maml:para>- DarkCyan </maml:para> <maml:para>- DarkRed </maml:para> <maml:para>- DarkMagenta </maml:para> <maml:para>- DarkYellow </maml:para> <maml:para>- Gray </maml:para> <maml:para>- DarkGray </maml:para> <maml:para>- Blue </maml:para> <maml:para>- Green </maml:para> <maml:para>- Cyan </maml:para> <maml:para>- Red </maml:para> <maml:para>- Magenta </maml:para> <maml:para>- Yellow </maml:para> <maml:para>- White </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ForegroundColor</maml:name> <maml:Description><maml:para>Specifies the text color. There is no default. The acceptable values for this parameter are: </maml:para> <maml:para>CSS Hex representations of RGB colors like "#FF00FF" or "FF00FF" </maml:para> <maml:para>XTerm indexes like "xt138" or "123" </maml:para> <maml:para>Console Color names: </maml:para> <maml:para>- Black </maml:para> <maml:para>- DarkBlue </maml:para> <maml:para>- DarkGreen </maml:para> <maml:para>- DarkCyan </maml:para> <maml:para>- DarkRed </maml:para> <maml:para>- DarkMagenta </maml:para> <maml:para>- DarkYellow </maml:para> <maml:para>- Gray </maml:para> <maml:para>- DarkGray </maml:para> <maml:para>- Blue </maml:para> <maml:para>- Green </maml:para> <maml:para>- Cyan </maml:para> <maml:para>- Red </maml:para> <maml:para>- Magenta </maml:para> <maml:para>- Yellow </maml:para> <maml:para>- White </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoNewline</maml:name> <maml:Description><maml:para>Specifies that the content displayed in the console does not end with a newline character. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Separator</maml:name> <maml:Description><maml:para>Specifies a separator string to the output between objects displayed on the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackgroundColor</maml:name> <maml:Description><maml:para>Specifies the background color. There is no default. The acceptable values for this parameter are: </maml:para> <maml:para>CSS Hex representations of RGB colors like "#FF00FF" or "FF00FF" </maml:para> <maml:para>XTerm indexes like "xt138" or "123" </maml:para> <maml:para>Console Color names: </maml:para> <maml:para>- Black </maml:para> <maml:para>- DarkBlue </maml:para> <maml:para>- DarkGreen </maml:para> <maml:para>- DarkCyan </maml:para> <maml:para>- DarkRed </maml:para> <maml:para>- DarkMagenta </maml:para> <maml:para>- DarkYellow </maml:para> <maml:para>- Gray </maml:para> <maml:para>- DarkGray </maml:para> <maml:para>- Blue </maml:para> <maml:para>- Green </maml:para> <maml:para>- Cyan </maml:para> <maml:para>- Red </maml:para> <maml:para>- Magenta </maml:para> <maml:para>- Yellow </maml:para> <maml:para>- White </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ForegroundColor</maml:name> <maml:Description><maml:para>Specifies the text color. There is no default. The acceptable values for this parameter are: </maml:para> <maml:para>CSS Hex representations of RGB colors like "#FF00FF" or "FF00FF" </maml:para> <maml:para>XTerm indexes like "xt138" or "123" </maml:para> <maml:para>Console Color names: </maml:para> <maml:para>- Black </maml:para> <maml:para>- DarkBlue </maml:para> <maml:para>- DarkGreen </maml:para> <maml:para>- DarkCyan </maml:para> <maml:para>- DarkRed </maml:para> <maml:para>- DarkMagenta </maml:para> <maml:para>- DarkYellow </maml:para> <maml:para>- Gray </maml:para> <maml:para>- DarkGray </maml:para> <maml:para>- Blue </maml:para> <maml:para>- Green </maml:para> <maml:para>- Cyan </maml:para> <maml:para>- Red </maml:para> <maml:para>- Magenta </maml:para> <maml:para>- Yellow </maml:para> <maml:para>- White </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RgbColor</command:parameterValue> <dev:type><maml:name>RgbColor</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoNewline</maml:name> <maml:Description><maml:para>Specifies that the content displayed in the console does not end with a newline character. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Object</maml:name> <maml:Description><maml:para>Specifies objects to display in the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Separator</maml:name> <maml:Description><maml:para>Specifies a separator string to the output between objects displayed on the console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>PoshCode.Pansies.RgbColor</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Write to the console and include a separator</maml:title> <dev:code>PS C:\&gt; Write-Host (2,4,6,8,10,12) -Separator ", +2= " 2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12</dev:code> <dev:remarks><maml:para>This command displays the even numbers from 2 through 12. The Separator parameter is used to add the string ", +2= " (comma, space, +, 2, =, space). </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Write with different text and background colors</maml:title> <dev:code>PS C:\&gt; Write-Host (2,4,6,8,10,12) -Separator ", -&gt; " -ForegroundColor DarkGreen -BackgroundColor white</dev:code> <dev:remarks><maml:para>This command displays the even numbers from 2 through 12. It uses the ForegroundColor parameter to output dark green text and the BackgroundColor parameter to display a white background. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Write with different text and background colors</maml:title> <dev:code>PS C:\&gt; Write-Host "Red on white text." -ForegroundColor "#FF0000" -BackgroundColor "#FFFFFF" Red on white text.</dev:code> <dev:remarks><maml:para>This command displays the string "Red on white text." The text is red, as defined by the ForegroundColor parameter. The background is white, as defined by the BackgroundColor parameter. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-Text</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Clear-Host</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Debug</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Error</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Output</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Progress</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Verbose</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Write-Warning</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems>