1 #+title: =aminb='s Literate Emacs Configuration
4 #+property: header-args :tangle yes
11 This org file is my literate configuration for GNU Emacs, and is
12 tangled to [[./init.el][init.el]]. Packages are installed and managed using
13 [[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of
14 many different people. Some of the configurations that I can remember
15 off the top of my head are:
17 - [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses
18 straight.el for managing packages
19 - [[https://github.com/dakra/dmacs][dakra/dmacs]]: literate Emacs configuration, using Borg for managing
21 - [[http://pages.sachachua.com/.emacs.d/Sacha.html][Sacha Chua's literate Emacs configuration]]
22 - [[https://github.com/dakrone/eos][dakrone/eos]]
23 - Ryan Rix's [[http://doc.rix.si/cce/cce.html][Complete Computing Environment]] ([[http://doc.rix.si/projects/fsem.html][about cce]])
24 - [[https://github.com/jwiegley/dot-emacs][jwiegley/dot-emacs]]: nix-based configuration
25 - [[https://github.com/wasamasa/dotemacs][wasamasa/dotemacs]]
26 - [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
28 I'd like to have a fully reproducible Emacs setup (part of the reason
29 why I store my configuration in this repository) but unfortunately out
30 of the box, that's not achievable with =package.el=, not currently
31 anyway. So, I've opted to use Borg. For what it's worth, I briefly
32 experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds
33 to my init time; which is unacceptable for me: I use Emacs as my
34 window manager (via EXWM) and coming from bspwm, I'm too used to
35 having fast startup times.
39 To use this config for your Emacs, first you need to clone this repo,
40 then bootstrap Borg, tell Borg to retrieve package submodules, and
41 byte-compiled the packages. Something along these lines should work:
43 #+begin_src sh :tangle no
44 git clone https://github.com/aminb/dotfiles ~/.emacs.d
52 * Contents :toc_1:noexport:
56 - [[#initial-setup][Initial setup]]
58 - [[#post-initialization][Post initialization]]
68 #+begin_src emacs-lisp :comments none
69 ;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
72 Enable =view-mode=, which both makes the file read-only (as a reminder
73 that =init.el= is an auto-generated file, not supposed to be edited),
74 and provides some convenient key bindings for browsing through the
79 #+begin_src emacs-lisp :comments none
80 ;; Copyright (C) 2018 Amin Bandali <amin@aminb.org>
82 ;; This program is free software: you can redistribute it and/or modify
83 ;; it under the terms of the GNU General Public License as published by
84 ;; the Free Software Foundation, either version 3 of the License, or
85 ;; (at your option) any later version.
87 ;; This program is distributed in the hope that it will be useful,
88 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
89 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
90 ;; GNU General Public License for more details.
92 ;; You should have received a copy of the GNU General Public License
93 ;; along with this program. If not, see <https://www.gnu.org/licenses/>.
98 #+begin_src emacs-lisp :comments none
101 ;; Emacs configuration of Amin Bandali, computer scientist and functional
104 ;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
107 ** Naming conventions
109 The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found
110 [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=.
112 #+begin_src emacs-lisp :comments none
113 ;; Naming conventions:
115 ;; ab-... public variables or non-interactive functions
116 ;; ab--... private anything (non-interactive), not safe for direct use
117 ;; ab/... an interactive function; safe for M-x or keybinding
118 ;; ab:... an evil operator, motion, or command
119 ;; ab|... a hook function
120 ;; ab*... an advising function
121 ;; ab@... a hydra command
127 :CUSTOM_ID: initial-setup
130 #+begin_src emacs-lisp :comments none
134 ** Emacs initialization
136 I'd like to do a couple of measurements of Emacs' startup time. First,
137 let's see how long Emacs takes to start up, before even loading
138 =init.el=, i.e. =user-init-file=:
140 #+begin_src emacs-lisp
141 (defvar ab--before-user-init-time (current-time)
142 "Value of `current-time' when Emacs begins loading `user-init-file'.")
143 (message "Loading Emacs...done (%.3fs)"
144 (float-time (time-subtract ab--before-user-init-time
148 Also, temporarily increase ~gc-cons-threshhold~ and
149 ~gc-cons-percentage~ during startup to reduce garbage collection
150 frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
151 startup time as well.
153 #+begin_src emacs-lisp
154 (defvar ab--gc-cons-threshold gc-cons-threshold)
155 (defvar ab--gc-cons-percentage gc-cons-percentage)
156 (defvar ab--file-name-handler-alist file-name-handler-alist)
157 (setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB
158 gc-cons-percentage 0.6
159 file-name-handler-alist nil
160 ;; sidesteps a bug when profiling with esup
161 esup-child-profile-require-level 0)
164 Of course, we'd like to set them back to their defaults once we're
167 #+begin_src emacs-lisp
171 (setq gc-cons-threshold ab--gc-cons-threshold
172 gc-cons-percentage ab--gc-cons-percentage
173 file-name-handler-alist ab--file-name-handler-alist)))
176 Increase the number of lines kept in message logs (the =*Messages*=
179 #+begin_src emacs-lisp
180 (setq message-log-max 20000)
183 Optionally, we could suppress some byte compiler warnings like below,
184 but for now I've decided to keep them enabled. See documentation for
185 ~byte-compile-warnings~ for more details.
187 #+begin_src emacs-lisp
188 ;; (setq byte-compile-warnings
189 ;; '(not free-vars unresolved noruntime lexical make-local))
192 ** Package management
196 I can do all my package management things with Borg, and don't need
197 Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
198 the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
200 #+begin_src emacs-lisp :tangle early-init.el
201 (setq package-enable-at-startup nil)
204 But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
205 right now), and even when released it'll be long before most distros
206 ship in their repos, I'll still put the old workaround with the
207 commented call to ~package-initialize~ here anyway.
209 #+begin_src emacs-lisp
210 (setq package-enable-at-startup nil)
211 ;; (package-initialize)
217 Assimilate Emacs packages as Git submodules
220 [[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
221 short, it creates a git submodule in =lib/= for each package, which
222 can then be managed with the help of Magit or other tools.
224 #+begin_src emacs-lisp
225 (setq user-init-file (or load-file-name buffer-file-name)
226 user-emacs-directory (file-name-directory user-init-file))
227 (add-to-list 'load-path
228 (expand-file-name "lib/borg" user-emacs-directory))
236 A use-package declaration for simplifying your .emacs
239 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
240 packages (in our case especially the latter) in a neatly organized way
241 and without compromising on performance.
243 #+begin_src emacs-lisp
244 (require 'use-package)
245 (if nil ; set to t when need to debug init
246 (setq use-package-verbose t
247 use-package-expand-minimally nil
248 use-package-compute-statistics t
250 (setq use-package-verbose nil
251 use-package-expand-minimally t))
257 Browse the Emacsmirror package database
260 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
261 database, low-level functions for querying the database, and a
262 =package.el=-like user interface for browsing the available packages.
264 #+begin_src emacs-lisp
269 ** No littering in =~/.emacs.d=
272 Help keeping ~/.emacs.d clean
275 By default, even for Emacs' built-in packages, the configuration files
276 and persistent data are all over the place. Use =no-littering= to help
279 #+begin_src emacs-lisp
280 (use-package no-littering
284 (add-to-list 'savehist-additional-variables 'kill-ring)
286 (setq auto-save-file-name-transforms
287 `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
290 ** Custom file (=custom.el=)
292 I'm not planning on using the custom file much, but even so, I
293 definitely don't want it mixing with =init.el=. So, here; let's give
294 it it's own file. While at it, treat themes as safe.
296 #+begin_src emacs-lisp
300 (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
301 (when (file-exists-p custom-file)
303 (setf custom-safe-themes t))
306 ** Better =$PATH= handling
308 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
311 #+begin_src emacs-lisp
312 (use-package exec-path-from-shell
315 (setq exec-path-from-shell-check-startup-files nil)
317 (exec-path-from-shell-initialize)
318 ;; while we're at it, let's fix access to our running ssh-agent
319 (exec-path-from-shell-copy-env "SSH_AGENT_PID")
320 (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
325 Start server if not already running. Alternatively, can be done by
326 issuing =emacs --daemon= in the terminal, which can be automated with
327 a systemd service or using =brew services start emacs= on macOS. I use
328 Emacs as my window manager (via EXWM), so I always start Emacs on
329 login; so starting the server from inside Emacs is good enough for me.
331 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
333 #+begin_src emacs-lisp
335 :config (or (server-running-p) (server-mode)))
340 Font stack with better unicode support, around =Ubuntu Mono= and
343 #+begin_src emacs-lisp
344 (dolist (ft (fontset-list))
348 (font-spec :name "Ubuntu Mono"))
352 (font-spec :name "DejaVu Sans Mono")
359 ;; :name "Symbola monospacified for DejaVu Sans Mono")
365 ;; (font-spec :name "DejaVu Sans Mono")
371 (font-spec :name "DejaVu Sans Mono" :size 14)
383 *** Time and battery in mode-line
385 Enable displaying time and battery in the mode-line, since I'm not
386 using the Xfce panel anymore. Also, I don't need to see the load
387 average on a regular basis, so disable that.
389 #+begin_src emacs-lisp
393 (setq display-time-default-load-average nil)
400 (display-battery-mode))
405 Might want to set the fringe to a smaller value, especially if using
406 EXWM. I'm fine with the default for now.
408 #+begin_src emacs-lisp
409 ;; (fringe-mode '(3 . 1))
413 *** Disable disabled commands
415 Emacs disables some commands by default that could persumably be
416 confusing for novice users. Let's disable that.
418 #+begin_src emacs-lisp
419 (setq disabled-command-function nil)
424 Save what I copy into clipboard from other applications into Emacs'
425 kill-ring, which would allow me to still be able to easily access it
426 in case I kill (cut or copy) something else inside Emacs before
427 yanking (pasting) what I'd originally intended to.
429 #+begin_src emacs-lisp
430 (setq save-interprogram-paste-before-kill t)
435 #+begin_src emacs-lisp
436 (setq enable-recursive-minibuffers t
437 resize-mini-windows t)
440 *** Lazy-person-friendly yes/no prompts
442 Lazy people would prefer to type fewer keystrokes, especially for yes
443 or no questions. I'm lazy.
445 #+begin_src emacs-lisp
446 (defalias 'yes-or-no-p #'y-or-n-p)
449 *** Startup screen and =*scratch*=
451 Firstly, let Emacs know that I'd like to have =*scratch*= as my
454 #+begin_src emacs-lisp
455 (setq initial-buffer-choice t)
458 Now let's customize the =*scratch*= buffer a bit. First off, I don't
459 need the default hint.
461 #+begin_src emacs-lisp
462 (setq initial-scratch-message nil)
465 Also, let's use Text mode as the major mode, in case I want to
466 customize it (=*scratch*='s default major mode, Fundamental mode,
467 can't really be customized).
469 #+begin_src emacs-lisp
470 (setq initial-major-mode 'text-mode)
473 Inhibit the buffer list when more than 2 files are loaded.
475 #+begin_src emacs-lisp
476 (setq inhibit-startup-buffer-menu t)
479 I don't really need to see the startup screen or echo area message
482 #+begin_src emacs-lisp
483 (advice-add #'display-startup-echo-area-message :override #'ignore)
484 (setq inhibit-startup-screen t
485 inhibit-startup-echo-area-message user-login-name)
488 *** More useful frame titles
490 Show either the file name or the buffer name (in case the buffer isn't
491 visiting a file). Borrowed from Emacs Prelude.
493 #+begin_src emacs-lisp
494 (setq frame-title-format
495 '("" invocation-name " - "
496 (:eval (if (buffer-file-name)
497 (abbreviate-file-name (buffer-file-name))
503 Emacs' default backup settings aren't that great. Let's use more
504 sensible options. See documentation for the ~make-backup-file~
507 #+begin_src emacs-lisp
508 (setq backup-by-copying t
514 The packages in this section are absolutely essential to my everyday
515 workflow, and they play key roles in how I do my computing. They
516 immensely enhance the Emacs experience for me; both using Emacs, and
519 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
521 #+begin_src emacs-lisp
522 (use-package auto-compile
525 (auto-compile-on-load-mode)
526 (auto-compile-on-save-mode)
527 (setq auto-compile-display-buffer nil
528 auto-compile-mode-line-counter t
529 auto-compile-source-recreate-deletes-dest t
530 auto-compile-toggle-deletes-nonlib-dest t
531 auto-compile-update-autoloads t)
532 (add-hook 'auto-compile-inhibit-compile-hook
533 'auto-compile-inhibit-compile-detached-git-head))
536 *** TODO [[https://github.com/Kungsgeten/ryo-modal][ryo-modal]]
539 Roll your own modal mode
542 *** [[https://github.com/ch11ng/exwm][EXWM]] (window manager)
544 #+begin_src emacs-lisp :tangle no
548 (require 'exwm-config)
550 ;; Set the initial workspace number.
551 (setq exwm-workspace-number 4)
553 ;; Make class name the buffer name, truncating beyond 50 characters
554 (defun exwm-rename-buffer ()
556 (exwm-workspace-rename-buffer
557 (concat exwm-class-name ":"
558 (if (<= (length exwm-title) 50) exwm-title
559 (concat (substring exwm-title 0 49) "...")))))
560 (add-hook 'exwm-update-class-hook 'exwm-rename-buffer)
561 (add-hook 'exwm-update-title-hook 'exwm-rename-buffer)
564 (exwm-input-set-key (kbd "s-R") #'exwm-reset)
565 ;; 's-\': Switch workspace
566 (exwm-input-set-key (kbd "s-\\") #'exwm-workspace-switch)
567 ;; 's-N': Switch to certain workspace
569 (exwm-input-set-key (kbd (format "s-%d" i))
572 (exwm-workspace-switch-create i))))
573 ;; 's-SPC': Launch application
574 ;; (exwm-input-set-key
577 ;; (interactive (list (read-shell-command "➜ ")))
578 ;; (start-process-shell-command command nil command)))
580 (exwm-input-set-key (kbd "M-s-SPC") #'counsel-linux-app)
582 ;; Shorten 'C-c C-q' to 'C-q'
583 (define-key exwm-mode-map [?\C-q] #'exwm-input-send-next-key)
585 ;; Line-editing shortcuts
586 (setq exwm-input-simulation-keys
591 ([?\M-f] . [C-right])
599 ([?\C-k] . [S-end delete])
601 ;; ([?\C-w] . [?\C-x])
605 ([?\C-s] . [?\C-f])))
610 (add-hook 'exwm-init-hook #'exwm-config--fix/ido-buffer-window-other-frame)
612 (require 'exwm-systemtray)
613 (exwm-systemtray-enable)
615 (require 'exwm-randr)
618 ;; (exwm-input-set-key
619 ;; (kbd "s-<return>")
622 ;; (start-process "urxvt" nil "urxvt")))
624 ;; (exwm-input-set-key
625 ;; (kbd "s-SPC") ;; rofi doesn't properly launch programs when started from emacs
628 ;; (start-process-shell-command "rofi-run" nil "rofi -show run -display-run '> ' -display-window ' 🗔 '")))
630 ;; (exwm-input-set-key
634 ;; (start-process-shell-command "rofi-win" nil "rofi -show window -display-run '> ' -display-window ' 🗔 '")))
636 ;; (exwm-input-set-key
640 ;; (start-process "rofi-pass" nil "rofi-pass")))
642 ;; (exwm-input-set-key
643 ;; (kbd "<XF86AudioMute>")
646 ;; (start-process-shell-command "pamixer" nil "pamixer --toggle-mute")))
648 ;; (exwm-input-set-key
649 ;; (kbd "<XF86AudioLowerVolume>")
652 ;; (start-process-shell-command "pamixer" nil "pamixer --allow-boost --decrease 5")))
654 ;; (exwm-input-set-key
655 ;; (kbd "<XF86AudioRaiseVolume>")
658 ;; (start-process-shell-command "pamixer" nil "pamixer --allow-boost --increase 5")))
660 ;; (exwm-input-set-key
661 ;; (kbd "<XF86AudioPlay>")
664 ;; (start-process-shell-command "mpc" nil "mpc toggle")))
666 ;; (exwm-input-set-key
667 ;; (kbd "<XF86AudioPrev>")
670 ;; (start-process-shell-command "mpc" nil "mpc prev")))
672 ;; (exwm-input-set-key
673 ;; (kbd "<XF86AudioNext>")
676 ;; (start-process-shell-command "mpc" nil "mpv next")))
678 (defun ab--exwm-pasystray ()
679 "A command used to start pasystray."
681 (if (executable-find "pasystray")
683 (message "EXWM: starting pasystray ...")
684 (start-process-shell-command "pasystray" nil "pasystray --notify=all"))
685 (message "EXWM: pasystray is not installed, abort!")))
687 (add-hook 'exwm-init-hook #'ab--exwm-pasystray)
693 (exwm-floating-toggle-floating)))
699 (exwm-layout-toggle-fullscreen)))
705 (kill-buffer (current-buffer))))
711 (exwm-manage--kill-client))))
716 :header-args+: :tangle ~/.config/sxhkd/sxhkdrc :mkdirp yes
719 #+begin_src conf :tangle no
726 rofi -show run -display-run '> ' -display-window ' 🗔 '
730 rofi -show window -display-run '> ' -display-window ' 🗔 '
736 # make sxhkd reload its configuration files:
741 XF86Audio{Raise,Lower}Volume
742 pamixer --allow-boost --{in,de}crease 5
746 pamixer --toggle-mute
749 XF86Audio{Play,Prev,Next}
750 mpc {toggle,prev,next}
752 # Toggle keyboard layout
756 # Toggle Xfce presentation mode
758 # toggle-presentation-mode
761 XF86MonBrightness{Up,Down}
768 *** [[https://orgmode.org/][Org mode]]
771 Org mode is for keeping notes, maintaining TODO lists, planning
772 projects, and authoring documents with a fast and effective plain-text
776 In short, my favourite way of life.
778 #+begin_src emacs-lisp
779 (setq org-src-tab-acts-natively t
780 org-src-preserve-indentation nil
781 org-edit-src-content-indentation 0)
784 *** [[https://magit.vc/][Magit]]
787 It's Magit! A Git porcelain inside Emacs.
790 Not just how I do git, but /the/ way to do git.
792 #+begin_src emacs-lisp
795 :bind (("s-g" . magit-status)
796 ("C-x g" . magit-status)
797 ("C-x M-g" . magit-dispatch-popup))
799 (magit-add-section-hook 'magit-status-sections-hook
800 'magit-insert-modules
801 'magit-insert-stashes
805 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
808 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
809 an overview, and more. Oh, man!
812 There's no way I could top that, so I won't attempt to.
816 #+begin_src emacs-lisp
819 (:map ivy-minibuffer-map
820 ([escape] . keyboard-escape-quit)
821 ;; ("C-j" . ivy-next-line)
822 ;; ("C-k" . ivy-previous-line)
823 ([S-up] . ivy-previous-history-element)
824 ([S-down] . ivy-next-history-element)
825 ("DEL" . ivy-backward-delete-char))
833 #+begin_src emacs-lisp
835 :bind (([remap isearch-forward] . swiper)
836 ([remap isearch-backward] . swiper)))
841 #+begin_src emacs-lisp
844 :bind (([remap execute-extended-command] . counsel-M-x)
845 ([remap find-file] . counsel-find-file)
846 ("s-r" . counsel-recentf)
847 :map minibuffer-local-map
848 ("C-r" . counsel-minibuffer-history))
851 (defalias 'locate #'counsel-locate))
854 * Borg's =layer/essentials=
856 TODO: break this giant source block down into individual org sections.
858 #+begin_src emacs-lisp
860 :config (dash-enable-font-lock))
864 (setq diff-hl-draw-borders nil)
865 (global-diff-hl-mode)
866 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
870 :config (setq dired-listing-switches "-alh"))
873 :when (version< "25" emacs-version)
874 :config (global-eldoc-mode))
878 :config (temp-buffer-resize-mode))
881 (setq isearch-allow-scroll t))
883 (use-package lisp-mode
885 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
886 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
887 (defun indent-spaces-mode ()
888 (setq indent-tabs-mode nil))
889 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
893 :config (setq Man-width 80))
896 :config (show-paren-mode))
898 (use-package prog-mode
899 :config (global-prettify-symbols-mode)
900 (defun indicate-buffer-boundaries-left ()
901 (setq indicate-buffer-boundaries 'left))
902 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
906 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
908 (use-package savehist
909 :config (savehist-mode))
911 (use-package saveplace
912 :when (version< "25" emacs-version)
913 :config (save-place-mode))
916 :config (column-number-mode))
919 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
924 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
925 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
926 (add-to-list 'tramp-default-proxies-alist
927 (list (regexp-quote (system-name)) nil nil)))
929 (use-package undo-tree
931 (global-undo-tree-mode)
932 (setq undo-tree-mode-lighter ""))
939 #+begin_src emacs-lisp
940 (use-package lean-mode
941 :bind (:map lean-mode-map
942 ("S-SPC" . company-complete)))
945 * Post initialization
947 :CUSTOM_ID: post-initialization
950 Display how long it took to load the init file.
952 #+begin_src emacs-lisp
953 (message "Loading %s...done (%.3fs)" user-init-file
954 (float-time (time-subtract (current-time)
955 ab--before-user-init-time)))
963 #+begin_src emacs-lisp :comments none
964 ;;; init.el ends here