-
Notifications
You must be signed in to change notification settings - Fork 8
/
envvars.html
2138 lines (2103 loc) · 157 KB
/
envvars.html
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
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Built-in Aliases" href="aliases.html" /><link rel="prev" title="Updating and customizing xonsh" href="customization.html" />
<link rel="shortcut icon" href="_static/magic_conch.ico"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
<title>Environment Variables - xonsh 0.16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=c8b63bf6" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<style>
body {
--color-code-background: #eeffcc;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="contents.html"><div class="brand">xonsh 0.16.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="contents.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/ascii_conch_part_transparent_tight.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">xonsh 0.16.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="packages.html">Package Manager</a></li>
<li class="toctree-l1"><a class="reference internal" href="appimage.html">AppImage</a></li>
<li class="toctree-l1"><a class="reference internal" href="containers.html">Docker container</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_hist.html">Tutorial: History</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_macros.html">Tutorial: Macros</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xontrib.html">Tutorial: Extensions (Xontribs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xonsh_projects.html">Tutorial: Xonsh Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_events.html">Tutorial: Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_completers.html">Tutorial: Programmable Tab-Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_history_backend.html">Tutorial: Write Your Own History Backend</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_subproc_strings.html">Tutorial: Subprocess Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_ptk.html">Tutorial: <code class="docutils literal notranslate"><span class="pre">prompt_toolkit</span></code> custom keybindings</a></li>
<li class="toctree-l1"><a class="reference internal" href="bash_to_xsh.html">Bash to Xonsh Translation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="editors.html">Editor and IDE Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="subproc_types.html">Subprocess Types Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_virtual_environments.html">Python Virtual Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="xonshrc.html">Run Control File</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization.html">Updating and customizing xonsh</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Environment Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="aliases.html">Built-in Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Core Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="platform-issues.html">Platform-specific tips and tricks</a></li>
</ul>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="api/index.html">Xonsh API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Xonsh API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.lexer.html">xonsh.lexer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.parser.html">xonsh.parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.ast.html">xonsh.ast</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.execer.html">xonsh.execer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.imphooks.html">xonsh.imphooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.built_ins.html">xonsh.built_ins</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.environ.html">xonsh.environ</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.aliases.html">xonsh.aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.dirstack.html">xonsh.dirstack</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.jobs.html">xonsh.jobs</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.html">xonsh.procs</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of xonsh.procs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.pipelines.html">xonsh.procs.pipelines</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.posix.html">xonsh.procs.posix</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.proxies.html">xonsh.procs.proxies</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.readers.html">xonsh.procs.readers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.specs.html">xonsh.procs.specs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.inspectors.html">xonsh.inspectors</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.html">xonsh.history</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of xonsh.history</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.base.html">xonsh.history.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.dummy.html">xonsh.history.dummy</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.json.html">xonsh.history.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.main.html">xonsh.history.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.sqlite.html">xonsh.history.sqlite</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completer.html">xonsh.completer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.html">xonsh.completers</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of xonsh.completers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.base.html">xonsh.completers.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash.html">xonsh.completers.bash</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash_completion.html">xonsh.completers.bash_completion</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.commands.html">xonsh.completers.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.completer.html">xonsh.completers.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.dirs.html">xonsh.completers.dirs</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.environment.html">xonsh.completers.environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.imports.html">xonsh.completers.imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.init.html">xonsh.completers.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.man.html">xonsh.completers.man</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.path.html">xonsh.completers.path</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.python.html">xonsh.completers.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.tools.html">xonsh.completers.tools</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.html">xonsh.prompt</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of xonsh.prompt</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.base.html">xonsh.prompt.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.cwd.html">xonsh.prompt.cwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.env.html">xonsh.prompt.env</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.gitstatus.html">xonsh.prompt.gitstatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.job.html">xonsh.prompt.job</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.times.html">xonsh.prompt.times</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.vc.html">xonsh.prompt.vc</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shell.html">xonsh.shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.base_shell.html">xonsh.base_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.readline_shell.html">xonsh.readline_shell</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.html">xonsh.ptk_shell</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of xonsh.ptk_shell</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.completer.html">xonsh.ptk_shell.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.formatter.html">xonsh.ptk_shell.formatter</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.history.html">xonsh.ptk_shell.history</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.key_bindings.html">xonsh.ptk_shell.key_bindings</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.shell.html">xonsh.ptk_shell.shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.updator.html">xonsh.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.pretty.html">xonsh.pretty</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.diff_history.html">xonsh.diff_history</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.html">xonsh.xoreutils</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of xonsh.xoreutils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.cat.html">xonsh.xoreutils.cat</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.echo.html">xonsh.xoreutils.echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.pwd.html">xonsh.xoreutils.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tee.html">xonsh.xoreutils.tee</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tty.html">xonsh.xoreutils.tty</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.ulimit.html">xonsh.xoreutils.ulimit</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.umask.html">xonsh.xoreutils.umask</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uname.html">xonsh.xoreutils.uname</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uptime.html">xonsh.xoreutils.uptime</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.util.html">xonsh.xoreutils.util</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.which.html">xonsh.xoreutils.which</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.yes.html">xonsh.xoreutils.yes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.events.html">xonsh.events</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.html">xonsh.lib</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of xonsh.lib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.collections.html">xonsh.lib.collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.itertools.html">xonsh.lib.itertools</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.modules.html">xonsh.lib.modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.os.html">xonsh.lib.os</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.subprocess.html">xonsh.lib.subprocess</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tools.html">xonsh.tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.platform.html">xonsh.platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.jsonutils.html">xonsh.jsonutils</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyjson.html">xonsh.lazyjson</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyasd.html">xonsh.lazyasd</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.openpy.html">xonsh.openpy</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.foreign_shells.html">xonsh.foreign_shells</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.commands_cache.html">xonsh.commands_cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tracer.html">xonsh.tracer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.main.html">xonsh.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.color_tools.html">xonsh.color_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.pyghooks.html">xonsh.pyghooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.dumb_shell.html">xonsh.dumb_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.wizard.html">xonsh.wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xonfig.html">xonsh.xonfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xontribs.html">xonsh.xontribs</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.codecache.html">xonsh.codecache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.contexts.html">xonsh.contexts</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.html">xontrib</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of xontrib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.coreutils.html">xontrib.coreutils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced_events.html">Advanced Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="devguide.html">Developer’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Xonsh Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Wishlist & To-Dos</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="edit-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/edit/main/docs/envvars.rst.jinja2" title="Edit this page">
<svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
<line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
</svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="environment-variables">
<h1>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h1>
<p>The following displays information about the environment variables that
affect xonsh performance in some way. It also lists their default values, if
applicable.</p>
<div class="table-wrapper docutils container" id="id151">
<table class="docutils align-default" id="id151">
<caption><span class="caption-text"><a class="reference internal" href="#general"><span class="std std-ref">General</span></a></span><a class="headerlink" href="#id151" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#auto-continue"><span class="std std-ref">$AUTO_CONTINUE</span></a></p></td>
<td><p><a class="reference internal" href="#commands-cache-save-intermediate"><span class="std std-ref">$COMMANDS_CACHE_SAVE_INTERMEDIATE</span></a></p></td>
<td><p><a class="reference internal" href="#enable-commands-cache"><span class="std std-ref">$ENABLE_COMMANDS_CACHE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hostname"><span class="std std-ref">$HOSTNAME</span></a></p></td>
<td><p><a class="reference internal" href="#hosttype"><span class="std std-ref">$HOSTTYPE</span></a></p></td>
<td><p><a class="reference internal" href="#lang"><span class="std std-ref">$LANG</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#last-return-code"><span class="std std-ref">$LAST_RETURN_CODE</span></a></p></td>
<td><p><a class="reference internal" href="#lc-collate"><span class="std std-ref">$LC_COLLATE</span></a></p></td>
<td><p><a class="reference internal" href="#lc-ctype"><span class="std std-ref">$LC_CTYPE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#lc-messages"><span class="std std-ref">$LC_MESSAGES</span></a></p></td>
<td><p><a class="reference internal" href="#lc-monetary"><span class="std std-ref">$LC_MONETARY</span></a></p></td>
<td><p><a class="reference internal" href="#lc-numeric"><span class="std std-ref">$LC_NUMERIC</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#lc-time"><span class="std std-ref">$LC_TIME</span></a></p></td>
<td><p><a class="reference internal" href="#oldpwd"><span class="std std-ref">$OLDPWD</span></a></p></td>
<td><p><a class="reference internal" href="#path"><span class="std std-ref">$PATH</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pathext"><span class="std std-ref">$PATHEXT</span></a></p></td>
<td><p><a class="reference internal" href="#raise-subproc-error"><span class="std std-ref">$RAISE_SUBPROC_ERROR</span></a></p></td>
<td><p><a class="reference internal" href="#shlvl"><span class="std std-ref">$SHLVL</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#term"><span class="std std-ref">$TERM</span></a></p></td>
<td><p><a class="reference internal" href="#thread-subprocs"><span class="std std-ref">$THREAD_SUBPROCS</span></a></p></td>
<td><p><a class="reference internal" href="#update-os-environ"><span class="std std-ref">$UPDATE_OS_ENVIRON</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xdg-cache-home"><span class="std std-ref">$XDG_CACHE_HOME</span></a></p></td>
<td><p><a class="reference internal" href="#xdg-config-home"><span class="std std-ref">$XDG_CONFIG_HOME</span></a></p></td>
<td><p><a class="reference internal" href="#xdg-data-dirs"><span class="std std-ref">$XDG_DATA_DIRS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xdg-data-home"><span class="std std-ref">$XDG_DATA_HOME</span></a></p></td>
<td><p><a class="reference internal" href="#xonshrc"><span class="std std-ref">$XONSHRC</span></a></p></td>
<td><p><a class="reference internal" href="#xonshrc-dir"><span class="std std-ref">$XONSHRC_DIR</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-append-newline"><span class="std std-ref">$XONSH_APPEND_NEWLINE</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-cache-dir"><span class="std std-ref">$XONSH_CACHE_DIR</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-cache-everything"><span class="std std-ref">$XONSH_CACHE_EVERYTHING</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-cache-scripts"><span class="std std-ref">$XONSH_CACHE_SCRIPTS</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-capture-always"><span class="std std-ref">$XONSH_CAPTURE_ALWAYS</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-color-style"><span class="std std-ref">$XONSH_COLOR_STYLE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-completer-dirs"><span class="std std-ref">$XONSH_COMPLETER_DIRS</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-config-dir"><span class="std std-ref">$XONSH_CONFIG_DIR</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-data-dir"><span class="std std-ref">$XONSH_DATA_DIR</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-datetime-format"><span class="std std-ref">$XONSH_DATETIME_FORMAT</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-debug"><span class="std std-ref">$XONSH_DEBUG</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-encoding"><span class="std std-ref">$XONSH_ENCODING</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-encoding-errors"><span class="std std-ref">$XONSH_ENCODING_ERRORS</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-interactive"><span class="std std-ref">$XONSH_INTERACTIVE</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-login"><span class="std std-ref">$XONSH_LOGIN</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-proc-frequency"><span class="std std-ref">$XONSH_PROC_FREQUENCY</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-show-traceback"><span class="std std-ref">$XONSH_SHOW_TRACEBACK</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-source"><span class="std std-ref">$XONSH_SOURCE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-store-stdin"><span class="std std-ref">$XONSH_STORE_STDIN</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-style-overrides"><span class="std std-ref">$XONSH_STYLE_OVERRIDES</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-subproc-captured-print-stderr"><span class="std std-ref">$XONSH_SUBPROC_CAPTURED_PRINT_STDERR</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-sys-config-dir"><span class="std std-ref">$XONSH_SYS_CONFIG_DIR</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-traceback-logfile"><span class="std std-ref">$XONSH_TRACEBACK_LOGFILE</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-trace-completions"><span class="std std-ref">$XONSH_TRACE_COMPLETIONS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-trace-subproc"><span class="std std-ref">$XONSH_TRACE_SUBPROC</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-trace-subproc-func"><span class="std std-ref">$XONSH_TRACE_SUBPROC_FUNC</span></a></p></td>
<td><p><a class="reference internal" href="#xontribs-autoload-disabled"><span class="std std-ref">$XONTRIBS_AUTOLOAD_DISABLED</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#w-dirs"><span class="std std-ref">$w*DIRS$</span></a></p></td>
<td><p><a class="reference internal" href="#w-path"><span class="std std-ref">$w*PATH$</span></a></p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id152">
<table class="docutils align-default" id="id152">
<caption><span class="caption-text"><a class="reference internal" href="#windows-os"><span class="std std-ref">Windows OS</span></a></span><a class="headerlink" href="#id152" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#ansicon"><span class="std std-ref">$ANSICON</span></a></p></td>
<td><p><a class="reference internal" href="#force-posix-paths"><span class="std std-ref">$FORCE_POSIX_PATHS</span></a></p></td>
<td><p><a class="reference internal" href="#intensify-colors-on-win"><span class="std std-ref">$INTENSIFY_COLORS_ON_WIN</span></a></p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id153">
<table class="docutils align-default" id="id153">
<caption><span class="caption-text"><a class="reference internal" href="#cd-behavior"><span class="std std-ref">cd Behavior</span></a></span><a class="headerlink" href="#id153" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#auto-cd"><span class="std std-ref">$AUTO_CD</span></a></p></td>
<td><p><a class="reference internal" href="#auto-pushd"><span class="std std-ref">$AUTO_PUSHD</span></a></p></td>
<td><p><a class="reference internal" href="#cdpath"><span class="std std-ref">$CDPATH</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#complete-dots"><span class="std std-ref">$COMPLETE_DOTS</span></a></p></td>
<td><p><a class="reference internal" href="#dirstack-size"><span class="std std-ref">$DIRSTACK_SIZE</span></a></p></td>
<td><p><a class="reference internal" href="#pushd-minus"><span class="std std-ref">$PUSHD_MINUS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pushd-silent"><span class="std std-ref">$PUSHD_SILENT</span></a></p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id154">
<table class="docutils align-default" id="id154">
<caption><span class="caption-text"><a class="reference internal" href="#interpreter-behavior"><span class="std std-ref">Interpreter Behavior</span></a></span><a class="headerlink" href="#id154" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#dotglob"><span class="std std-ref">$DOTGLOB</span></a></p></td>
<td><p><a class="reference internal" href="#expand-env-vars"><span class="std std-ref">$EXPAND_ENV_VARS</span></a></p></td>
<td><p><a class="reference internal" href="#foreign-aliases-override"><span class="std std-ref">$FOREIGN_ALIASES_OVERRIDE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#foreign-aliases-suppress-skip-message"><span class="std std-ref">$FOREIGN_ALIASES_SUPPRESS_SKIP_MESSAGE</span></a></p></td>
<td><p><a class="reference internal" href="#glob-sorted"><span class="std std-ref">$GLOB_SORTED</span></a></p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id155">
<table class="docutils align-default" id="id155">
<caption><span class="caption-text"><a class="reference internal" href="#interactive-prompt"><span class="std std-ref">Interactive Prompt</span></a></span><a class="headerlink" href="#id155" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#bottom-toolbar"><span class="std std-ref">$BOTTOM_TOOLBAR</span></a></p></td>
<td><p><a class="reference internal" href="#color-input"><span class="std std-ref">$COLOR_INPUT</span></a></p></td>
<td><p><a class="reference internal" href="#color-results"><span class="std std-ref">$COLOR_RESULTS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#dynamic-cwd-elision-char"><span class="std std-ref">$DYNAMIC_CWD_ELISION_CHAR</span></a></p></td>
<td><p><a class="reference internal" href="#dynamic-cwd-width"><span class="std std-ref">$DYNAMIC_CWD_WIDTH</span></a></p></td>
<td><p><a class="reference internal" href="#ignoreeof"><span class="std std-ref">$IGNOREEOF</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#indent"><span class="std std-ref">$INDENT</span></a></p></td>
<td><p><a class="reference internal" href="#ls-colors"><span class="std std-ref">$LS_COLORS</span></a></p></td>
<td><p><a class="reference internal" href="#multiline-prompt"><span class="std std-ref">$MULTILINE_PROMPT</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#multiline-prompt-pos"><span class="std std-ref">$MULTILINE_PROMPT_POS</span></a></p></td>
<td><p><a class="reference internal" href="#multiline-prompt-pre"><span class="std std-ref">$MULTILINE_PROMPT_PRE</span></a></p></td>
<td><p><a class="reference internal" href="#pretty-print-results"><span class="std std-ref">$PRETTY_PRINT_RESULTS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#prompt"><span class="std std-ref">$PROMPT</span></a></p></td>
<td><p><a class="reference internal" href="#prompt-fields"><span class="std std-ref">$PROMPT_FIELDS</span></a></p></td>
<td><p><a class="reference internal" href="#prompt-refresh-interval"><span class="std std-ref">$PROMPT_REFRESH_INTERVAL</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#prompt-tokens-formatter"><span class="std std-ref">$PROMPT_TOKENS_FORMATTER</span></a></p></td>
<td><p><a class="reference internal" href="#right-prompt"><span class="std std-ref">$RIGHT_PROMPT</span></a></p></td>
<td><p><a class="reference internal" href="#shell-type"><span class="std std-ref">$SHELL_TYPE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#suggest-commands"><span class="std std-ref">$SUGGEST_COMMANDS</span></a></p></td>
<td><p><a class="reference internal" href="#suggest-max-num"><span class="std std-ref">$SUGGEST_MAX_NUM</span></a></p></td>
<td><p><a class="reference internal" href="#suggest-threshold"><span class="std std-ref">$SUGGEST_THRESHOLD</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#suppress-branch-timeout-message"><span class="std std-ref">$SUPPRESS_BRANCH_TIMEOUT_MESSAGE</span></a></p></td>
<td><p><a class="reference internal" href="#title"><span class="std std-ref">$TITLE</span></a></p></td>
<td><p><a class="reference internal" href="#update-prompt-on-keypress"><span class="std std-ref">$UPDATE_PROMPT_ON_KEYPRESS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#vc-branch-timeout"><span class="std std-ref">$VC_BRANCH_TIMEOUT</span></a></p></td>
<td><p><a class="reference internal" href="#vc-git-include-untracked"><span class="std std-ref">$VC_GIT_INCLUDE_UNTRACKED</span></a></p></td>
<td><p><a class="reference internal" href="#vc-hg-show-branch"><span class="std std-ref">$VC_HG_SHOW_BRANCH</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#virtual-env"><span class="std std-ref">$VIRTUAL_ENV</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-history-match-anywhere"><span class="std std-ref">$XONSH_HISTORY_MATCH_ANYWHERE</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-stderr-postfix"><span class="std std-ref">$XONSH_STDERR_POSTFIX</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-stderr-prefix"><span class="std std-ref">$XONSH_STDERR_PREFIX</span></a></p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id156">
<table class="docutils align-default" id="id156">
<caption><span class="caption-text"><a class="reference internal" href="#prompt-toolkit-shell"><span class="std std-ref">Prompt Toolkit shell</span></a></span><a class="headerlink" href="#id156" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#auto-suggest"><span class="std std-ref">$AUTO_SUGGEST</span></a></p></td>
<td><p><a class="reference internal" href="#auto-suggest-in-completions"><span class="std std-ref">$AUTO_SUGGEST_IN_COMPLETIONS</span></a></p></td>
<td><p><a class="reference internal" href="#mouse-support"><span class="std std-ref">$MOUSE_SUPPORT</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#prompt-toolkit-color-depth"><span class="std std-ref">$PROMPT_TOOLKIT_COLOR_DEPTH</span></a></p></td>
<td><p><a class="reference internal" href="#ptk-style-overrides"><span class="std std-ref">$PTK_STYLE_OVERRIDES</span></a></p></td>
<td><p><a class="reference internal" href="#vi-mode"><span class="std std-ref">$VI_MODE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-autopair"><span class="std std-ref">$XONSH_AUTOPAIR</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-copy-on-delete"><span class="std std-ref">$XONSH_COPY_ON_DELETE</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-ctrl-bksp-deletion"><span class="std std-ref">$XONSH_CTRL_BKSP_DELETION</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-use-system-clipboard"><span class="std std-ref">$XONSH_USE_SYSTEM_CLIPBOARD</span></a></p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id157">
<table class="docutils align-default" id="id157">
<caption><span class="caption-text"><a class="reference internal" href="#asynchronous-prompt"><span class="std std-ref">Asynchronous Prompt</span></a></span><a class="headerlink" href="#id157" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#async-invalidate-interval"><span class="std std-ref">$ASYNC_INVALIDATE_INTERVAL</span></a></p></td>
<td><p><a class="reference internal" href="#async-prompt-thread-workers"><span class="std std-ref">$ASYNC_PROMPT_THREAD_WORKERS</span></a></p></td>
<td><p><a class="reference internal" href="#enable-async-prompt"><span class="std std-ref">$ENABLE_ASYNC_PROMPT</span></a></p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id158">
<table class="docutils align-default" id="id158">
<caption><span class="caption-text"><a class="reference internal" href="#interactive-prompt-history"><span class="std std-ref">Interactive Prompt History</span></a></span><a class="headerlink" href="#id158" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#histcontrol"><span class="std std-ref">$HISTCONTROL</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-history-backend"><span class="std std-ref">$XONSH_HISTORY_BACKEND</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-history-file"><span class="std std-ref">$XONSH_HISTORY_FILE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-history-ignore-regex"><span class="std std-ref">$XONSH_HISTORY_IGNORE_REGEX</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-history-save-cwd"><span class="std std-ref">$XONSH_HISTORY_SAVE_CWD</span></a></p></td>
<td><p><a class="reference internal" href="#xonsh-history-size"><span class="std std-ref">$XONSH_HISTORY_SIZE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#xonsh-store-stdout"><span class="std std-ref">$XONSH_STORE_STDOUT</span></a></p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id159">
<table class="docutils align-default" id="id159">
<caption><span class="caption-text"><a class="reference internal" href="#tab-completion-behavior"><span class="std std-ref">Tab-completion behavior.</span></a></span><a class="headerlink" href="#id159" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#alias-completions-options-by-default"><span class="std std-ref">$ALIAS_COMPLETIONS_OPTIONS_BY_DEFAULT</span></a></p></td>
<td><p><a class="reference internal" href="#alias-completions-options-longest"><span class="std std-ref">$ALIAS_COMPLETIONS_OPTIONS_LONGEST</span></a></p></td>
<td><p><a class="reference internal" href="#bash-completions"><span class="std std-ref">$BASH_COMPLETIONS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#case-sensitive-completions"><span class="std std-ref">$CASE_SENSITIVE_COMPLETIONS</span></a></p></td>
<td><p><a class="reference internal" href="#cmd-completions-show-desc"><span class="std std-ref">$CMD_COMPLETIONS_SHOW_DESC</span></a></p></td>
<td><p><a class="reference internal" href="#completions-brackets"><span class="std std-ref">$COMPLETIONS_BRACKETS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#completion-query-limit"><span class="std std-ref">$COMPLETION_QUERY_LIMIT</span></a></p></td>
<td><p><a class="reference internal" href="#fuzzy-path-completion"><span class="std std-ref">$FUZZY_PATH_COMPLETION</span></a></p></td>
<td><p><a class="reference internal" href="#subsequence-path-completion"><span class="std std-ref">$SUBSEQUENCE_PATH_COMPLETION</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#xonsh-bash-path-override"><span class="std std-ref">$XONSH_BASH_PATH_OVERRIDE</span></a></p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="table-wrapper docutils container" id="id160">
<table class="docutils align-default" id="id160">
<caption><span class="caption-text"><a class="reference internal" href="#prompt-toolkit-tab-completion"><span class="std std-ref">Prompt Toolkit tab-completion</span></a></span><a class="headerlink" href="#id160" title="Link to this table">¶</a></caption>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#completions-confirm"><span class="std std-ref">$COMPLETIONS_CONFIRM</span></a></p></td>
<td><p><a class="reference internal" href="#completions-display"><span class="std std-ref">$COMPLETIONS_DISPLAY</span></a></p></td>
<td><p><a class="reference internal" href="#completions-menu-rows"><span class="std std-ref">$COMPLETIONS_MENU_ROWS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#completion-in-thread"><span class="std std-ref">$COMPLETION_IN_THREAD</span></a></p></td>
<td><p><a class="reference internal" href="#completion-mode"><span class="std std-ref">$COMPLETION_MODE</span></a></p></td>
<td><p><a class="reference internal" href="#update-completions-on-keypress"><span class="std std-ref">$UPDATE_COMPLETIONS_ON_KEYPRESS</span></a></p></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<section id="general">
<span id="id1"></span><h2>General<a class="headerlink" href="#general" title="Link to this heading">¶</a></h2>
<section id="auto-continue">
<span id="id2"></span><h3>$AUTO_CONTINUE<a class="headerlink" href="#auto-continue" title="Link to this heading">¶</a></h3>
<p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, automatically resume stopped jobs when they are disowned. When stopped jobs are disowned and this option is <code class="docutils literal notranslate"><span class="pre">False</span></code>, a warning will print information about how to continue the stopped process.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="commands-cache-save-intermediate">
<span id="id3"></span><h3>$COMMANDS_CACHE_SAVE_INTERMEDIATE<a class="headerlink" href="#commands-cache-save-intermediate" title="Link to this heading">¶</a></h3>
<p>If enabled, the CommandsCache is saved between runs and can reduce the startup time.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="enable-commands-cache">
<span id="id4"></span><h3>$ENABLE_COMMANDS_CACHE<a class="headerlink" href="#enable-commands-cache" title="Link to this heading">¶</a></h3>
<p>command names in a directory are cached when enabled. On some platforms it may not be accurate enough(e.g. Windows, Linux save mtime in seconds). Setting it to False would disable the caching mechanism and may slow down the shell</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> True</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="hostname">
<span id="id5"></span><h3>$HOSTNAME<a class="headerlink" href="#hostname" title="Link to this heading">¶</a></h3>
<p>Automatically set to the name of the current host.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <function GeneralSetting.<lambda> at 0x7558f8bb4860></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="hosttype">
<span id="id6"></span><h3>$HOSTTYPE<a class="headerlink" href="#hosttype" title="Link to this heading">¶</a></h3>
<p>Automatically set to a string that fully describes the system type on which xonsh is executing.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <function GeneralSetting.<lambda> at 0x7558f8bb4900></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lang">
<span id="id7"></span><h3>$LANG<a class="headerlink" href="#lang" title="Link to this heading">¶</a></h3>
<p>Fallback locale setting for systems where it matters</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘C.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="last-return-code">
<span id="id8"></span><h3>$LAST_RETURN_CODE<a class="headerlink" href="#last-return-code" title="Link to this heading">¶</a></h3>
<p>Integer return code of the last command. Only updated during interactive use, i.e. not during execution of scripts.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> 0</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-collate">
<span id="id9"></span><h3>$LC_COLLATE<a class="headerlink" href="#lc-collate" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-ctype">
<span id="id10"></span><h3>$LC_CTYPE<a class="headerlink" href="#lc-ctype" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-messages">
<span id="id11"></span><h3>$LC_MESSAGES<a class="headerlink" href="#lc-messages" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-monetary">
<span id="id12"></span><h3>$LC_MONETARY<a class="headerlink" href="#lc-monetary" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-numeric">
<span id="id13"></span><h3>$LC_NUMERIC<a class="headerlink" href="#lc-numeric" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="lc-time">
<span id="id14"></span><h3>$LC_TIME<a class="headerlink" href="#lc-time" title="Link to this heading">¶</a></h3>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘en_US.UTF-8’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="oldpwd">
<span id="id15"></span><h3>$OLDPWD<a class="headerlink" href="#oldpwd" title="Link to this heading">¶</a></h3>
<p>Used to represent a previous present working directory.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> ‘.’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="path">
<span id="id16"></span><h3>$PATH<a class="headerlink" href="#path" title="Link to this heading">¶</a></h3>
<p>List of strings representing where to look for executables.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> On Windows: it is <code class="docutils literal notranslate"><span class="pre">Path</span></code> value of register’s <code class="docutils literal notranslate"><span class="pre">HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session</span> <span class="pre">Manager\Environment</span></code>. On Mac OSX: <code class="docutils literal notranslate"><span class="pre">('/usr/local/bin',</span> <span class="pre">'/usr/bin',</span> <span class="pre">'/bin',</span> <span class="pre">'/usr/sbin',</span> <span class="pre">'/sbin')</span></code> On Linux & on Cygwin & on MSYS, when detected that the distro is like arch, the default PATH is <code class="docutils literal notranslate"><span class="pre">('/usr/local/sbin',</span> <span class="pre">'/usr/local/bin',</span> <span class="pre">'/usr/bin',</span> <span class="pre">'/usr/bin/site_perl',</span> <span class="pre">'/usr/bin/vendor_perl',</span> <span class="pre">'/usr/bin/core_perl')</span></code> and otherwise is <code class="docutils literal notranslate"><span class="pre">('~/bin',</span> <span class="pre">'/usr/local/sbin',</span> <span class="pre">'/usr/local/bin',</span> <span class="pre">'/usr/sbin','/usr/bin',</span> <span class="pre">'/sbin',</span> <span class="pre">'/bin',</span> <span class="pre">'/usr/games',</span> <span class="pre">'/usr/local/games')</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="pathext">
<span id="id17"></span><h3>$PATHEXT<a class="headerlink" href="#pathext" title="Link to this heading">¶</a></h3>
<p>Sequence of extension strings (eg, <code class="docutils literal notranslate"><span class="pre">.EXE</span></code>) for filtering valid executables by. Each element must be uppercase.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> []</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="raise-subproc-error">
<span id="id18"></span><h3>$RAISE_SUBPROC_ERROR<a class="headerlink" href="#raise-subproc-error" title="Link to this heading">¶</a></h3>
<p>Whether or not to raise an error if a subprocess (captured or uncaptured) returns a non-zero exit status, which indicates failure. This is most useful in xonsh scripts or modules where failures should cause an end to execution. This is less useful at a terminal. The error that is raised is a <code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code>.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="shlvl">
<span id="id19"></span><h3>$SHLVL<a class="headerlink" href="#shlvl" title="Link to this heading">¶</a></h3>
<p>Shell nesting level typed as integer, mirrors bash’s $SHLVL.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> 0</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="term">
<span id="id20"></span><h3>$TERM<a class="headerlink" href="#term" title="Link to this heading">¶</a></h3>
<p>TERM is sometimes set by the terminal emulator. This is used (when valid) to determine whether the terminal emulator can support the selected shell, or whether or not to set the title. Users shouldn’t need to set this themselves. Note that this variable should be set as early as possible in order to ensure it is effective. Here are a few options:</p>
<ul class="simple">
<li><p>Set this from the program that launches xonsh. On POSIX systems,
this can be performed by using env, e.g.
<code class="docutils literal notranslate"><span class="pre">/usr/bin/env</span> <span class="pre">TERM=xterm-color</span> <span class="pre">xonsh</span></code> or similar.</p></li>
<li><p>From the xonsh command line, namely <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">-DTERM=xterm-color</span></code>.</p></li>
<li><p>In the config file with <code class="docutils literal notranslate"><span class="pre">{"env":</span> <span class="pre">{"TERM":</span> <span class="pre">"xterm-color"}}</span></code>.</p></li>
<li><p>Lastly, in xonshrc with <code class="docutils literal notranslate"><span class="pre">$TERM</span></code></p></li>
</ul>
<p>Ideally, your terminal emulator will set this correctly but that does not always happen.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> not defined</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="thread-subprocs">
<span id="id21"></span><h3>$THREAD_SUBPROCS<a class="headerlink" href="#thread-subprocs" title="Link to this heading">¶</a></h3>
<p>Note: The <code class="docutils literal notranslate"><span class="pre">$XONSH_CAPTURE_ALWAYS</span></code> variable introduces finer control and you should probably use that instead.</p>
<p>Whether or not to try to run subrocess mode in a Python thread, when trying to capture its output. There are various trade-offs.</p>
<dl class="simple">
<dt>If True, xonsh is able capture & store the stdin, stdout, and stderr</dt><dd><p>of threadable subprocesses.</p>
</dd>
</dl>
<p>The disadvantages are listed in <code class="docutils literal notranslate"><span class="pre">$XONSH_CAPTURE_ALWAYS</span></code>.
The desired effect is often up to the command, user, or use case.</p>
<p>None values are for internal use only and are used to turn off threading when loading xonshrc files. This is done because Bash was automatically placing new xonsh instances in the background at startup when threadable subprocs were used. Please see <a class="reference external" href="https://github.com/xonsh/xonsh/pull/3705">https://github.com/xonsh/xonsh/pull/3705</a> for more information.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> True</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="update-os-environ">
<span id="id22"></span><h3>$UPDATE_OS_ENVIRON<a class="headerlink" href="#update-os-environ" title="Link to this heading">¶</a></h3>
<p>If True <code class="docutils literal notranslate"><span class="pre">os_environ</span></code> will always be updated when the xonsh environment changes. The environment can be reset to the default value by calling <code class="docutils literal notranslate"><span class="pre">__xonsh__.env.undo_replace_env()</span></code></p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xdg-cache-home">
<span id="id23"></span><h3>$XDG_CACHE_HOME<a class="headerlink" href="#xdg-cache-home" title="Link to this heading">¶</a></h3>
<p>The base directory relative to which user-specific non-essential data files should be stored.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">~/.cache</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xdg-config-home">
<span id="id24"></span><h3>$XDG_CONFIG_HOME<a class="headerlink" href="#xdg-config-home" title="Link to this heading">¶</a></h3>
<p>Open desktop standard configuration home dir. This is the same default as used in the standard.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">~/.config</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xdg-data-dirs">
<span id="id25"></span><h3>$XDG_DATA_DIRS<a class="headerlink" href="#xdg-data-dirs" title="Link to this heading">¶</a></h3>
<p>A list of directories where system level data files are stored.</p>
<p><strong>configurable:</strong> True</p>
<dl class="simple">
<dt><strong>default:</strong> On Windows: <code class="docutils literal notranslate"><span class="pre">[%ProgramData%]</span></code> (normally C:ProgramData)</dt><dd><ul class="simple">
<li><p>More Info: <a class="reference external" href="https://docs.microsoft.com/en-us/windows-hardware/customize/desktop/unattend/microsoft-windows-shell-setup-folderlocations-programdata">https://docs.microsoft.com/en-us/windows-hardware/customize/desktop/unattend/microsoft-windows-shell-setup-folderlocations-programdata</a></p></li>
</ul>
</dd>
</dl>
<p>On Linux and Unix based systemd it is the same as in open-desktop standard: <code class="docutils literal notranslate"><span class="pre">['/usr/share',</span> <span class="pre">'/usr/local/share']</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xdg-data-home">
<span id="id26"></span><h3>$XDG_DATA_HOME<a class="headerlink" href="#xdg-data-home" title="Link to this heading">¶</a></h3>
<p>Open desktop standard data home dir. This is the same default as used in the standard.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">~/.local/share</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonshrc">
<span id="id27"></span><h3>$XONSHRC<a class="headerlink" href="#xonshrc" title="Link to this heading">¶</a></h3>
<p>A list of the locations of run control files, if they exist. User defined run control file will supersede values set in system-wide control file if there is a naming collision. $THREAD_SUBPROCS=None when reading in run control files.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">['$XONSH_SYS_CONFIG_DIR/xonshrc',</span> <span class="pre">'$XONSH_CONFIG_DIR/xonsh/rc.xsh',</span> <span class="pre">'~/.xonshrc']</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonshrc-dir">
<span id="id28"></span><h3>$XONSHRC_DIR<a class="headerlink" href="#xonshrc-dir" title="Link to this heading">¶</a></h3>
<p>A list of directories, from which all .xsh|.py files will be loaded at startup, sorted in lexographic order. Files in these directories are loaded after any files in XONSHRC.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">['$XONSH_SYS_CONFIG_DIR/rc.d',</span> <span class="pre">'$XONSH_CONFIG_DIR/rc.d']</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-append-newline">
<span id="id29"></span><h3>$XONSH_APPEND_NEWLINE<a class="headerlink" href="#xonsh-append-newline" title="Link to this heading">¶</a></h3>
<p>Append new line when a partial line is preserved in output.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">$XONSH_INTERACTIVE</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-cache-dir">
<span id="id30"></span><h3>$XONSH_CACHE_DIR<a class="headerlink" href="#xonsh-cache-dir" title="Link to this heading">¶</a></h3>
<p>This is the location where cache files used by xonsh are stored, such as commands-cache…</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">$XDG_CACHE_HOME/xonsh</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-cache-everything">
<span id="id31"></span><h3>$XONSH_CACHE_EVERYTHING<a class="headerlink" href="#xonsh-cache-everything" title="Link to this heading">¶</a></h3>
<p>Controls whether all code (including code entered at the interactive prompt) will be cached.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-cache-scripts">
<span id="id32"></span><h3>$XONSH_CACHE_SCRIPTS<a class="headerlink" href="#xonsh-cache-scripts" title="Link to this heading">¶</a></h3>
<p>Controls whether the code for scripts run from xonsh will be cached (<code class="docutils literal notranslate"><span class="pre">True</span></code>) or re-compiled each time (<code class="docutils literal notranslate"><span class="pre">False</span></code>).</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> True</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-capture-always">
<span id="id33"></span><h3>$XONSH_CAPTURE_ALWAYS<a class="headerlink" href="#xonsh-capture-always" title="Link to this heading">¶</a></h3>
<p>Try to capture output of commands run without explicit capturing.
If True, xonsh will capture the output of commands run directly or in <code class="docutils literal notranslate"><span class="pre">![]``to</span> <span class="pre">the</span> <span class="pre">session</span> <span class="pre">history.</span>
<span class="pre">Setting</span> <span class="pre">to</span> <span class="pre">True</span> <span class="pre">has</span> <span class="pre">the</span> <span class="pre">following</span> <span class="pre">disadvantages:</span>
<span class="pre">*</span> <span class="pre">Some</span> <span class="pre">interactive</span> <span class="pre">commands</span> <span class="pre">won't</span> <span class="pre">work</span> <span class="pre">properly</span> <span class="pre">(like</span> <span class="pre">when</span> <span class="pre">``git</span></code> invokes an interactive editor).</p>
<blockquote>
<div><p>For more information see discussion at <a class="reference external" href="https://github.com/xonsh/xonsh/issues/3672">https://github.com/xonsh/xonsh/issues/3672</a>.</p>
</div></blockquote>
<ul class="simple">
<li><p>Stopping these commands with ^Z (i.e. <code class="docutils literal notranslate"><span class="pre">SIGTSTP</span></code>)
is disabled as it causes deadlocked terminals.
<code class="docutils literal notranslate"><span class="pre">SIGTSTP</span></code> may still be issued and only the physical pressing
of <code class="docutils literal notranslate"><span class="pre">Ctrl+Z</span></code> is ignored.</p></li>
</ul>
<p>Regardless of this value, commands run in <code class="docutils literal notranslate"><span class="pre">$()</span></code>, <code class="docutils literal notranslate"><span class="pre">!()</span></code> or with an IO redirection (<code class="docutils literal notranslate"><span class="pre">></span></code> or <code class="docutils literal notranslate"><span class="pre">|</span></code>) will always be captured.
Setting this to True depends on <code class="docutils literal notranslate"><span class="pre">$THREAD_SUBPROCS</span></code> being True.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> False</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-color-style">
<span id="id34"></span><h3>$XONSH_COLOR_STYLE<a class="headerlink" href="#xonsh-color-style" title="Link to this heading">¶</a></h3>
<p>Sets the color style for xonsh colors. This is a style name, not a color map. Run <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">styles</span></code> to see the available styles.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘default’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-completer-dirs">
<span id="id35"></span><h3>$XONSH_COMPLETER_DIRS<a class="headerlink" href="#xonsh-completer-dirs" title="Link to this heading">¶</a></h3>
<p>A list of paths where Xonsh searches for command completions.
Any completions defined are lazy loaded when needed.
The name of the completer file should match that of the completing command.
The file should contain a function with the signature
<code class="docutils literal notranslate"><span class="pre">xonsh_complete(ctx:</span> <span class="pre">CommandContext)</span> <span class="pre">-></span> <span class="pre">Iterator[RichCompletion|str]</span></code>.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> By default, the following paths are searched.
1. <code class="docutils literal notranslate"><span class="pre">$XONSH_CONFIG_DIR/completions</span></code> - user level completions
2. <code class="docutils literal notranslate"><span class="pre">$XONSH_SYS_CONFIG_DIR/completions</span></code> - system level completions
3. <code class="docutils literal notranslate"><span class="pre">$XONSH_DATA_DIR/generated_completions</span></code> - auto generated completers from man pages
4. <code class="docutils literal notranslate"><span class="pre">$XDG_DATA_DIRS/xonsh/vendor_completions</span></code> - completers from other programs can be placed here.</p>
<p>Other than this, Python package namespace <code class="docutils literal notranslate"><span class="pre">xompletions</span></code> can be used to put completer modules as well.</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-config-dir">
<span id="id36"></span><h3>$XONSH_CONFIG_DIR<a class="headerlink" href="#xonsh-config-dir" title="Link to this heading">¶</a></h3>
<p>This is the location where xonsh user-level configuration information is stored.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">$XDG_CONFIG_HOME/xonsh</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-data-dir">
<span id="id37"></span><h3>$XONSH_DATA_DIR<a class="headerlink" href="#xonsh-data-dir" title="Link to this heading">¶</a></h3>
<p>This is the location where xonsh data files are stored, such as history, generated completers …</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">$XDG_DATA_HOME/xonsh</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-datetime-format">
<span id="id38"></span><h3>$XONSH_DATETIME_FORMAT<a class="headerlink" href="#xonsh-datetime-format" title="Link to this heading">¶</a></h3>
<p>The format that is used for <code class="docutils literal notranslate"><span class="pre">datetime.strptime()</span></code> in various places, i.e the history timestamp option.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> ‘%Y-%m-%d %H:%M’</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-debug">
<span id="id39"></span><h3>$XONSH_DEBUG<a class="headerlink" href="#xonsh-debug" title="Link to this heading">¶</a></h3>
<p>Sets the xonsh debugging level. This may be an integer or a boolean. Setting it to <code class="docutils literal notranslate"><span class="pre">1</span></code> will get some basic information like input transformation, command replacement. With <code class="docutils literal notranslate"><span class="pre">2</span></code> or a higher number will make more debugging information presented, like PLY parsing messages.</p>
<p><strong>configurable:</strong> False</p>
<p><strong>default:</strong> 0</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-encoding">
<span id="id40"></span><h3>$XONSH_ENCODING<a class="headerlink" href="#xonsh-encoding" title="Link to this heading">¶</a></h3>
<p>This is the encoding that xonsh should use for subprocess operations.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> <code class="docutils literal notranslate"><span class="pre">sys.getdefaultencoding()</span></code></p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="xonsh-encoding-errors">
<span id="id41"></span><h3>$XONSH_ENCODING_ERRORS<a class="headerlink" href="#xonsh-encoding-errors" title="Link to this heading">¶</a></h3>
<p>The flag for how to handle encoding errors should they happen. Any string flag that has been previously registered with Python is allowed. See the ‘Python codecs documentation’ (<a class="reference external" href="https://docs.python.org/3/library/codecs.html#error-handlers">https://docs.python.org/3/library/codecs.html#error-handlers</a>) for more information and available options.</p>