about summary refs log tree commit diff stats
path: root/README.md
blob: f725e8432513dfc031d8bce99008f1be31e9d9c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
Let’s configure Emacs using Org mode, they said.  It’ll be fun, they said.


# Pave the way


## Correct `exec-path`

    (let ((win-downloads "c:/Users/aduckworth/Downloads"))
      (dolist (path (list
    		 ;; Linux
    		 (expand-file-name "bin"
    				   user-emacs-directory)
    		 (expand-file-name "~/bin")
    		 (expand-file-name "~/.local/bin")
    		 (expand-file-name "~/Scripts")
    		 ;; Windows
    		 (expand-file-name "emacs/bin"
    				   win-downloads)
    		 (expand-file-name "m/usr/bin"
    				   win-downloads)
    		 (expand-file-name "m/mingw64/bin"
    				   win-downloads)
    		 (expand-file-name "PortableGit/bin"
    				   win-downloads)
    		 (expand-file-name "PortableGit/usr/bin"
    				   win-downloads)))
        (when (file-exists-p path)
          (add-to-list 'exec-path path))))


## Package management


### Straight.el

Since for whatever reason, Straight can't bootstrap itself on Windows
– I've wrapped it in a function here and added the direct git command
when it errors.

    (defun acdw/bootstrap-straight ()
      (defvar bootstrap-version)
    		       (let ((bootstrap-file
    			      (expand-file-name
    			       "straight/repos/straight.el/bootstrap.el"
    			       user-emacs-directory))
    			     (bootstrap-version 5))
    			 (unless (file-exists-p bootstrap-file)
    			   (with-current-buffer
    			       (url-retrieve-synchronously
    				(concat "https://raw.githubusercontent.com/"
    					"raxod502/straight.el/develop/install.el")
    				'silent 'inhibit-cookies)
    			     (goto-char (point-max))
    			     (eval-print-last-sexp)))
    			 (load bootstrap-file nil 'nomessage)))
    
    (unless (ignore-errors (acdw/bootstrap-straight))
      (message "Straight.el didn't bootstrap correctly.  Cloning directly...")
      (call-process "git" nil (get-buffer-create "*bootstrap-straight-messages*") nil
    		"clone"
    		"https://github.com/raxod502/straight.el"
    		(expand-file-name "straight/repos/straight.el"
    				  user-emacs-directory))
      (acdw/bootstrap-straight))


### Use-package

    (setq straight-use-package-by-default t)
    (setq use-package-hook-name-suffix nil)
    (straight-use-package 'use-package)


### Extra use-package keywords

1.  :custom-update

        (straight-use-package
         '(use-package-custom-update
           :host github
           :repo "a13/use-package-custom-update"))
        
        (require 'use-package-custom-update)


## Customize variables


### Put customizations in a separate file

    (setq custom-file
          (expand-file-name "custom.el" user-emacs-directory))


### A macro for ease of customization

    (defmacro cuss (var val &optional docstring)
      "Basically `:custom' from `use-package', broken out."
      `(funcall (or (get ',var 'custom-set) #'set-default)
    	    ',var ,val))


## Keep a tidy `~/.emacs`

    (straight-use-package 'no-littering)
    
    (cuss backup-directory-alist `((".*" . ,(no-littering-expand-var-file-name "backup/")))
          "Where to store backup files.")
    
    (cuss auto-save-file-name-transforms
          `((".*" ,(no-littering-expand-var-file-name "autosaves/") t))
          "Where to store auto-save files.")
    
    (cuss save-place-file (no-littering-expand-var-file-name "places")
          "Where to store place files.")
    
    (cuss undo-fu-session-directory (no-littering-expand-var-file-name "undos/")
          "Where to store undo information.")
    
    (cuss elpher-certificate-directory
          (no-littering-expand-var-file-name "elpher-certificates/")
          "Where to store elpher client certificates.")
    
    ;; Make all directories defined above
    (dolist (dir '("backup"
    	       "autosaves"
    	       "undos"
    	       "elpher-certificates"))
      (make-directory (no-littering-expand-var-file-name dir) 'parents))


## About me

    (setq user-full-name "Case Duckworth"
          user-mail-address "acdw@acdw.net")


# Look and Feel


## Simplify the UI


### Tool bars and menu bars

    (cuss default-frame-alist
          '((tool-bar-lines . 0)
    	(menu-bar-lines . 0)))
    
    (menu-bar-mode -1)
    (tool-bar-mode -1)


### Scroll bars

    (add-to-list 'default-frame-alist '(vertical-scroll-bars . nil))
    (scroll-bar-mode -1)
    
    (add-to-list 'default-frame-alist '(horizontal-scroll-bars . nil))
    (horizontal-scroll-bar-mode -1)


### Dialog boxen

    (cuss use-dialog-box nil)


### Shorten confirmations

    (fset 'yes-or-no-p #'y-or-n-p)


### Remove the bell

    (cuss visible-bell (not (string= (system-name) "larry")))
    
    (defun acdw/ring-bell-function ()
      "Custom bell-ringing function."
      (let ((orig-face (face-foreground 'mode-line)))
        (set-face-foreground 'modeline "#F2804F")
        (run-with-idle-timer
         0.1 nil
         (lambda (fg)
           (set-face-foreground 'mode-line fg))
         orig-face)))
    
    (cuss ring-bell-function #'acdw/ring-bell-function)


### Tell Ediff to setup windows better

    (declare-function ediff-setup-windows-plain "ediff-wind.el")
    (cuss ediff-window-setup-function #'ediff-setup-windows-plain)


## Tweak the remaining UI


### Fringes

    (add-to-list 'default-frame-alist '(left-fringe-width . 2))
    (add-to-list 'default-frame-alist '(right-fringe-width . 2))


### Minibuffer

1.  Setup the minibuffer frame

        (cuss minibuffer-frame-alist
              '((width . 80)
        	(height . 2)
        	(vertical-scrollbars . nil)))
        
        (set-window-scroll-bars (minibuffer-window) nil nil)

2.  Keep the cursor from going into the prompt

        (cuss minibuffer-prompt-properties
              '(read-only t cursor-intangible t face minibuffer-prompt))


### Tabs

1.  Show the tabs as current buffer, plus window count

        (cuss tab-bar-tab-name-function #'tab-bar-tab-name-current-with-count)

2.  Only show the tab bar when there's more than one tab

        (cuss tab-bar-show 1
              "Show the tab bar only when there's more than 1 tab.")


### Cursor

    (cuss cursor-type 'bar
          "Show a vertical bar for the cursor.")
    (cuss cursor-in-non-selected-windows 'hollow
          "In inactive windows, make the cursor an empty box.")
    (blink-cursor-mode 0)


### Buffer names

    (require 'uniquify)
    (cuss uniquify-buffer-name-style 'forward)


### Buffer boundaries

    (cuss indicate-buffer-boundaries
          '((up . right)
    	(down . right)
    	(t . nil)))
    
    (cuss indicate-empty-lines t)


## Windows


### Winner mode

    (when (fboundp 'winner-mode)
      (winner-mode +1))


### Windmove

    (cuss windmove-create-window t
          "Create windows in a direction if they don't exist.")
    (cuss windomove-wrap-around t
          "Wrap window movements around frame edges.")
    
    (windmove-default-keybindings)


### Pop some buffers up in the same window

from [link0ff](https://github.com/link0ff/emacs-init).

    (push `(,(rx bos
    	     "*"
    	     (or "Help" "Apropos" "Colors" "Buffer List" "Command History"
    		 "Dictionary" "Locate" "Messages" "Proced" "eww" "snd"
    		 (and "gud-" (+ (any "a-z0-9")))
    		 "compilation" "grep" "erlang" "haskell"
    		 ;; Handle both "*shell*" and e.g. "*emacs-shell*"
    		 ;; generated by `project-shell':
    		 (and (? (* nonl) "-") "shell")
    		 "Shell Command Output"
    		 (and "SQL: " (+ (any "A-za-z")))
    		 "Diff" "vc-dir" "vc-log" "vc-search-log")
    	     "*"
    	     ;; Uniquifed buffer name with optional suffix in angle brackets
    	     (? (and "<" (+ (not (any ">"))) ">"))
    	     eos)
    	display-buffer-same-window
    	(inhibit-same-window . nil))
          display-buffer-alist)
    
    (defun display-buffer-from-help-p (_buffer-name _action)
      (unless current-prefix-arg
        (with-current-buffer (window-buffer)
          (eq major-mode 'help-mode))))
    
    (push '(display-buffer-from-help-p display-buffer-same-window)
          display-buffer-alist)


## Startup

    (cuss inhibit-startup-screen t "Don't show Emacs' startup buffer.")
    (cuss initial-buffer-choice t "Start at *scratch*.")
    (cuss initial-scratch-message "" "Empty *scratch*.")


## Theme

    (straight-use-package '(modus-themes
    			:host gitlab
    			:repo "protesilaos/modus-themes"
    			:branch "main"))
    
    (cuss modus-themes-slanted-constructs t)
    (cuss modus-themes-bold-constructs t)
    (cuss modus-themes-fringes nil)
    (cuss modus-themes-mode-line '3d)
    (cuss modus-themes-syntax 'yellow-comments)
    (cuss modus-themes-intense-hl-line nil)
    (cuss modus-themes-paren-match 'intense-bold)
    (cuss modus-themes-links nil)
    (cuss modus-themes-no-mixed-fonts nil)
    (cuss modus-themes-prompts nil)
    (cuss modus-themes-completions nil)
    (cuss modus-themes-diffs nil)
    (cuss modus-themes-org-blocks 'grayscale)
    (cuss modus-themes-headings
          '((1 . line)
    	(t . t)))
    (cuss modus-themes-variable-pitch-headings t)
    (cuss modus-themes-scale-headings t)
    (cuss modus-themes-scale-1 1.1)
    (cuss modus-themes-scale-2 1.15)
    (cuss modus-themes-scale-3 1.21)
    (cuss modus-themes-scale-4 1.27)
    (cuss modus-themes-scale-5 1.33)
    
    ;; :custom-face
    (custom-set-faces `(font-lock-comment-face
    		    ((t (:inherit (custom-comment italic variable-pitch))))))
    
    (load-theme 'modus-operandi t)


### Change theme based on time of day

    (cuss calendar-latitude 30.4515)
    (cuss calendar-longitude -91.1871)
    
    (straight-use-package 'circadian)
    
    (cuss circadian-themes '((:sunrise . modus-operandi)
    			 (:sunset . modus-vivendi)))
    
    (circadian-setup)


### Modeline

    (straight-use-package 'smart-mode-line)
    (cuss sml/no-confirm-load-theme t)
    (sml/setup)

1.  Rich minority

    Since this *comes* with smart mode line, I’m just going to use it, instead of `diminish` or another package.  I do have to write this helper function, though, to add things to the whitelist.
    
        (defun rm/whitelist-add (regexp)
          "Add a REGEXP to the whitelist for `rich-minority'."
          (if (listp 'rm--whitelist-regexps)
              (add-to-list 'rm--whitelist-regexps regexp)
            (setq rm--whitelist-regexps `(,regexp)))
          (setq rm-whitelist
        	(mapconcat 'identity rm--whitelist-regexps "\\|")))
        
        (straight-use-package 'rich-minority)
        
        (rm/whitelist-add "^$")


### Fonts

1.  Define fonts

        (defun set-face-from-alternatives (face fonts)
          (catch :return
            (dolist (font fonts)
              (when (find-font (font-spec :family (car font)))
        	(apply #'set-face-attribute `(,face nil
        					    :family ,(car font)
        					    ,@(cdr font)))
        	(throw :return font)))))
        
        (defun acdw/setup-fonts ()
          "Setup fonts.  This has to happen after the frame is setup for
        the first time, so it should be added to `window-setup-hook'.  It
        removes itself from that hook."
          (interactive)
          (when (display-graphic-p)
            (set-face-from-alternatives 'default
        				'(("Libertinus Mono"
        				   :height 110)
        				  ("Linux Libertine Mono O"
        				   :height 110)
        				  ("Go Mono"
        				   :height 100)
        				  ("Consolas"
        				   :height 100)))
        
            (set-face-from-alternatives 'fixed-pitch
        				'(("Libertinus Mono"
        				   :height 110)
        				  ("Linux Libertine Mono O"
        				   :height 110)
        				  ("Go Mono"
        				   :height 100)
        				  ("Consolas"
        				   :height 100)))
        
            (set-face-from-alternatives 'variable-pitch
        				'(("Libertinus Serif"
        				   :height 120)
        				  ("Linux Libertine O"
        				   :height 120)
        				  ("Georgia"
        				   :height 110)))
        
            (remove-function after-focus-change-function #'acdw/setup-fonts)))
        
        (add-function :before after-focus-change-function #'acdw/setup-fonts)

2.  Variable-pitch in text modes

        (add-hook 'text-mode-hook #'variable-pitch-mode)

3.  Line spacing

        (cuss line-spacing 0.1)

4.  Unicode fonts

        (straight-use-package 'unicode-fonts)
        (with-eval-after-load 'unicode-fonts
          (unicode-fonts-setup))


# Interactivity


## Async

    (straight-use-package 'async)
    (autoload 'dired-async-mode "dired-async.el" nil t)
    (dired-async-mode +1)
    
    (async-bytecomp-package-mode +1)


## Completing-read


### Shadow file names

    (cuss file-name-shadow-properties '(invisible t))
    
    (file-name-shadow-mode +1)


### Selectrum

    (straight-use-package 'selectrum)
    (require 'selectrum)
    (selectrum-mode +1)


### Prescient

    (straight-use-package 'prescient)
    (require 'prescient)
    
    (prescient-persist-mode +1)
    
    (straight-use-package 'selectrum-prescient)
    
    (with-eval-after-load 'prescient
      (with-eval-after-load 'selectrum
        (selectrum-prescient-mode +1)))
    
    (straight-use-package 'company-prescient)
    
    (with-eval-after-load 'prescient
      (with-eval-after-load 'company
        (company-prescient-mode +1)))


### Consult

    (use-package consult
      :after (selectrum)
      :straight (consult
    	     :host github
    	     :repo "minad/consult")
      :bind
      (("C-x b" . consult-buffer)
       ("C-x 4 b" . consult-buffer-other-window)
       ("C-x 5 b" . consult-buffer-other-frame)
       ("M-g o" . consult-outline)
       ("M-g l" . consult-line)
       ("M-y" . consult-yank-pop)
       ("<help> a" . consult-apropos))
      :init
      (fset 'multi-occur #'consult-multi-occur))
    
    (use-package consult-selectrum
      :straight (consult-selectrum
    	     :host github
    	     :repo "minad/consult"))


### Marginalia

    (straight-use-package '(marginalia
    			:host github
    			:repo "minad/marginalia"
    			:branch "main"))
    
    (cuss marginalia-annotators
          (if (eq system-type 'windows-nt)
    	  '(marginalia-annotators-light
    	    marginalia-annotators-heavy)
    	'(marginalia-annotators-heavy
    	  marginalia-annotators-light)))
    
    (marginalia-mode +1)


## Ignore case

    (cuss completion-ignore-case t)
    (cuss read-buffer-completion-ignore-case t)
    (cuss read-file-name-completion-ignore-case t)


## Search

    (use-package ctrlf
      :custom
      (ctrlf-show-match-count-at-eol nil)
      :bind
      ("C-s" . ctrlf-forward-regexp)
      ("C-r" . ctrlf-backward-regexp)
      ("C-M-s" . ctrlf-forward-literal)
      ("C-M-r" . ctrlf-backward-literal)
      :config
      (ctrlf-mode +1))


## Mouse


### Fix scrolling in margins

This is not *quite* correct yet.  For example, scrolling in the margins with a trackpad isn’t picked up (a trackpad sends different mouse events).

    (dolist (vec '([left-margin wheel-down]
    	       [right-margin wheel-down]
    	       [left-margin wheel-up]
    	       [right-margin wheel-up]))
      (bind-key vec #'mwheel-scroll))


## Keyboard


### Use `ESC` as a cancel key

From [link0ff](https://github.com/link0ff/emacs-init).  I thought they made a great point that `ESC` isn’t necessary to copy the `META` key on window-systems, which is where I use Emacs, anyway.

    (when window-system
      (define-key global-map [escape] 'keyboard-escape-quit)
      (define-key isearch-mode-map  [escape] 'isearch-cancel))


### Make `C-z` more useful as a prefix key

Also from link0ff.  See the above for a link.

    (defvar acdw/map
      (let ((map (make-sparse-keymap))
    	(c-z (global-key-binding "\C-z")))
        (global-unset-key "\C-z")
        (define-key global-map "\C-z" map)
        (define-key map "\C-z" c-z)
        map))
    (run-hooks 'acdw/map-defined-hook)


### Which-key

    (straight-use-package 'which-key)
    
    (which-key-mode +1)


### Bindings

1.  Switch to another window

        (bind-key "M-o" #'other-window)


# Persistence


## Save history

    (require 'savehist)
    
    (cuss savehist-additional-variables
          '(kill-ring
    	search-ring
    	regexp-search-ring))
    
    (cuss savehist-save-minibuffer-history t)
    
    (cuss history-length t)
    
    (cuss history-delete-duplicates t)
    
    (savehist-mode +1)


## Save places in files

    (require 'saveplace)
    
    (cuss save-place-forget-unreadable-files
          (not (eq system-type 'windows-nt)))
    
    (save-place-mode 1)


## Recent files

    (require 'recentf)
    
    (cuss recentf-max-menu-items 100)
    (cuss recentf-max-saved-items 100)
    
    (with-eval-after-load 'no-littering
      (add-to-list 'recentf-exclude no-littering-var-directory)
      (add-to-list 'recentf-exclude no-littering-etc-directory))
    
    (recentf-mode 1)


### Easily navigate recent files

    (defun recentf-find-file ()
      "Find a recent file using `completing-read'."
      (interactive)
      (let ((file (completing-read "Recent file: " recentf-list nil t)))
        (when file
          (find-file file))))
    
    (global-set-key (kbd "C-x C-r") #'recentf-find-file)


## Undo

    (use-package undo-fu
      :bind
      ("C-/" . undo-fu-only-undo)
      ("C-?" . undo-fu-only-redo))
    
    (straight-use-package 'undo-fu-session)
    
    (cuss undo-fu-session-incompatible-files
          '("/COMMIT_EDITMSG\\'"
    	"/git-rebase-todo\\'"))
    
    (global-undo-fu-session-mode +1)


# Editing


## Operate visually on lines

    (global-visual-line-mode +1)


## Require a final newline

    (cuss require-final-newline t)


## Killing & Yanking


### Replace selection when typing

    (delete-selection-mode +1)


### Save existing clipboard text into kill ring before replacing it

    (cuss save-interprogram-paste-before-kill t)


### Sync the system clipboard and the kill ring

    (cuss yank-pop-change-selection t)


## So long mode

    (when (fboundp 'global-so-long-mode)
      (global-so-long-mode))


## Multiple cursors

    (use-package multiple-cursors
      :bind
      ("C->" . mc/mark-next-like-this)
      ("C-<" . mc/mark-previous-like-this)
      ("C-c C-<" . mc/mark-all-like-this))


## Expand region

    (use-package expand-region
      :bind
      (("C-=" . er/expand-region)
       ("C-+" . er/contract-region)))


## Highlight modified regions

    (straight-use-package 'goggles)
    
    (cuss goggles-pulse nil)
    
    (goggles-mode +1)


# Files


## Encoding


### UTF-8

    (set-language-environment "UTF-8")
    (set-terminal-coding-system 'utf-8)
    (cuss locale-coding-system 'utf-8)
    (set-default-coding-systems 'utf-8)
    (set-selection-coding-system 'utf-8)
    (prefer-coding-system 'utf-8)


### Convert all files to UNIX-style line endings

from [Emacs Wiki](https://www.emacswiki.org/emacs/EndOfLineTips).

    (defun ewiki/no-junk-please-were-unixish ()
      "Convert line endings to UNIX, dammit."
      (let ((coding-str (symbol-name buffer-file-coding-system)))
        (when (string-match "-\\(?:dos\\|mac\\)$" coding-str)
          (set-buffer-file-coding-system 'unix))))

I add it to the `find-file-hook` *and* `before-save-hook` because I don't want to ever work with anything other than UNIX line endings ever again.  I just don't care.  Even Microsoft Notepad can handle UNIX line endings, so I don't want to hear it.

    (add-hook 'find-file-hook #'ewiki/no-junk-please-were-unixish)
    (add-hook 'before-save-hook #'ewiki/no-junk-please-were-unixish)


## Backups

    (cuss backup-by-copying 1)
    (cuss delete-old-versions -1)
    (cuss version-control t)
    (cuss vc-make-backup-files t)


## Auto-saves

    (auto-save-visited-mode 1)


## Revert files

    (cuss auto-revert-verbose nil)
    (global-auto-revert-mode +1)


## Add a timestamp to files

    (add-hook 'before-save-hook #'time-stamp)


# Programming


## Which function are we in?

    (which-function-mode +1)


## Parentheses


### Show parentheses

    (cuss show-paren-delay 0 "Show matching parens immediately.")
    (cuss show-paren-style 'mixed
          "Show parenthesis, or whole expression, depending on visibility.")
    (cuss show-paren-when-point-in-periphery t
          "Show paren when point is near-to paren.")
    (cuss show-paren-when-point-inside-paren t
          "Show surrounding parens.")
    
    (add-hook 'prog-mode-hook #'show-paren-mode)


### Smart parentheses

    (straight-use-package 'smartparens)
    (require 'smartparens-config)
    
    (show-smartparens-global-mode +1)
    (add-to-list 'sp-ignore-modes-list 'org-mode)
    
    (add-hook 'prog-mode-hook #'smartparens-strict-mode)


## Indenting

    (straight-use-package 'aggressive-indent)
    
    (global-aggressive-indent-mode +1)


## Completion

    (use-package company
      :custom
      (company-idle-delay 0.1)
      (company-minimum-prefix-length 3)
    
      :init
      (defun acdw/company-complete-common-or-cycle+1 ()
        (interactive)
        (company-complete-common-or-cycle +1))
    
      (defun acdw/company-complete-common-or-cycle-1 ()
        (interactive)
        (company-complete-common-or-cycle -1))
    
      :bind
      (:map company-active-map
    	("C-n" . acdw/company-complete-common-or-cycle+1)
    	("C-p" . acdw/company-complete-common-or-cycle-1))
    
      :hook
      (prog-mode-hook . company-mode))
    
    (use-package company-prescient
      :hook
      (company-mode-hook . company-prescient-mode))
    
    ;; this comes with company-quickhelp, so....
    
    (use-package company-posframe
      :after (company)
      :config
      (company-posframe-mode +1))


## Languages


### Lua

    (use-package lua-mode
      :mode "\\.lua\\'"
      :interpreter "lua")


### Fennel

    (use-package fennel-mode
      :mode "\\.fnl\\'")


### Emacs lisp

    (cuss eval-expression-print-length nil
          "Don't truncate printed expressions by length.")
    (cuss eval-expression-print-level nil
          "Don't truncate printed expressions by level.")


# Writing


## Visual Fill Column

    (straight-use-package 'visual-fill-column)
    
    (cuss split-window-preferred-function
          'visual-fill-column-split-window-sensibly)
    (cuss visual-fill-column-center-text t)
    (cuss fill-column 80)
    
    (advice-add 'text-scale-adjust
    	    :after #'visual-fill-column-adjust)
    
    (add-hook 'text-mode-hook #'visual-fill-column-mode)


## Type nice-looking quote-type marks

    (straight-use-package 'typo)
    
    (add-hook 'text-mode-hook #'typo-mode)


## Insert *kaomoji*

    (use-package insert-kaomoji
      :bind
      ("C-x 8 k" . insert-kaomoji))


# Applications


## Magit

    (use-package magit
      :bind
      ("C-z g" . magit-status))


## Org mode

I’ve put org mode under Applications, as opposed to Writing, because it’s  more generally-applicable than that.

    (straight-use-package 'org)
    
    (with-eval-after-load 'org
      (require 'org-tempo)
      (require 'ox-md)
      (bind-key "M-n" #'outline-next-visible-heading 'org-mode-map)
      (bind-key "M-p" #'outline-previous-visible-heading 'org-mode-map))
    
    (cuss org-hide-emphasis-markers t)
    (cuss org-fontify-done-headline t)
    (cuss org-fontify-whole-heading-line t)
    (cuss org-fontify-quote-and-verse-blocks t)
    (cuss org-pretty-entities t)
    (cuss org-num-mode +1)
    (cuss org-src-tab-acts-natively t)
    (cuss org-src-fontify-natively t)
    (cuss org-src-window-setup 'current-window)
    (cuss org-confirm-babel-evaluate nil)
    (cuss org-directory "~/Org")


### Org Agenda

    (cuss org-agenda-files (no-littering-expand-etc-file-name "agenda-files"))
    
    (if (and (stringp org-agenda-files)
    	 (not (file-exists-p org-agenda-files)))
        (with-temp-buffer (write-file org-agenda-files)))


### Make bullets look like bullets

    (font-lock-add-keywords
     'org-mode
     '(("^ *\\([-+]\\) "
        (0 (prog1 ()
    	 (compose-region (match-beginning 1)
    			 (match-end 1)
    			 "•"))))))


### [A better return in Org mode](http://kitchingroup.cheme.cmu.edu/blog/2017/04/09/A-better-return-in-org-mode/)

    (require 'org-inlinetask)
    
    (defun scimax/org-return (&optional ignore)
      "Add new list item, heading or table row with RET.
    A double return on an empty element deletes it.
    Use a prefix arg to get regular RET."
      (interactive "P")
      (if ignore
          (org-return)
        (cond
    
         ((eq 'line-break (car (org-element-context)))
          (org-return t))
    
         ;; Open links like usual, unless point is at the end of a line.
         ;; and if at beginning of line, just press enter.
         ((or (and (eq 'link (car (org-element-context))) (not (eolp)))
    	  (bolp))
          (org-return))
    
         ;; It doesn't make sense to add headings in inline tasks. Thanks Anders
         ;; Johansson!
         ((org-inlinetask-in-task-p)
          (org-return))
    
         ;; checkboxes too
         ((org-at-item-checkbox-p)
          (org-insert-todo-heading nil))
    
         ;; lists end with two blank lines, so we need to make sure we are also not
         ;; at the beginning of a line to avoid a loop where a new entry gets
         ;; created with only one blank line.
         ((org-in-item-p)
          (if (save-excursion (beginning-of-line) (org-element-property :contents-begin (org-element-context)))
    	  (org-insert-heading)
    	(beginning-of-line)
    	(delete-region (line-beginning-position) (line-end-position))
    	(org-return)))
    
         ;; org-heading
         ((org-at-heading-p)
          (if (not (string= "" (org-element-property :title (org-element-context))))
    	  (progn (org-end-of-meta-data)
    		 (org-insert-heading-respect-content)
    		 (outline-show-entry))
    	(beginning-of-line)
    	(setf (buffer-substring
    	       (line-beginning-position) (line-end-position)) "")))
    
         ;; tables
         ((org-at-table-p)
          (if (-any?
    	   (lambda (x) (not (string= "" x)))
    	   (nth
    	    (- (org-table-current-dline) 1)
    	    (org-table-to-lisp)))
    	  (org-return)
    	;; empty row
    	(beginning-of-line)
    	(setf (buffer-substring
    	       (line-beginning-position) (line-end-position)) "")
    	(org-return)))
    
         ;; fall-through case
         (t
          (org-return)))))
    
    
    (define-key org-mode-map (kbd "RET")
      'scimax/org-return)


### Insert blank lines

from [unpackaged.el](https://github.com/alphapapa/unpackaged.el#ensure-blank-lines-between-headings-and-before-contents).

    ;;;###autoload
    (defun unpackaged/org-fix-blank-lines (&optional prefix)
      "Ensure that blank lines exist between headings and between headings and their contents.
    With prefix, operate on whole buffer. Ensures that blank lines
    exist after each headings's drawers."
      (interactive "P")
      (org-map-entries (lambda ()
    		     (org-with-wide-buffer
    		      ;; `org-map-entries' narrows the buffer, which prevents us
    		      ;; from seeing newlines before the current heading, so we
    		      ;; do this part widened.
    		      (while (not (looking-back "\n\n" nil))
    			;; Insert blank lines before heading.
    			(insert "\n")))
    		     (let ((end (org-entry-end-position)))
    		       ;; Insert blank lines before entry content
    		       (forward-line)
    		       (while (and (org-at-planning-p)
    				   (< (point) (point-max)))
    			 ;; Skip planning lines
    			 (forward-line))
    		       (while (re-search-forward org-drawer-regexp end t)
    			 ;; Skip drawers. You might think that `org-at-drawer-p'
    			 ;; would suffice, but for some reason it doesn't work
    			 ;; correctly when operating on hidden text.  This
    			 ;; works, taken from `org-agenda-get-some-entry-text'.
    			 (re-search-forward "^[ \t]*:END:.*\n?" end t)
    			 (goto-char (match-end 0)))
    		       (unless (or (= (point) (point-max))
    				   (org-at-heading-p)
    				   (looking-at-p "\n"))
    			 (insert "\n"))))
    		   t (if prefix
    			 nil
    		       'tree)))

1.  Add a before-save-hook

        (defun cribbed/org-mode-fix-blank-lines ()
          (when (eq major-mode 'org-mode)
            (let ((current-prefix-arg 4)) ; Emulate C-u
              (call-interactively 'unpackaged/org-fix-blank-lines))))
        
        (add-hook 'before-save-hook #'cribbed/org-mode-fix-blank-lines)


## Elpher

    (use-package elpher
      :straight (elpher
    	     :repo "git://thelambdalab.xyz/elpher.git"
    	     :branch "patch_multiple_buffers")
    
      :custom
      (elpher-ipv4-always t)
    
      :custom-face
      (elpher-gemini-heading1
       ((t (:inherit (modus-theme-heading-1)))))
      (elpher-gemini-heading2
       ((t (:inherit (modus-theme-heading-2)))))
      (elpher-gemini-heading3
       ((t (:inherit (modus-theme-heading-3)))))
    
      :config
      (defun elpher:eww-browse-url (original url &optional new-window)
        "Handle gemini/gopher links with eww."
        (cond ((string-match-p "\\`\\(gemini\\|gopher\\)://" url)
    	   (require 'elpher)
    	   (elpher-go url))
    	  (t (funcall original url new-window))))
      (advice-add 'eww-browse-url :around 'elpher:eww-browse-url)
    
      :bind (:map elpher-mode-map
    	      ("n" . elpher-next-link)
    	      ("p" . elpher-prev-link)
    	      ("o" . elpher-follow-current-link)
    	      ("G" . elpher-go-current))
    
      :hook
      (elpher-mode-hook . visual-fill-column-mode))


### Gemini mode

    (use-package gemini-mode
      :straight (gemini-mode
    	     :repo "https://git.carcosa.net/jmcbray/gemini.el.git")
    
      :mode "\\.\\(gemini|gmi\\)\\'"
    
      :custom-face
      (gemini-heading-face-1
       ((t (:inherit (elpher-gemini-heading1)))))
      (gemini-heading-face2
       ((t (:inherit (elpher-gemini-heading2)))))
      (gemini-heading-face3
       ((t (:inherit (elpher-gemini-heading3)))))
    
      :init
      (defun acdw/setup-gemini-mode ()
        (visual-fill-column-mode 1)
        (variable-pitch-mode -1))
    
      :hook
      (gemini-mode-hook . acdw/setup-gemini-mode))


### Gemini write

    (use-package gemini-write
      :straight (gemini-write
    	     :repo "https://alexschroeder.ch/cgit/gemini-write"))


### Ox-gemini

    (use-package ox-gemini
      :straight (ox-gemini
    	     :repo "https://git.sr.ht/~abrahms/ox-gemini"
    	     :branch "main"))


## Pastebin

    (straight-use-package '0x0)
    
    (cuss 0x0-default-service 'ttm)


## RSS

    (use-package newsticker
      :custom
      (newsticker-url-list
       ;; LABEL URL [START-TIME] [INERVAL] [WGET-ARGUMENTS]
       '(("wsinatra" "http://lambdacreate.com/static/feed.rss")
         ("elioat" "https://eli.li/feed.rss")
         ("ACDW" "https://www.acdw.net/atom.xml")
         ("june" "https://text.causal.agency/feed.atom")
         ("kylie - notes" "https://www.somas.is/notes.atom")
         ("kylie - rhizome" "https://www.somas.is/rhizome.atom")
         ("brennan" "https://p1k3.com/all.xml")
         ("Planet Emacs" "https://planet.emacslife.com/atom.xml") 
         ("nullprogram, Chris Wellons" "https://nullprogram.com/feed/")
         ("Malleable Systems" "https://malleable.systems/blog/index.xml"))
       )
      :hook
      (newsticker-treeview-item-mode-hook . visual-fill-column-mode))


## Web browsing


### Open youtube links in mpv

from [karthinks](https://karthinks.com/software/more-batteries-included-with-emacs/#regexp-builder--m-x-re-builder).

    (require 'browse-url)
    
    (when (executable-find "mpv")
      (defun browse-url-mpv (url &optional single)
        (start-process "mpv" nil (if single "mpv" "umpv")
    		   (shell-quote-wildcard-pattern url)))
    
      (defun browse-url-at-point-mpv (&optional single)
        "Open a link in mpv."
        (interactive "P")
        (let ((browse-url-browser-function
    	   (if single
    	       (lambda
    		 (url &optional _new-window)
    		 (browse-url-mpv url t))
    	     #'browse-url-mpv)))
          (browse-url-at-point)))
    
      (cuss browse-url-browser-function
    	'(("https?:\\/\\/www\\.youtu\\.*be." . browse-url-mpv)
    	  ("." . browse-url-generic))))


## Reading e-books

    (use-package nov
      :mode ("\\.epub\\'" . nov-mode)
      :init
      (defun acdw/setup-nov-mode ()
        (visual-line-mode +1)
        (visual-fill-column-mode +1)
        (variable-pitch-mode +1)
        (setq cursor-type nil))
      :config
      (cuss nov-text-width t)
      :hook
      (nov-mode-hook . acdw/setup-nov-mode))


## Eshell

    (when (executable-find "bash")
      (straight-use-package 'bash-completion))
    
    (when (executable-find "fish")
      (straight-use-package 'fish-completion)
      (require 'fish-completion)
      (cuss fish-completion-fallback-on-bash-p (executable-find "bash"))
      (global-fish-completion-mode +1)
    
      (straight-use-package 'fish-mode)
      (add-to-list 'auto-mode-alist '("\\.fish\\'" . fish-mode)))


# Appendices


## Emacs' files


### init.el

    ;; init.el -*- lexical-binding: t -*-

1.  Speed up init

        (setq gc-cons-threshold most-positive-fixnum)
        (defvar old-file-name-handler file-name-handler-alist)
        (setq file-name-handler-alist nil)

2.  Load config

    inspired by [Protesilaos Stavrou](https://protesilaos.com/dotemacs/#h:584c3604-55a1-49d0-9c31-abe46cb1f028).
    
        (let* ((conf (expand-file-name "config"
        			       user-emacs-directory))
               (conf-el (concat conf ".el"))
               (conf-org (concat conf ".org")))
          (unless (and (file-newer-than-file-p conf-el conf-org)
        	       (load conf 'no-error))
            (require 'org)
            (org-babel-load-file conf-org)))

3.  Reset for normal operation

        (setq gc-cons-threshold 16777216 ; 16mb
              gc-cons-percentage 0.1
              file-name-handler-alist old-file-name-handler)


### early-init.el

    ;; early-init.el -*- lexical-binding: t; no-byte-compile: t; -*-
    
    (setq load-prefer-newer t)
    (setq frame-inhibit-implied-resize t)


## Ease tangling and loading of Emacs' init

    (defun refresh-emacs (&optional disable-load)
      "Tangle `config.org', then byte-compile the resulting files.
    Then, load the byte-compilations unless passed with a prefix argument."
      (interactive "P")
      (let ((config (expand-file-name "config.org" user-emacs-directory)))
        (save-mark-and-excursion
          (with-current-buffer (find-file config)
    	(let ((prog-mode-hook nil))
    	  ;; generate the readme
    	  (when (file-newer-than-file-p config (expand-file-name
    						"README.md"
    						user-emacs-directory))
    	    (require 'ox-md)
    	    (org-md-export-to-markdown))
    	  ;; tangle config.org
    	  (when (file-newer-than-file-p config (expand-file-name
    						"config.el"
    						user-emacs-directory))
    	    (require 'org)
    	    (let ((inits (org-babel-tangle)))
    	      ;; byte-compile resulting files
    	      (dolist (f inits)
    		(when (string-match "\\.el\\'" f)
    		  (byte-compile-file f (not disable-load)))))))))))


### Add a hook to tangle when quitting

    (defun acdw/refresh-emacs-no-load ()
      (refresh-emacs 'disable-load))
    
    (add-hook 'kill-emacs-hook #'acdw/refresh-emacs-no-load)


## Ancillary scripts


### emacsdc

Here’s a wrapper script that’ll start `emacs –daemon` if there isn’t one, and then launch `emacsclient` with the arguments.  I’d recommend installing with either `ln -s bin/emacsdc $HOME/.local/bin/`, or adding `$HOME/.local/bin` to your `$PATH`.

    if ! emacsclient -nc "$@" 2>/dev/null; then
        emacs --daemon
        emacsclient -nc "$@"
    fi


## License

Copyright © 2020 Case Duckworth <acdw@acdw.net>

This work is free.  You can redistribute it and/or modify it under the
terms of the Do What the Fuck You Want To Public License, Version 2,
as published by Sam Hocevar.  See the `LICENSE` file, tangled from the
following source block, for details.

    DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
    
    Version 2, December 2004
    
    Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
    
    Everyone is permitted to copy and distribute verbatim or modified copies of
    this license document, and changing it is allowed as long as the name is changed.
    
    DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
    
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
    
       0. You just DO WHAT THE FUCK YOU WANT TO.


### Note on the license

It's highly likely that the WTFPL is completely incompatible with the
GPL, for what should be fairly obvious reasons.  To that, I say:

**SUE ME, RMS!**