-
Notifications
You must be signed in to change notification settings - Fork 7
/
customization.html
641 lines (604 loc) · 49.8 KB
/
customization.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
<!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="Environment Variables" href="envvars.html" /><link rel="prev" title="Run Control File" href="xonshrc.html" />
<link rel="shortcut icon" href="_static/magic_conch.ico"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
<title>Updating and customizing xonsh - 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 current current-page"><a class="current reference internal" href="#">Updating and customizing xonsh</a></li>
<li class="toctree-l1"><a class="reference internal" href="envvars.html">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/customization.rst" 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="updating-and-customizing-xonsh">
<h1>Updating and customizing xonsh<a class="headerlink" href="#updating-and-customizing-xonsh" title="Link to this heading">¶</a></h1>
<section id="updating-xonsh">
<h2>Updating xonsh<a class="headerlink" href="#updating-xonsh" title="Link to this heading">¶</a></h2>
<p>How to update xonsh depend on the install method.</p>
<p><strong>xonsh installed via pip</strong></p>
<p>If you have installed via pip (possibly into a virtual environment),
then you can update xonsh from within itself with the following
command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ xpip install --upgrade xonsh</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">xpip</span></code> (note the “x” at the beginning of <code class="docutils literal notranslate"><span class="pre">xpip</span></code>) is a predefined alias pointing to the <code class="docutils literal notranslate"><span class="pre">pip</span></code> command associated with the Python executable running this xonsh.</p>
<p><strong>xonsh installed via a package manager</strong></p>
<p>If you have installed via a package manager, it is recommended to update xonsh through the package manager’s appropriate command. For example, on macOS if you have installed via homebrew, you should update like this:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>upgrade<span class="w"> </span>xonsh
</pre></div>
</div>
</section>
<section id="customizing-xonsh-how-do-i">
<h2>Customizing xonsh - How do I…<a class="headerlink" href="#customizing-xonsh-how-do-i" title="Link to this heading">¶</a></h2>
<section id="change-the-current-color-theme">
<span id="change-theme"></span><h3>…change the current color theme?<a class="headerlink" href="#change-the-current-color-theme" title="Link to this heading">¶</a></h3>
<p>You can view the available styles by typing</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ xonfig styles</span>
</pre></div>
</div>
<p>For a quick peek at the theme’s colors you can do</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ xonfig colors <theme name></span>
</pre></div>
</div>
<p>To set a new theme, do</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ $XONSH_COLOR_STYLE='<theme name>'</span>
</pre></div>
</div>
<section id="registering-custom-styles">
<h4>Registering custom styles<a class="headerlink" href="#registering-custom-styles" title="Link to this heading">¶</a></h4>
<p>If you aren’t happy with the styles provided by us (and <code class="docutils literal notranslate"><span class="pre">pygments</span></code>), you can create and register custom styles.</p>
<p>To do so, add something similar to your <code class="docutils literal notranslate"><span class="pre">.xonshrc</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xonsh.tools</span> <span class="kn">import</span> <span class="n">register_custom_style</span>
<span class="n">mystyle</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"Literal.String.Single"</span><span class="p">:</span> <span class="s2">"#ff88aa"</span><span class="p">,</span>
<span class="s2">"Literal.String.Double"</span><span class="p">:</span> <span class="s2">"#ff4488"</span><span class="p">,</span>
<span class="s2">"RED"</span><span class="p">:</span> <span class="s2">"#008800"</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">register_custom_style</span><span class="p">(</span><span class="s2">"mystyle"</span><span class="p">,</span> <span class="n">mystyle</span><span class="p">,</span> <span class="n">base</span><span class="o">=</span><span class="s2">"monokai"</span><span class="p">)</span>
<span class="err">$</span><span class="n">XONSH_COLOR_STYLE</span><span class="o">=</span><span class="s2">"mystyle"</span>
</pre></div>
</div>
<p>You can check <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">colors</span></code> for the token names. The <code class="docutils literal notranslate"><span class="pre">base</span></code> style will be used as a fallback for styles you don’t set - pick one from <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">styles</span></code> (<code class="docutils literal notranslate"><span class="pre">default</span></code> is used if omitted).</p>
</section>
</section>
<section id="import-python-modules-from-a-local-directory">
<span id="import-local-modules"></span><h3>…import python modules from a local directory?<a class="headerlink" href="#import-python-modules-from-a-local-directory" title="Link to this heading">¶</a></h3>
<p>The modules available for import in a given <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> session depend on what’s
available in <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>. If you want to be able to import a module that
resides in the current directory, ensure that there is an empty string as the
first element of your <code class="docutils literal notranslate"><span class="pre">sys.path</span></code></p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ import sys</span>
<span class="go">@ sys.path.insert(0, '')</span>
</pre></div>
</div>
</section>
<section id="set-xonsh-as-my-default-shell">
<span id="default-shell"></span><h3>…set <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> as my default shell?<a class="headerlink" href="#set-xonsh-as-my-default-shell" title="Link to this heading">¶</a></h3>
<p>If you want to use xonsh as your default shell, you will first have
to add xonsh to <code class="docutils literal notranslate"><span class="pre">/etc/shells</span></code>.</p>
<p>First ensure that xonsh is on your <code class="docutils literal notranslate"><span class="pre">$PATH</span></code></p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>which<span class="w"> </span>xonsh
</pre></div>
</div>
<p>Then, as root, add xonsh to the shell list</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>which<span class="w"> </span>xonsh<span class="w"> </span>>><span class="w"> </span>/etc/shells
</pre></div>
</div>
<p>To change shells, run</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>chsh<span class="w"> </span>-s<span class="w"> </span><span class="k">$(</span>which<span class="w"> </span>xonsh<span class="k">)</span>
</pre></div>
</div>
<p>You will have to log out and log back in before the changes take effect.</p>
</section>
<section id="select-a-tab-completion-result-without-executing-the-current-line">
<span id="select-completion-result"></span><h3>…select a tab completion result without executing the current line?<a class="headerlink" href="#select-a-tab-completion-result-without-executing-the-current-line" title="Link to this heading">¶</a></h3>
<p>In the <code class="docutils literal notranslate"><span class="pre">prompt_toolkit</span></code> shell, you can cycle through possible tab-completion
results using the TAB key and use ENTER to select the completion you want. By
default, ENTER will also execute the current line. If you would prefer to not
automatically execute the line (say, if you’re constructing a long pathname),
you can set</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="nv">$COMPLETIONS_CONFIRM</span><span class="o">=</span><span class="kc">True</span>
</pre></div>
</div>
<p>in your <code class="docutils literal notranslate"><span class="pre">xonshrc</span></code></p>
</section>
<section id="add-a-default-argument-to-a-builtin-xonsh-alias">
<span id="add-args-builtin-alias"></span><h3>…add a default argument to a builtin <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> alias?<a class="headerlink" href="#add-a-default-argument-to-a-builtin-xonsh-alias" title="Link to this heading">¶</a></h3>
<p>If you want to add a default argument to a builtin alias like <code class="docutils literal notranslate"><span class="pre">dirs</span></code> the
standard alias definition method will fail. In order to handle this case you can
use the following solution in your <code class="docutils literal notranslate"><span class="pre">xonshrc</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xonsh.dirstack</span> <span class="kn">import</span> <span class="n">dirs</span>
<span class="k">def</span> <span class="nf">_verbose_dirs</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">stdin</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="n">dirs</span><span class="p">([</span><span class="s1">'-v'</span><span class="p">]</span> <span class="o">+</span> <span class="n">args</span><span class="p">,</span> <span class="n">stdin</span><span class="o">=</span><span class="n">stdin</span><span class="p">)</span>
<span class="n">aliases</span><span class="p">[</span><span class="s1">'dirs'</span><span class="p">]</span> <span class="o">=</span> <span class="n">_verbose_dirs</span>
</pre></div>
</div>
</section>
<section id="make-terminal-tabs-start-in-the-correct-directory">
<span id="terminal-tabs"></span><h3>…make terminal tabs start in the correct directory?<a class="headerlink" href="#make-terminal-tabs-start-in-the-correct-directory" title="Link to this heading">¶</a></h3>
<p>If you use Gnome Terminal or another VTE terminal and it doesn’t start new tabs
in the CWD of the original TAB, this is because of a custom VTE interface. To
fix this, please add <code class="docutils literal notranslate"><span class="pre">{vte_new_tab_cwd}</span></code> somewhere to you prompt:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$PROMPT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{vte_new_tab_cwd}</span><span class="s1">'</span> <span class="o">+</span> <span class="nv">$PROMPT</span>
</pre></div>
</div>
<p>This will issue the proper escape sequence to the terminal without otherwise
affecting the displayed prompt.</p>
</section>
<section id="set-up-the-open-terminal-here-action-in-thunar">
<span id="open-terminal-here"></span><h3>…set up the “Open Terminal Here” action in Thunar?<a class="headerlink" href="#set-up-the-open-terminal-here-action-in-thunar" title="Link to this heading">¶</a></h3>
<p>If you use Thunar and “Open Terminal Here” action does not work,
you can try to replace a command for this action by the following:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>exo-open<span class="w"> </span>--working-directory<span class="w"> </span>%f<span class="w"> </span>--launch<span class="w"> </span>TerminalEmulator<span class="w"> </span>xonsh<span class="w"> </span>--shell-type<span class="o">=</span>best
</pre></div>
</div>
<p>In order to do this, go to <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Configure</span> <span class="pre">custom</span> <span class="pre">actions...</span></code>,
then choose <code class="docutils literal notranslate"><span class="pre">Open</span> <span class="pre">Terminal</span> <span class="pre">Here</span></code> and click on <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">currently</span> <span class="pre">selected</span> <span class="pre">action</span></code> button.</p>
</section>
<section id="use-utf-8-characters-in-xonsh">
<span id="unicode-troubles"></span><h3>…use utf-8 characters in xonsh?<a class="headerlink" href="#use-utf-8-characters-in-xonsh" title="Link to this heading">¶</a></h3>
<p>If you are unable to use utf-8 (ie. non-ascii) characters in xonsh. For example if you get the following output</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@ echo "ßðđ"</span>
<span class="go">xonsh: For full traceback set: $XONSH_SHOW_TRACEBACK = True</span>
<span class="go">UnicodeEncodeError: 'ascii' codec can't encode characters in position 0-2: ordinal not in range(128)</span>
</pre></div>
</div>
<p>The problem might be:</p>
<ul class="simple">
<li><p>Your locale is not set to utf-8, to check this you can set the content of the
environment variable <code class="docutils literal notranslate"><span class="pre">LC_TYPE</span></code></p></li>
<li><p>Your locale is correctly set but <strong>after</strong> xonsh started. This is typically
the case if you set your <code class="docutils literal notranslate"><span class="pre">LC_TYPE</span></code> inside your <code class="docutils literal notranslate"><span class="pre">.xonshrc</span></code> and xonsh is
your default/login shell. To fix this you should see the documentation of your
operating system to know how to correctly setup environment variables before
the shell start (<code class="docutils literal notranslate"><span class="pre">~/.pam_environment</span></code> for example)</p></li>
</ul>
</section>
<section id="fix-a-libgcc-s-so-1-error">
<span id="fix-libgcc-core-dump"></span><h3>…fix a <code class="docutils literal notranslate"><span class="pre">libgcc_s.so.1</span></code> error?<a class="headerlink" href="#fix-a-libgcc-s-so-1-error" title="Link to this heading">¶</a></h3>
<p>On certain flavors of Linux you may periodically encounter this error message
when starting <code class="docutils literal notranslate"><span class="pre">xonsh</span></code>:</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="n">libgcc_s</span><span class="o">.</span><span class="n">so</span><span class="mf">.1</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="k">for</span> <span class="n">pthread_cancel</span> <span class="n">to</span> <span class="n">work</span>
<span class="go">Aborted (core dumped)</span>
</pre></div>
</div>
<p>This is due to an upstream Python problem and can be fixed by setting
<code class="docutils literal notranslate"><span class="pre">LD_PRELOAD</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>env<span class="w"> </span><span class="nv">LD_PRELOAD</span><span class="o">=</span>libgcc_s.so.1<span class="w"> </span>xonsh
</pre></div>
</div>
</section>
<section id="color-my-man-pages">
<h3>…color my man pages?<a class="headerlink" href="#color-my-man-pages" title="Link to this heading">¶</a></h3>
<p>You can add add <a class="reference external" href="https://wiki.archlinux.org/index.php/Color_output_in_console#less">man page color support</a> using <code class="docutils literal notranslate"><span class="pre">less</span></code> environment
variables:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Coloured man page support</span>
<span class="c1"># using 'less' env vars (format is '\E[<brightness>;<colour>m')</span>
<span class="nv">$LESS_TERMCAP_mb</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[01;31m"</span> <span class="c1"># begin blinking</span>
<span class="nv">$LESS_TERMCAP_md</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[01;31m"</span> <span class="c1"># begin bold</span>
<span class="nv">$LESS_TERMCAP_me</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[0m"</span> <span class="c1"># end mode</span>
<span class="nv">$LESS_TERMCAP_so</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[01;44;36m"</span> <span class="c1"># begin standout-mode (bottom of screen)</span>
<span class="nv">$LESS_TERMCAP_se</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[0m"</span> <span class="c1"># end standout-mode</span>
<span class="nv">$LESS_TERMCAP_us</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[00;36m"</span> <span class="c1"># begin underline</span>
<span class="nv">$LESS_TERMCAP_ue</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\033</span><span class="s2">[0m"</span> <span class="c1"># end underline</span>
</pre></div>
</div>
</section>
<section id="use-xonsh-inside-emacs">
<span id="xonsh-inside-emacs"></span><h3>…use xonsh inside Emacs?<a class="headerlink" href="#use-xonsh-inside-emacs" title="Link to this heading">¶</a></h3>
<p>see <a class="reference external" href="editors.html">emacs</a>.</p>
</section>
</section>
<section id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Link to this heading">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="https://github.com/xonsh/xonsh/discussions">Q&A in the xonsh repository</a></p></li>
</ul>
</div></blockquote>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="envvars.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Environment Variables</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="xonshrc.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Run Control File</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2015, Anthony Scopatz
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Updating and customizing xonsh</a><ul>
<li><a class="reference internal" href="#updating-xonsh">Updating xonsh</a></li>
<li><a class="reference internal" href="#customizing-xonsh-how-do-i">Customizing xonsh - How do I…</a><ul>
<li><a class="reference internal" href="#change-the-current-color-theme">…change the current color theme?</a><ul>
<li><a class="reference internal" href="#registering-custom-styles">Registering custom styles</a></li>
</ul>
</li>
<li><a class="reference internal" href="#import-python-modules-from-a-local-directory">…import python modules from a local directory?</a></li>
<li><a class="reference internal" href="#set-xonsh-as-my-default-shell">…set <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> as my default shell?</a></li>
<li><a class="reference internal" href="#select-a-tab-completion-result-without-executing-the-current-line">…select a tab completion result without executing the current line?</a></li>
<li><a class="reference internal" href="#add-a-default-argument-to-a-builtin-xonsh-alias">…add a default argument to a builtin <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> alias?</a></li>
<li><a class="reference internal" href="#make-terminal-tabs-start-in-the-correct-directory">…make terminal tabs start in the correct directory?</a></li>
<li><a class="reference internal" href="#set-up-the-open-terminal-here-action-in-thunar">…set up the “Open Terminal Here” action in Thunar?</a></li>
<li><a class="reference internal" href="#use-utf-8-characters-in-xonsh">…use utf-8 characters in xonsh?</a></li>
<li><a class="reference internal" href="#fix-a-libgcc-s-so-1-error">…fix a <code class="docutils literal notranslate"><span class="pre">libgcc_s.so.1</span></code> error?</a></li>
<li><a class="reference internal" href="#color-my-man-pages">…color my man pages?</a></li>
<li><a class="reference internal" href="#use-xonsh-inside-emacs">…use xonsh inside Emacs?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#see-also">See also</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=ecbec2ee"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
<script src="_static/runthis-client.min.js?v=ad2a40d9"></script>
</body>
</html>