/
index.html
8634 lines (7678 loc) · 612 KB
/
index.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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-03-14 Thu 18:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Beckwith Tangled Emacs Initialization</title>
<meta name="author" content="Benjamin Beckwith" />
<meta name="generator" content="Org Mode" />
<style>
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { }
</style>
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
<link rel="stylesheet" type="text/css" href="style.css"/>
<script>
// @license magnet:?xt=urn:btih:1f739d935676111cfff4b4693e3816e664797050&dn=gpl-3.0.txt GPL-v3-or-Later
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.add("code-highlighted");
target.classList.add("code-highlighted");
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.remove("code-highlighted");
target.classList.remove("code-highlighted");
}
}
// @license-end
</script>
<script>
window.MathJax = {
tex: {
ams: {
multlineWidth: '85%'
},
tags: 'ams',
tagSide: 'right',
tagIndent: '.8em'
},
chtml: {
scale: 1.0,
displayAlign: 'center',
displayIndent: '0em'
},
svg: {
scale: 1.0,
displayAlign: 'center',
displayIndent: '0em'
},
output: {
font: 'mathjax-modern',
displayOverflow: 'overflow'
}
};
</script>
<script
id="MathJax-script"
async
src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
</script>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Beckwith Tangled Emacs Initialization</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgddc0cae">1. Introduction</a>
<ul>
<li><a href="#orgaa14b67">1.1. Installation</a></li>
<li><a href="#org76c8234">1.2. Notes</a>
<ul>
<li><a href="#orgd2923ff">1.2.1. Elpaca</a></li>
<li><a href="#orgad6fd5c">1.2.2. Emacs Build</a></li>
<li><a href="#orgedf50cd">1.2.3. Pending sections</a></li>
<li><a href="#orge5274c1">1.2.4. Performance</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgecfcb95">2. Preamble</a>
<ul>
<li><a href="#org29b4aa7">2.1. Personal Information</a></li>
<li><a href="#orge1fb2a8">2.2. Local customizations (custom.el, username.var.el)</a>
<ul>
<li><a href="#orgbfb20e0">2.2.1. Local variables (user-login-name)</a></li>
</ul>
</li>
<li><a href="#org70b264d">2.3. Early Initialization</a>
<ul>
<li><a href="#org9f58691">2.3.1. Init debug assistance</a></li>
</ul>
</li>
<li><a href="#org363a4b3">2.4. Libraries</a>
<ul>
<li><a href="#orgd3be548">2.4.1. Dash</a></li>
<li><a href="#orgc91d91b">2.4.2. Delight</a></li>
<li><a href="#org2ac9004">2.4.3. Hydra</a></li>
<li><a href="#org4cc5b91">2.4.4. Seq</a></li>
</ul>
</li>
<li><a href="#orgba47b51">2.5. Coda</a></li>
</ul>
</li>
<li><a href="#org0f5741d">3. Settings</a>
<ul>
<li><a href="#org213addd">3.1. Keys</a>
<ul>
<li><a href="#orgdc16730">3.1.1. Binding Keys</a></li>
<li><a href="#org5d8956e">3.1.2. Personal Keymaps</a></li>
<li><a href="#org1500ba9">3.1.3. Super keys</a></li>
</ul>
</li>
<li><a href="#org66a5cd8">3.2. Command Launchers</a>
<ul>
<li><a href="#org8e76b6e">3.2.1. Hydra</a></li>
<li><a href="#org0a9c465">3.2.2. Vertico</a></li>
</ul>
</li>
<li><a href="#org67426b8">3.3. Expansion & Completion</a>
<ul>
<li><a href="#org3c2fc39">3.3.1. Abbrev</a></li>
<li><a href="#org2568fec">3.3.2. Cape</a></li>
<li><a href="#org6bd7122">3.3.3. Corfu</a></li>
<li><a href="#org01d6828">3.3.4. Yasnippet   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
<li><a href="#org0e2210b">3.3.5. Hippie Expand</a></li>
</ul>
</li>
<li><a href="#orgb9dcffc">3.4. Built-in Features</a>
<ul>
<li><a href="#orgecb1b14">3.4.1. Backups</a></li>
<li><a href="#orgcf5c6d7">3.4.2. Default File encoding</a></li>
<li><a href="#org6dcf967">3.4.3. Native Compilation</a></li>
<li><a href="#org5e7b390">3.4.4. Path</a></li>
<li><a href="#orgde285f1">3.4.5. Server</a></li>
<li><a href="#org8652d5f">3.4.6. Sounds</a></li>
<li><a href="#org4a34f6f">3.4.7. Recentf</a></li>
<li><a href="#org345bd99">3.4.8. Timezones</a></li>
<li><a href="#orgdf49d8d">3.4.9. Isearch</a></li>
</ul>
</li>
<li><a href="#org19ffedb">3.5. Minibuffer</a>
<ul>
<li><a href="#org272350f">3.5.1. Minibuffer History</a></li>
</ul>
</li>
<li><a href="#org650941f">3.6. Movement</a>
<ul>
<li><a href="#orgbe5061e">3.6.1. Ace Utilities</a></li>
<li><a href="#orgc90d8e4">3.6.2. Errors</a></li>
<li><a href="#org6e79da1">3.6.3. Read-only helpers</a></li>
<li><a href="#org3e52ec2">3.6.4. Scroll Screen Position</a></li>
</ul>
</li>
<li><a href="#orga3adb6e">3.7. Custom Helpers</a>
<ul>
<li><a href="#org12edc16">3.7.1. Auto-display agenda</a></li>
<li><a href="#org4721718">3.7.2. Auto-indent when pasting</a></li>
<li><a href="#org4adae4c">3.7.3. Better window splitting functions</a></li>
<li><a href="#org0212e4b">3.7.4. Hide mode line</a></li>
<li><a href="#orgc5dad35">3.7.5. Open/Edit This file</a></li>
<li><a href="#org90c6e38">3.7.6. Org-column resizing</a></li>
<li><a href="#org1aa9b2c">3.7.7. Prettify macro</a></li>
<li><a href="#org8d535d6">3.7.8. Styled HTML Export</a></li>
<li><a href="#org1883d51">3.7.9. Transparency</a></li>
<li><a href="#org7fc2031">3.7.10. Weekly Score Goal in Org-Agenda</a></li>
<li><a href="#orgd848dfb">3.7.11. Weekly Time Reporting</a></li>
<li><a href="#orgbb2dd79">3.7.12. Workweeks</a></li>
</ul>
</li>
<li><a href="#org2db5c99">3.8. Editing</a>
<ul>
<li><a href="#org257f7b2">3.8.1. Ediff single frame</a></li>
<li><a href="#orgdf107c6">3.8.2. Multiple Cursors</a></li>
<li><a href="#orge815d5f">3.8.3. Regexp-Builder</a></li>
<li><a href="#org7c73e30">3.8.4. Executable Scripts on save</a></li>
<li><a href="#org53afd28">3.8.5. Auto Reverting</a></li>
</ul>
</li>
<li><a href="#org8ad68f2">3.9. Images</a>
<ul>
<li><a href="#orgc6909f3">3.9.1. ImageMagick</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org08a67de">4. Minor Modes</a>
<ul>
<li><a href="#org632ea63">4.1. Reference</a>
<ul>
<li><a href="#org1b88afa">4.1.1. Helpful</a></li>
<li><a href="#org21a7bfd">4.1.2. Which Key</a></li>
<li><a href="#orgd05a43b">4.1.3. Dictionary</a></li>
<li><a href="#org231bab0">4.1.4. OSX Dictionary</a></li>
</ul>
</li>
<li><a href="#org6712896">4.2. Editing</a>
<ul>
<li><a href="#org4fb2bfa">4.2.1. Adaptive Fill   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
<li><a href="#orgc499805">4.2.2. Focus Mode</a></li>
<li><a href="#org15d01e7">4.2.3. Common User Access mode</a></li>
<li><a href="#org975fd4f">4.2.4. Easy Kill</a></li>
<li><a href="#org9645da1">4.2.5. Vundo   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
<li><a href="#orgac5ea93">4.2.6. Expand Region</a></li>
<li><a href="#orgd6a029c">4.2.7. Citar (Bibtex completions)</a></li>
<li><a href="#org1eac855">4.2.8. Tree Sitter</a></li>
</ul>
</li>
<li><a href="#org33eec7d">4.3. Version Control</a>
<ul>
<li><a href="#org0453aa3">4.3.1. Magit</a></li>
<li><a href="#orga39d164">4.3.2. Smerge</a></li>
</ul>
</li>
<li><a href="#orgf9b9f9a">4.4. Checking</a>
<ul>
<li><a href="#org6ff6743">4.4.1. Writegood Mode</a></li>
<li><a href="#org704fa21">4.4.2. Spell Checking</a></li>
<li><a href="#org2130fb7">4.4.3. Proselint</a></li>
</ul>
</li>
<li><a href="#org0f12fd3">4.5. Buffers</a>
<ul>
<li><a href="#orgb384b8e">4.5.1. Midnight Mode</a></li>
<li><a href="#org22486f1">4.5.2. IBuffer</a></li>
<li><a href="#org12b0f8f">4.5.3. Unique Buffer Names</a></li>
<li><a href="#org6b32534">4.5.4. OSX Reveal</a></li>
</ul>
</li>
<li><a href="#org3010ce5">4.6. Development</a>
<ul>
<li><a href="#org63ded0a">4.6.1. Check parens on save</a></li>
<li><a href="#orgf04b047">4.6.2. Eldoc</a></li>
<li><a href="#org47dde5a">4.6.3. Eglot</a></li>
<li><a href="#org86acdc2">4.6.4. Paredit</a></li>
<li><a href="#org17c36f0">4.6.5. Paxedit</a></li>
<li><a href="#org9c4f3a2">4.6.6. Rainbow Delimiters</a></li>
</ul>
</li>
<li><a href="#orgac794ae">4.7. Organization</a>
<ul>
<li><a href="#org1056992">4.7.1. Bookmarks</a></li>
<li><a href="#org5be2be9">4.7.2. Project</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgeb6d244">5. Major Modes</a>
<ul>
<li><a href="#orgff3a394">5.1. File Management</a>
<ul>
<li><a href="#orgaa15282">5.1.1. Dired</a></li>
<li><a href="#org6ede391">5.1.2. Neotree</a></li>
</ul>
</li>
<li><a href="#orgc510411">5.2. Documents</a>
<ul>
<li><a href="#orgb3d0385">5.2.1. AucTeX</a></li>
<li><a href="#orged4cdc3">5.2.2. HTML</a></li>
<li><a href="#orgde8064b">5.2.3. Markdown</a></li>
<li><a href="#org1450004">5.2.4. Orgmode</a></li>
<li><a href="#orgb7ebdcd">5.2.5. PDF Tools</a></li>
</ul>
</li>
<li><a href="#orgf896647">5.3. Miscellaneous</a>
<ul>
<li><a href="#org3ea625e">5.3.1. Calc</a></li>
<li><a href="#org51e30fe">5.3.2. Dashboard</a></li>
<li><a href="#orgc18263b">5.3.3. Hyperbole   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
</ul>
</li>
<li><a href="#org491f95d">5.4. Programming Languages</a>
<ul>
<li><a href="#org4eb006b">5.4.1. C++</a></li>
<li><a href="#org22544b7">5.4.2. Elisp</a></li>
<li><a href="#org4f003f8">5.4.3. Javascript</a></li>
<li><a href="#orgdb857d3">5.4.4. Plantuml</a></li>
<li><a href="#org9d441c7">5.4.5. Python</a></li>
<li><a href="#org3206076">5.4.6. Rust</a></li>
<li><a href="#org85a5fd4">5.4.7. Emacs Speaks Statistics (ESS)</a></li>
<li><a href="#org6e2a81c">5.4.8. Utilities</a></li>
<li><a href="#org545dcb6">5.4.9. Web Mode</a></li>
</ul>
</li>
<li><a href="#org12dded7">5.5. Shells</a>
<ul>
<li><a href="#org7c8f7bc">5.5.1. Ansi Term</a></li>
<li><a href="#orgf5cd999">5.5.2. Eshell</a></li>
</ul>
</li>
<li><a href="#org3abf303">5.6. Visual</a>
<ul>
<li><a href="#orgc494ea1">5.6.1. Nerd Icons</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgc202414">6. Style</a>
<ul>
<li><a href="#org6095131">6.1. Frame Changes</a></li>
<li><a href="#org9a4f4e2">6.2. Window Changes</a></li>
<li><a href="#org2e636ad">6.3. Faces</a>
<ul>
<li><a href="#orga425181">6.3.1. Default Fonts</a></li>
<li><a href="#org2240ff8">6.3.2. Unicode   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
<li><a href="#org9ff281b">6.3.3. Trying out fonts on Windows</a></li>
<li><a href="#org21fd156">6.3.4. Dynamic Font sizes</a></li>
<li><a href="#orgaacb8f8">6.3.5. Mode Line Style</a></li>
<li><a href="#org16108b3">6.3.6. Missing Glyphs</a></li>
<li><a href="#orgf1350fb">6.3.7. Cursor width</a></li>
</ul>
</li>
<li><a href="#org1d3b275">6.4. Themes</a>
<ul>
<li><a href="#org1312022">6.4.1. Extra Themes</a></li>
</ul>
</li>
<li><a href="#orgd3316c7">6.5. Sky Color Clock</a></li>
<li><a href="#org000e4d6">6.6. Doom Modeline</a></li>
<li><a href="#org0b303ca">6.7. Asterism (⁂) Mode   <span class="tag"><span class="PENDING">PENDING</span></span></a></li>
<li><a href="#org6773e82">6.8. Prettify Symbols</a></li>
<li><a href="#orgd643bb2">6.9. Color</a>
<ul>
<li><a href="#org90003a3">6.9.1. Rainbow Mode</a></li>
<li><a href="#org1392dfd">6.9.2. KureColor</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org91d8765">7. Postamble</a>
<ul>
<li><a href="#org70a7692">7.1. Local customizations (custom.el)</a></li>
<li><a href="#orgdbc1711">7.2. Local customizations (user-login-name)</a></li>
<li><a href="#org9cdeb60">7.3. Housekeeping</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgddc0cae" class="outline-2">
<h2 id="orgddc0cae"><span class="section-number-2">1.</span> Introduction</h2>
<div class="outline-text-2" id="text-1">
<p>
This document tangles (in literate programming style) the necessary
commands to initialize Emacs to my liking and the documentation for my
choices.
</p>
<p>
To clone, go to the <a href="http://github.com/bnbeckwith/bnb-emacs">github repository</a>. For a pretty view, head over to
the <a href="http://bnbeckwith.com/bnb-emacs/">generated page</a>.
</p>
</div>
<div id="outline-container-orgaa14b67" class="outline-3">
<h3 id="orgaa14b67"><span class="section-number-3">1.1.</span> Installation</h3>
<div class="outline-text-3" id="text-1-1">
<p>
My <code>init.el</code> file is quite simple and is generated by the following
block. Essentially, I just have to install this package
(<code>bnb-emacs</code>) in the <a href="file:///Users/ben.beckwith/.emacs.d/">~/.emacs.d/</a> directory and run the following
code block (<code>C-c C-c</code>) to bootstrap the system.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #8e908c; font-style: italic;">;;; </span><span style="color: #8e908c; font-style: italic;">init.el --- bnbeckwith config -*- eval: (read-only-mode 1) -*-</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">START ELPACA INSTALLER</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">elpaca-installer-version</span> 0.7<span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">elpaca-directory</span> <span style="color: #3e999f;">(</span>expand-file-name <span style="color: #3e999f;">"elpaca/"</span> user-emacs-directory<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">elpaca-builds-directory</span> <span style="color: #3e999f;">(</span>expand-file-name <span style="color: #3e999f;">"builds/"</span> elpaca-directory<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">elpaca-repos-directory</span> <span style="color: #3e999f;">(</span>expand-file-name <span style="color: #3e999f;">"repos/"</span> elpaca-directory<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">elpaca-order</span> '<span style="color: #3e999f;">(</span>elpaca <span style="color: #8959a8;">:repo</span> <span style="color: #3e999f;">"https://github.com/progfolio/elpaca.git"</span>
<span style="color: #8959a8;">:ref</span> nil <span style="color: #8959a8;">:depth</span> 1
<span style="color: #8959a8;">:files</span> <span style="color: #eab700;">(</span><span style="color: #8959a8;">:defaults</span> <span style="color: #3e999f;">"elpaca-test.el"</span> <span style="color: #718c00;">(</span><span style="color: #8959a8;">:exclude</span> <span style="color: #3e999f;">"extensions"</span><span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #8959a8;">:build</span> <span style="color: #eab700;">(</span><span style="color: #8959a8;">:not</span> elpaca--activate-package<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">let*</span> <span style="color: #3e999f;">(</span><span style="color: #eab700;">(</span>repo <span style="color: #718c00;">(</span>expand-file-name <span style="color: #3e999f;">"elpaca/"</span> elpaca-repos-directory<span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>build <span style="color: #718c00;">(</span>expand-file-name <span style="color: #3e999f;">"elpaca/"</span> elpaca-builds-directory<span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>order <span style="color: #718c00;">(</span>cdr elpaca-order<span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>default-directory repo<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span>add-to-list 'load-path <span style="color: #eab700;">(</span><span style="color: #718c00;">if</span> <span style="color: #718c00;">(</span>file-exists-p build<span style="color: #718c00;">)</span> build repo<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span><span style="color: #718c00;">unless</span> <span style="color: #eab700;">(</span>file-exists-p repo<span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>make-directory repo t<span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span><span style="color: #718c00;">when</span> <span style="color: #718c00;">(</span>< emacs-major-version 28<span style="color: #718c00;">)</span> <span style="color: #718c00;">(</span><span style="color: #718c00;">require</span> '<span style="color: #4271ae;">subr-x</span><span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span><span style="color: #718c00;">condition-case-unless-debug</span> err
<span style="color: #718c00;">(</span><span style="color: #718c00;">if-let</span> <span style="color: #4271ae;">(</span><span style="color: #4d4d4c;">(</span>buffer <span style="color: #3e999f;">(</span>pop-to-buffer-same-window <span style="color: #3e999f;">"*elpaca-bootstrap*"</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #3e999f;">(</span>zerop <span style="color: #eab700;">(</span>apply #'call-process `<span style="color: #718c00;">(</span><span style="color: #3e999f;">"git"</span> nil ,buffer t <span style="color: #3e999f;">"clone"</span>
,@<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">when-let</span> <span style="color: #3e999f;">(</span><span style="color: #eab700;">(</span>depth <span style="color: #718c00;">(</span>plist-get order <span style="color: #8959a8;">:depth</span><span style="color: #718c00;">)</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span>list <span style="color: #eab700;">(</span>format <span style="color: #3e999f;">"--depth=%d"</span> depth<span style="color: #eab700;">)</span> <span style="color: #3e999f;">"--no-single-branch"</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
,<span style="color: #4d4d4c;">(</span>plist-get order <span style="color: #8959a8;">:repo</span><span style="color: #4d4d4c;">)</span> ,repo<span style="color: #718c00;">)</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #3e999f;">(</span>zerop <span style="color: #eab700;">(</span>call-process <span style="color: #3e999f;">"git"</span> nil buffer t <span style="color: #3e999f;">"checkout"</span>
<span style="color: #718c00;">(</span><span style="color: #718c00;">or</span> <span style="color: #4d4d4c;">(</span>plist-get order <span style="color: #8959a8;">:ref</span><span style="color: #4d4d4c;">)</span> <span style="color: #3e999f;">"--"</span><span style="color: #718c00;">)</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span>emacs <span style="color: #3e999f;">(</span>concat invocation-directory invocation-name<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #3e999f;">(</span>zerop <span style="color: #eab700;">(</span>call-process emacs nil buffer nil <span style="color: #3e999f;">"-Q"</span> <span style="color: #3e999f;">"-L"</span> <span style="color: #3e999f;">"."</span> <span style="color: #3e999f;">"--batch"</span>
<span style="color: #3e999f;">"--eval"</span> <span style="color: #3e999f;">"(byte-recompile-directory \".\" 0 'force)"</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #3e999f;">(</span><span style="color: #718c00;">require</span> '<span style="color: #4271ae;">elpaca</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #3e999f;">(</span>elpaca-generate-autoloads <span style="color: #3e999f;">"elpaca"</span> repo<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span><span style="color: #4271ae;">)</span>
<span style="color: #4271ae;">(</span><span style="color: #718c00;">progn</span> <span style="color: #4d4d4c;">(</span>message <span style="color: #3e999f;">"%s"</span> <span style="color: #3e999f;">(</span>buffer-string<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span> <span style="color: #4d4d4c;">(</span>kill-buffer buffer<span style="color: #4d4d4c;">)</span><span style="color: #4271ae;">)</span>
<span style="color: #4271ae;">(</span><span style="color: #c82829; font-weight: bold;">error</span> <span style="color: #3e999f;">"%s"</span> <span style="color: #4d4d4c;">(</span><span style="color: #718c00;">with-current-buffer</span> buffer <span style="color: #3e999f;">(</span>buffer-string<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span><span style="color: #4271ae;">)</span><span style="color: #718c00;">)</span>
<span style="color: #718c00;">(</span><span style="color: #4271ae;">(</span><span style="color: #c82829; font-weight: bold;">error</span><span style="color: #4271ae;">)</span> <span style="color: #4271ae;">(</span><span style="color: #c82829; font-weight: bold;">warn</span> <span style="color: #3e999f;">"%s"</span> err<span style="color: #4271ae;">)</span> <span style="color: #4271ae;">(</span>delete-directory repo 'recursive<span style="color: #4271ae;">)</span><span style="color: #718c00;">)</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span><span style="color: #718c00;">unless</span> <span style="color: #eab700;">(</span><span style="color: #718c00;">require</span> '<span style="color: #4271ae;">elpaca-autoloads</span> nil t<span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span><span style="color: #718c00;">require</span> '<span style="color: #4271ae;">elpaca</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>elpaca-generate-autoloads <span style="color: #3e999f;">"elpaca"</span> repo<span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>load <span style="color: #3e999f;">"./elpaca-autoloads"</span><span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span>add-hook 'after-init-hook #'elpaca-process-queues<span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">elpaca</span> `<span style="color: #3e999f;">(</span>,@elpaca-order<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">END ELPACA INSTALLER</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">Install use-package support</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">elpaca</span> elpaca-use-package
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">Enable :elpaca use-package keyword.</span>
<span style="color: #3e999f;">(</span>elpaca-use-package-mode<span style="color: #3e999f;">)</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">Assume :elpaca t unless otherwise specified.</span>
<span style="color: #3e999f;">(</span><span style="color: #718c00;">setq</span> elpaca-use-package-by-default t<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span>elpaca-wait<span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span>load <span style="color: #3e999f;">"~/.emacs.d/full.el"</span><span style="color: #4d4d4c;">)</span>
</pre>
</div>
<p>
From there on, the bootstrapping is simple. Emacs finds
<a href="file:///Users/ben.beckwith/.emacs.d/init.el">~/.emacs.d/init.el</a> and runs the code.
</p>
<p>
First, I disable <code>package</code>, and use the standard <code>elpaca</code>
initialization. Following that, I enable <code>elpaca-use-package</code> so that
the rest of this setup can use the standard <span class="tooltip"><code>use-package</code><span class="tooltiptext">Declare an Emacs package by specifying a group of configuration options.<br><br>For the full documentation, see Info node ‘(use-package) top’.<br>Usage:<br><br> (use-package package-name<br> [:keyword [option]]...)<br><br>:init Code to run before PACKAGE-NAME has been loaded.<br>:config Code to run after PACKAGE-NAME has been loaded. Note that<br> if loading is deferred for any reason, this code does not<br> execute until the lazy load has occurred.<br>:preface Code to be run before everything except ‘:disabled’; this<br> can be used to define functions for use in ‘:if’, or that<br> should be seen by the byte-compiler.<br><br>:mode Form to be added to ‘auto-mode-alist’.<br>:magic Form to be added to ‘magic-mode-alist’.<br>:magic-fallback Form to be added to ‘magic-fallback-mode-alist’.<br>:interpreter Form to be added to ‘interpreter-mode-alist’.<br><br>:commands Define autoloads for commands that will be defined by the<br> package. This is useful if the package is being lazily<br> loaded, and you wish to conditionally call functions in your<br> ‘:init’ block that are defined in the package.<br>:autoload Similar to :commands, but it for no-interactive one.<br>:hook Specify hook(s) to attach this package to.<br><br>:bind Bind keys, and define autoloads for the bound commands.<br>:bind* Bind keys, and define autoloads for the bound commands,<br> *overriding all minor mode bindings*.<br>:bind-keymap Bind a key prefix to an auto-loaded keymap defined in the<br> package. This is like ‘:bind’, but for keymaps.<br>:bind-keymap* Like ‘:bind-keymap’, but overrides all minor mode bindings<br><br>:defer Defer loading of a package -- this is implied when using<br> ‘:commands’, ‘:bind’, ‘:bind*’, ‘:mode’, ‘:magic’, ‘:hook’,<br> ‘:magic-fallback’, or ‘:interpreter’. This can be an integer,<br> to force loading after N seconds of idle time, if the package<br> has not already been loaded.<br>:demand Prevent the automatic deferred loading introduced by constructs<br> such as ‘:bind’ (see ‘:defer’ for the complete list).<br><br>:after Delay the effect of the use-package declaration<br> until after the named libraries have loaded.<br> Before they have been loaded, no other keyword<br> has any effect at all, and once they have been<br> loaded it is as if ‘:after’ was not specified.<br><br>:if EXPR Initialize and load only if EXPR evaluates to a non-nil value.<br>:disabled The package is ignored completely if this keyword is present.<br>:defines Declare certain variables to silence the byte-compiler.<br>:functions Declare certain functions to silence the byte-compiler.<br>:load-path Add to the ‘load-path’ before attempting to load the package.<br>:diminish Support for diminish.el (if installed).<br>:delight Support for delight.el (if installed).<br>:custom Call ‘Custom-set’ or ‘set-default’ with each variable<br> definition without modifying the Emacs ‘custom-file’.<br> (compare with ‘custom-set-variables’).<br>:custom-face Call ‘custom-set-faces’ with each face definition.<br>:ensure Loads the package using package.el if necessary.<br>:pin Pin the package to an archive.<br><br>(fn NAME &rest ARGS)</span></span> interface.
</p>
<p>
Finally, the output of this file, <a href="file:///Users/ben.beckwith/.emacs.d/full.el">~/.emacs.d/full.el</a>, is loaded for
the complete initialization.
</p>
<p>
If you are reading this online, the html version of this file is
generated by using `bnb/export-readme` explained in <a href="#org8d535d6">Styled HTML
Export</a>.
</p>
</div>
</div>
<div id="outline-container-org76c8234" class="outline-3">
<h3 id="org76c8234"><span class="section-number-3">1.2.</span> Notes</h3>
<div class="outline-text-3" id="text-1-2">
<p>
This section has specific notes that are relevant to my emacs setup
in general and this document in particular.
</p>
</div>
<div id="outline-container-orgd2923ff" class="outline-4">
<h4 id="orgd2923ff"><span class="section-number-4">1.2.1.</span> Elpaca</h4>
<div class="outline-text-4" id="text-1-2-1">
<p>
A newer package manager, <a href="https://github.com/progfolio/elpaca">Elpaca</a> seeks to be a preferred drop-in
replacement for the built-in <code>package.el</code> manager. For the
configuration above, I use the standard installation boilerplate
and enable <span class="tooltip"><code>use-package</code><span class="tooltiptext">Declare an Emacs package by specifying a group of configuration options.<br><br>For the full documentation, see Info node ‘(use-package) top’.<br>Usage:<br><br> (use-package package-name<br> [:keyword [option]]...)<br><br>:init Code to run before PACKAGE-NAME has been loaded.<br>:config Code to run after PACKAGE-NAME has been loaded. Note that<br> if loading is deferred for any reason, this code does not<br> execute until the lazy load has occurred.<br>:preface Code to be run before everything except ‘:disabled’; this<br> can be used to define functions for use in ‘:if’, or that<br> should be seen by the byte-compiler.<br><br>:mode Form to be added to ‘auto-mode-alist’.<br>:magic Form to be added to ‘magic-mode-alist’.<br>:magic-fallback Form to be added to ‘magic-fallback-mode-alist’.<br>:interpreter Form to be added to ‘interpreter-mode-alist’.<br><br>:commands Define autoloads for commands that will be defined by the<br> package. This is useful if the package is being lazily<br> loaded, and you wish to conditionally call functions in your<br> ‘:init’ block that are defined in the package.<br>:autoload Similar to :commands, but it for no-interactive one.<br>:hook Specify hook(s) to attach this package to.<br><br>:bind Bind keys, and define autoloads for the bound commands.<br>:bind* Bind keys, and define autoloads for the bound commands,<br> *overriding all minor mode bindings*.<br>:bind-keymap Bind a key prefix to an auto-loaded keymap defined in the<br> package. This is like ‘:bind’, but for keymaps.<br>:bind-keymap* Like ‘:bind-keymap’, but overrides all minor mode bindings<br><br>:defer Defer loading of a package -- this is implied when using<br> ‘:commands’, ‘:bind’, ‘:bind*’, ‘:mode’, ‘:magic’, ‘:hook’,<br> ‘:magic-fallback’, or ‘:interpreter’. This can be an integer,<br> to force loading after N seconds of idle time, if the package<br> has not already been loaded.<br>:demand Prevent the automatic deferred loading introduced by constructs<br> such as ‘:bind’ (see ‘:defer’ for the complete list).<br><br>:after Delay the effect of the use-package declaration<br> until after the named libraries have loaded.<br> Before they have been loaded, no other keyword<br> has any effect at all, and once they have been<br> loaded it is as if ‘:after’ was not specified.<br><br>:if EXPR Initialize and load only if EXPR evaluates to a non-nil value.<br>:disabled The package is ignored completely if this keyword is present.<br>:defines Declare certain variables to silence the byte-compiler.<br>:functions Declare certain functions to silence the byte-compiler.<br>:load-path Add to the ‘load-path’ before attempting to load the package.<br>:diminish Support for diminish.el (if installed).<br>:delight Support for delight.el (if installed).<br>:custom Call ‘Custom-set’ or ‘set-default’ with each variable<br> definition without modifying the Emacs ‘custom-file’.<br> (compare with ‘custom-set-variables’).<br>:custom-face Call ‘custom-set-faces’ with each face definition.<br>:ensure Loads the package using package.el if necessary.<br>:pin Pin the package to an archive.<br><br>(fn NAME &rest ARGS)</span></span> support.
</p>
<p>
This is the quick cheat sheet of commands:
</p>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="org-left" />
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Operation</th>
<th scope="col" class="org-left">UI (keys apply in elpaca-ui-mode)</th>
<th scope="col" class="org-left">completing-read interface commands</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left">Finding Packages</td>
<td class="org-left"><code>M-x elpaca-manager</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-try</code><span class="tooltiptext">Try ORDER.<br>Install the repo/build files on disk.<br>Activate the corresponding package for the current session.<br>ORDER’s package is not made available during subsequent sessions.<br>When INTERACTIVE is non-nil, immediately process ORDER, otherwise queue ORDER.<br><br>(fn ORDER &optional INTERACTIVE)</span></span></td>
</tr>
<tr>
<td class="org-left">Trying Packages (for current session)</td>
<td class="org-left"><code>i x</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-try</code><span class="tooltiptext">Try ORDER.<br>Install the repo/build files on disk.<br>Activate the corresponding package for the current session.<br>ORDER’s package is not made available during subsequent sessions.<br>When INTERACTIVE is non-nil, immediately process ORDER, otherwise queue ORDER.<br><br>(fn ORDER &optional INTERACTIVE)</span></span></td>
</tr>
<tr>
<td class="org-left">Fetching Package Updates</td>
<td class="org-left"><code>f x</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-fetch</code><span class="tooltiptext">Fetch ID’s associated package remote commits.<br>This does not merge changes or rebuild the packages.<br>If INTERACTIVE is non-nil immediately process, otherwise queue.<br><br>(fn ID &optional INTERACTIVE)</span></span> or <span class="tooltip"><code>elpaca-fetch-all</code><span class="tooltiptext">Fetch queued elpaca remotes. If INTERACTIVE is non-nil, process queues.<br><br>(fn &optional INTERACTIVE)</span></span></td>
</tr>
<tr>
<td class="org-left">Merging Updates</td>
<td class="org-left"><code>u x</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-merge</code><span class="tooltiptext">Merge package commits associated with ID.<br>If FETCH is non-nil, download package changes before merging.<br>If INTERACTIVE is non-nil, the queued order is processed immediately.<br><br>(fn ID &optional FETCH INTERACTIVE)</span></span> or <span class="tooltip"><code>elpaca-merge-all</code><span class="tooltiptext">Merge and rebuild queued packages.<br>If FETCH is non-nil fetch updates first.<br>If INTERACTIVE is non-nil, process queues.<br><br>(fn &optional FETCH INTERACTIVE)</span></span></td>
</tr>
<tr>
<td class="org-left">Pulling Updates*</td>
<td class="org-left"><code>C-u u x</code></td>
<td class="org-left"><code>C-u M-x elpaca-merge</code> or <code>C-u M-x elpaca-merge-all</code></td>
</tr>
<tr>
<td class="org-left">Rebuilding Packages</td>
<td class="org-left"><code>r x</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-rebuild</code><span class="tooltiptext">Rebuild ID’s associated package.<br>When INTERACTIVE is non-nil, prompt for ID, immediately process.<br>With a prefix argument, rebuild current file’s package or prompt if none found.<br><br>(fn ID &optional INTERACTIVE)</span></span></td>
</tr>
<tr>
<td class="org-left">Deleting Packages</td>
<td class="org-left"><code>d x</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-delete</code><span class="tooltiptext">Remove a package associated with ID from cache and disk.<br>If DEPS is non-nil (interactively with C-u) delete dependencies.<br>If FORCE is non-nil (interactively with C-u C-u)<br>do not confirm before deleting package and DEPS.<br><br>(fn ID &optional FORCE DEPS IGNORED)</span></span></td>
</tr>
<tr>
<td class="org-left">View Package Logs</td>
<td class="org-left"><code>l</code> filters log to current package</td>
<td class="org-left"><span class="tooltip"><code>elpaca-log</code><span class="tooltiptext">Display ‘elpaca-log-buffer’ filtered by QUERY.<br><br>(fn &optional QUERY)</span></span></td>
</tr>
<tr>
<td class="org-left">Visit Package Repository Directory</td>
<td class="org-left"><code>v</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-visit</code><span class="tooltiptext">Open local repository directory for E with ID.<br>When BUILD is non-nil visit build directory.<br><br>(fn &optional ID BUILD)</span></span></td>
</tr>
<tr>
<td class="org-left">Visit Package Build Directory</td>
<td class="org-left"><code>C-u v</code></td>
<td class="org-left"><code>C-u M-x elpaca-visit</code></td>
</tr>
<tr>
<td class="org-left">Browse Package Website</td>
<td class="org-left"><code>b</code></td>
<td class="org-left"><span class="tooltip"><code>elpaca-browse</code><span class="tooltiptext">Browse menu item with ID’s :url.<br><br>(fn ID)</span></span></td>
</tr>
</tbody>
</table>
<p>
There is also a <a href="https://github.com/progfolio/elpaca/blob/master/doc/manual.md">helpful manual</a>.
</p>
<p>
To see how the startup time has imporoved, let's store when we
start evaluating these settings.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span> bnb/start-time <span style="color: #3e999f;">(</span>float-time<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgad6fd5c" class="outline-4">
<h4 id="orgad6fd5c"><span class="section-number-4">1.2.2.</span> Emacs Build</h4>
<div class="outline-text-4" id="text-1-2-2">
<p>
My current flavor of Emacs comes from:
<a href="https://github.com/d12frosted/homebrew-emacs-plus">https://github.com/d12frosted/homebrew-emacs-plus</a>
</p>
<p>
To install with <code>brew</code>, run the following command:
</p>
<div class="org-src-container">
<pre class="src src-sh">brew install emacs-plus@29 --with-nobu417-big-sur-icon --with-imagemagick --with-native-comp
</pre>
</div>
<p>
Notes: <a href="https://www.masteringemacs.org/article/whats-new-in-emacs-29-1">What's new in 29.1</a>
</p>
</div>
</div>
<div id="outline-container-orgedf50cd" class="outline-4">
<h4 id="orgedf50cd"><span class="section-number-4">1.2.3.</span> Pending sections</h4>
<div class="outline-text-4" id="text-1-2-3">
<p>
There are some features that I like to take on a <i>trial run</i>. These
are marked with the <b>PENDING</b> tag to help me remember and evaluate.
</p>
</div>
</div>
<div id="outline-container-orge5274c1" class="outline-4">
<h4 id="orge5274c1"><span class="section-number-4">1.2.4.</span> Performance</h4>
<div class="outline-text-4" id="text-1-2-4">
<p>
By utilizing elements of <code>use-package</code>, I can keep an eye on
troublesome packages during startup. Together, these turn on
reporting and set the minimum time to consider when building the
report.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span> use-package-verbose t
use-package-compute-statistics t
use-package-minimum-reported-time 0<span style="color: #4d4d4c;">)</span>
</pre>
</div>
<p>
The generated messages will be found in the <code>*Messsages*</code> buffer.
</p>
<p>
There is also the <a href="(elpaca-log)">elpaca log</a> that can show loading times.
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-orgecfcb95" class="outline-2">
<h2 id="orgecfcb95"><span class="section-number-2">2.</span> Preamble</h2>
<div class="outline-text-2" id="text-2">
<p>
This sections houses the settings that need to be made up front and
support subsuquent package installation and activiation.
</p>
</div>
<div id="outline-container-org29b4aa7" class="outline-3">
<h3 id="org29b4aa7"><span class="section-number-3">2.1.</span> Personal Information</h3>
<div class="outline-text-3" id="text-2-1">
<p>
The full name is used for email messages.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span> user-full-name <span style="color: #3e999f;">"Benjamin Beckwith"</span><span style="color: #4d4d4c;">)</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orge1fb2a8" class="outline-3">
<h3 id="orge1fb2a8"><span class="section-number-3">2.2.</span> Local customizations (custom.el, username.var.el)</h3>
<div class="outline-text-3" id="text-2-2">
<p>
I typically use the customize interface to generate any local
settings such as proxies, paths, fonts, etc. that may vary from
machine to machine. This keeps the setup the same and allows for
only some details to differ.
</p>
<p>
I like to set the custom file explicitly. Mine resides in the
<a href="file:///Users/ben.beckwith/.emacs.d/">~/.emacs.d/</a> directory. This code block sets the file name and
loads it if it exists.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span> custom-file <span style="color: #3e999f;">"~/.emacs.d/custom.el"</span><span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">if</span> <span style="color: #3e999f;">(</span>file-exists-p custom-file<span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span>load-file custom-file<span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
</pre>
</div>
<p>
If the file doesn't exist, <code>Emacs</code> will still use the file if any
changes are made through the <i>custom interface</i>.
</p>
<p>
Sometimes I'll get bad settings or cruft in that file. I now have a
key, <code><F7></code>, for easy navigation to wherever the <code>custom-file</code> points.
</p>
</div>
<div id="outline-container-orgbfb20e0" class="outline-4">
<h4 id="orgbfb20e0"><span class="section-number-4">2.2.1.</span> Local variables (user-login-name)</h4>
<div class="outline-text-4" id="text-2-2-1">
<p>
I also intend to have a generic call to an installed local file
that may need to behave differently from <code>custom.el</code>. This loads
last so that it can modify any existing setting made here to work
on the specific system in question.
</p>
<p>
In the code below, I add <code>~/.emacs.d/</code> to the load path and have a
protected call to <span class="tooltip"><code>load-library</code><span class="tooltiptext">Load the Emacs Lisp library named LIBRARY.<br>LIBRARY should be a string.<br>This is an interface to the function ‘load’. LIBRARY is searched<br>for in ‘load-path’, both with and without ‘load-suffixes’ (as<br>well as ‘load-file-rep-suffixes’).<br><br>See Info node ‘(emacs)Lisp Libraries’ for more details.<br>See ‘load-file’ for a different interface to ‘load’.<br><br>(fn LIBRARY)</span></span>. If the file exists, it gets
loaded, otherwise the error normally returned if the file is
non-existent gets ignored.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">condition-case</span> err
<span style="color: #3e999f;">(</span><span style="color: #718c00;">progn</span>
<span style="color: #eab700;">(</span>load-file <span style="color: #718c00;">(</span>format <span style="color: #3e999f;">"~/.emacs.d/%s.vars.el"</span> user-login-name<span style="color: #718c00;">)</span><span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span>message <span style="color: #3e999f;">"Loaded local settings file %s.vars.el"</span> user-login-name<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
<span style="color: #3e999f;">(</span>file-error
<span style="color: #eab700;">(</span>message <span style="color: #3e999f;">"Skipping %s.vars library as it does not exist."</span> user-login-name<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span>
nil<span style="color: #4d4d4c;">)</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org70b264d" class="outline-3">
<h3 id="org70b264d"><span class="section-number-3">2.3.</span> Early Initialization</h3>
<div class="outline-text-3" id="text-2-3">
<p>
There are a few optimizations to make so that emacs can get
initialized quickly. First, setup the garbage collector to have a
default value of 16mb and a initializtion time value of
<code>most-positive-fixnum</code>.
</p>
<p>
This prevents garbage collection from pausing evaluation during
startup. After startup, I leverage the hook to reset the
optimizations down to their default values.
</p>
<p>
The next setting stores <span class="tooltip"><code>file-name-handler-alist</code><span class="tooltiptext">Alist of elements (REGEXP . HANDLER) for file names handled specially.<br>If a file name matches REGEXP, all I/O on that file is done by calling<br>HANDLER. If a file name matches more than one handler, the handler<br>whose match starts last in the file name gets precedence. The<br>function ‘find-file-name-handler’ checks this list for a handler for<br>its argument.<br><br>HANDLER should be a function. The first argument given to it is the<br>name of the I/O primitive to be handled; the remaining arguments are<br>the arguments that were passed to that primitive. For example, if you<br>do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then<br>HANDLER is called like this:<br><br> (funcall HANDLER 'file-exists-p FILENAME)<br><br>Note that HANDLER must be able to handle all I/O primitives; if it has<br>nothing special to do for a primitive, it should reinvoke the<br>primitive to handle the operation "the usual way".<br>See Info node ‘(elisp)Magic File Names’ for more details.</span></span> and then sets it to
<code>nil</code>. By doing this, there is no automatic handler evalutation
happening during startup. This setting goes back to its original
value post startup.
</p>
<p>
Finally, user interface elements are hidden early to have a nice
streamlined interface.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">Disable package enabling at startup</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span> package-enable-at-startup nil<span style="color: #4d4d4c;">)</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">Tweak garbage collection threshold</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defvar</span> <span style="color: #eab700;">default-gc-cons-threshold</span> 16777216 <span style="color: #8e908c; font-style: italic;">; </span><span style="color: #8e908c; font-style: italic;">16mb</span>
<span style="color: #8959a8;">"my default desired value of `</span><span style="color: #4271ae;">gc-cons-threshold</span><span style="color: #8959a8;">'</span>
<span style="color: #8959a8;">during normal emacs operations."</span><span style="color: #4d4d4c;">)</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">make garbage collector less invasive</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span>
gc-cons-threshold most-positive-fixnum
gc-cons-percentage 0.6<span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span><span style="color: #718c00;">setq</span>
default-file-name-handler-alist file-name-handler-alist
file-name-handler-alist nil<span style="color: #4d4d4c;">)</span>
<span style="color: #4d4d4c;">(</span>add-hook
'emacs-startup-hook
<span style="color: #3e999f;">(</span><span style="color: #718c00;">lambda</span> <span style="color: #eab700;">(</span><span style="color: #4271ae;">&rest</span> _<span style="color: #eab700;">)</span>
<span style="color: #eab700;">(</span><span style="color: #718c00;">setq</span>
gc-cons-threshold
default-gc-cons-threshold
gc-cons-percentage 0.1
file-name-handler-alist default-file-name-handler-alist<span style="color: #eab700;">)</span>
<span style="color: #8e908c; font-style: italic;">;; </span><span style="color: #8e908c; font-style: italic;">delete no longer necessary startup variable</span>
<span style="color: #eab700;">(</span>makunbound 'default-file-name-handler-alist<span style="color: #eab700;">)</span><span style="color: #3e999f;">)</span><span style="color: #4d4d4c;">)</span>
</pre>
</div>
<p>
The block above is written to <a href="file:///Users/ben.beckwith/.emacs.d/early-init.el">~/.emacs.d/early-init.el</a> and
automatically evaluated first by emacs.
</p>
</div>
<div id="outline-container-org9f58691" class="outline-4">
<h4 id="org9f58691"><span class="section-number-4">2.3.1.</span> Init debug assistance</h4>
<div class="outline-text-4" id="text-2-3-1">
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span style="color: #4d4d4c;">(</span><span style="color: #718c00;">defmacro</span> <span style="color: #f5871f;">comment</span> <span style="color: #3e999f;">(</span><span style="color: #4271ae;">&rest</span> body<span style="color: #3e999f;">)</span>
<span style="color: #8959a8;">"Comment out sexps in BODY"</span>
nil<span style="color: #4d4d4c;">)</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org363a4b3" class="outline-3">
<h3 id="org363a4b3"><span class="section-number-3">2.4.</span> Libraries</h3>
<div class="outline-text-3" id="text-2-4">
<p>
This section hosts early loading of libraries required by
subsequent packages.