]> git.armaanb.net Git - config.org.git/blob - config.org
xmodmap: conditionally tangle caps/control swap
[config.org.git] / config.org
1 #+TITLE: System Configuration
2 #+DESCRIPTION: Personal system configuration in org-mode format.
3 #+AUTHOR: Armaan Bhojwani
4 #+EMAIL: me@armaanb.net
5
6 * Welcome
7 Welcome to my system configuration! This file contains my Emacs configuration, but also my config files for many of the other programs on my system!
8 ** Compatability
9 I am currently using Emacs 28 with native compilation, so some settings and packages may not be available for older versions of Emacs. This is a purely personal configuration, so while I can guarantee that it works on my setup, it might not work for you.
10 ** Choices
11 I chose to create a powerful, yet not overly heavy Emacs configuration. Things like a fancy modeline, icons, or LSP mode do not increase my productivity, and create visual clutter, and thus have been excluded.
12
13 Another important choice has been to integrate Emacs into a large part of my computing environment (see [[*Emacs OS]]). I use email, IRC, RSS, et cetera, all through Emacs which simplifies my workflow and creates an amazingly integrated environment.
14
15 Lastly, I use Evil mode. Modal keybindings are simpler and more ergonomic than standard Emacs style, and Vim keybindings are what I'm comfortable with and are pervasive throughout computing.
16 ** License
17 Released under the [[https://opensource.org/licenses/MIT][MIT license]] by Armaan Bhojwani, 2021. Note that many snippets are taken from online, and other sources, who are credited for their work near their contributions.
18 * Package management
19 ** Bootstrap straight.el
20 straight.el is really nice for managing package, and it integrates nicely with use-package. It uses the bootstrapping system defined here for installation.
21 #+begin_src emacs-lisp
22   (defvar native-comp-deferred-compilation-deny-list ())
23   (defvar bootstrap-version)
24   (let ((bootstrap-file
25          (expand-file-name "straight/repos/straight.el/bootstrap.el" user-emacs-directory))
26         (bootstrap-version 5))
27     (unless (file-exists-p bootstrap-file)
28       (with-current-buffer
29           (url-retrieve-synchronously
30            "https://raw.githubusercontent.com/raxod502/straight.el/develop/install.el"
31            'silent 'inhibit-cookies)
32         (goto-char (point-max))
33         (eval-print-last-sexp)))
34     (load bootstrap-file nil 'nomessage))
35 #+end_src
36 ** Replace package.el with straight
37 #+begin_src emacs-lisp
38   (straight-use-package 'use-package)
39   (setq straight-use-package-by-default t)
40 #+end_src
41 * Visual options
42 ** Theme
43 Use the Modus Operandi theme by Protesilaos Stavrou. Its the best theme for Emacs by far, because how clear and readable it is. It is highly customizable, but I just set a few options here.
44 #+begin_src emacs-lisp
45   (use-package modus-themes
46     :custom
47     (modus-themes-slanted-constructs t)
48     (modus-themes-bold-constructs t)
49     (modus-themes-mode-line '3d)
50     (modus-themes-scale-headings t)
51     (modus-themes-diffs 'desaturated)
52     :config (load-theme 'modus-vivendi t))
53 #+end_src
54 ** Typography
55 *** Font
56 JetBrains Mono is a great programming font with ligatures. The "NF" means that it has been patched with the [[https://www.nerdfonts.com/][Nerd Fonts]].
57 #+begin_src emacs-lisp
58   (add-to-list 'default-frame-alist '(font . "JetBrainsMonoNF-12"))
59 #+end_src
60 *** Ligatures
61 #+begin_src emacs-lisp
62   (use-package ligature
63     :straight (ligature :type git :host github :repo "mickeynp/ligature.el")
64     :config
65     (ligature-set-ligatures
66      '(prog-mode text-mode)
67      '("-|" "-~" "---" "-<<" "-<" "--" "->" "->>" "-->" "/=" "/=="
68        "/>" "//" "/*" "*>" "*/" "<-" "<<-" "<=>" "<=" "<|" "<||"
69        "<|||" "<|>" "<:" "<>" "<-<" "<<<" "<==" "<<=" "<=<" "<==>"
70        "<-|" "<<" "<~>" "<=|" "<~~" "<~" "<$>" "<$" "<+>" "<+" "</>"
71        "</" "<*" "<*>" "<->" "<!--" ":>" ":<" ":::" "::" ":?" ":?>"
72        ":=" "::=" "=>>" "==>" "=/=" "=!=" "=>" "===" "=:=" "==" "!=="
73        "!!" "!=" ">]" ">:" ">>-" ">>=" ">=>" ">>>" ">-" ">=" "&&&"
74        "&&" "|||>" "||>" "|>" "|]" "|}" "|=>" "|->" "|=" "||-" "|-"
75        "||=" "||" ".." ".?" ".=" ".-" "..<" "..." "+++" "+>" "++"
76        "[||]" "[<" "[|" "{|" "?." "?=" "?:" "##" "###" "####" "#["
77        "#{" "#=" "#!" "#:" "#_(" "#_" "#?" "#(" ";;" "_|_" "__" "~~"
78        "~~>" "~>" "~-" "~@" "$>" "^=" "]#"))
79     (global-ligature-mode t))
80 #+end_src
81 ** Line numbers
82 Display relative line numbers except in certain modes.
83 #+begin_src emacs-lisp
84   (global-display-line-numbers-mode)
85   (setq display-line-numbers-type 'relative)
86   (dolist (no-line-num '(term-mode-hook
87                          pdf-view-mode-hook
88                          shell-mode-hook
89                          org-mode-hook
90                          circe-mode-hook
91                          eshell-mode-hook))
92     (add-hook no-line-num (lambda () (display-line-numbers-mode 0))))
93 #+end_src
94 ** Highlight matching parenthesis
95 #+begin_src emacs-lisp
96   (use-package paren
97     :config (show-paren-mode)
98     :custom (show-paren-style 'parenthesis))
99 #+end_src
100 ** Modeline
101 *** Show current function
102 #+begin_src emacs-lisp
103   (which-function-mode)
104 #+end_src
105 *** Make position in file more descriptive
106 Show current column and file size.
107 #+begin_src emacs-lisp
108   (column-number-mode)
109   (size-indication-mode)
110 #+end_src
111 *** Hide minor modes
112 #+begin_src emacs-lisp
113   (use-package minions
114     :config (minions-mode))
115 #+end_src
116 ** Whitespace mode
117 Highlight whitespace and other bad text practices.
118 #+begin_src emacs-lisp
119   (use-package whitespace
120     :custom (whitespace-style '(face lines-tail)))
121   (dolist (hook '(prog-mode-hook))
122     (add-hook hook (lambda () (whitespace-mode 1))))
123 #+end_src
124 ** Highlight todo items in comments
125 +begin_src emacs-lisp
126   (use-package hl-todo
127     :straight (hl-todo :type git :host github :repo "tarsius/hl-todo")
128     :config (global-hl-todo-mode 1))
129 #+end_src
130 ** Blink cursor
131 #+begin_src emacs-lisp
132   (blink-cursor-mode)
133 #+end_src
134 ** Visual line mode
135 Soft wrap words and do operations by visual lines in some modes.
136 #+begin_src emacs-lisp
137   (dolist (hook '(text-mode-hook
138                   org-mode-hook
139                   markdown-mode-hook
140                   mu4e-view-mode-hook))
141     (add-hook hook (lambda () (visual-line-mode 1))))
142 #+end_src
143 ** Auto fill mode
144 #+begin_src emacs-lisp
145   (dolist (hook '(scdoc-mode-hook
146                   mu4e-compose-mode-hook))
147     (add-hook hook (lambda () (auto-fill-mode 1))))
148 #+end_src
149 ** Display number of matches in search
150 #+begin_src emacs-lisp
151   (use-package anzu
152     :config (global-anzu-mode)
153     :bind
154     ([remap query-replace] . anzu-query-replace)
155     ([remap query-replace-regexp] . anzu-query-replace-regexp))
156 #+end_src
157 *** TODO This config doesn't work right
158 ** Visual bell
159 Invert modeline color instead of audible bell or the standard visual bell.
160 #+begin_src emacs-lisp
161   (setq visible-bell nil
162         ring-bell-function
163         (lambda () (invert-face 'mode-line)
164           (run-with-timer 0.1 nil #'invert-face 'mode-line)))
165 #+end_src
166 * Evil mode
167 ** General
168 #+begin_src emacs-lisp
169   (use-package evil
170     :custom (select-enable-clipboard nil)
171     :config
172     (evil-mode)
173     (fset 'evil-visual-update-x-selection 'ignore) ;; Keep clipboard and register seperate
174     ;; Use visual line motions even outside of visual-line-mode buffers
175     (evil-global-set-key 'motion "j" 'evil-next-visual-line)
176     (evil-global-set-key 'motion "k" 'evil-previous-visual-line)
177     (global-set-key (kbd "<escape>") 'keyboard-escape-quit))
178 #+end_src
179 ** Evil collection
180 Evil bindings for tons of packages.
181 #+begin_src emacs-lisp
182   (use-package evil-collection
183     :after evil
184     :init (evil-collection-init)
185     :custom (evil-collection-setup-minibuffer t))
186 #+end_src
187 ** Surround
188 tpope prevails!
189 #+begin_src emacs-lisp
190   (use-package evil-surround
191     :config (global-evil-surround-mode))
192 #+end_src
193 ** Nerd commenter
194 Makes commenting super easy
195 #+begin_src emacs-lisp
196   (use-package evil-nerd-commenter
197     :bind (:map evil-normal-state-map
198                 ("gc" . evilnc-comment-or-uncomment-lines))
199     :custom (evilnc-invert-comment-line-by-line nil))
200 #+end_src
201 ** Undo redo
202 Fix the oopsies!
203 #+begin_src emacs-lisp
204   (evil-set-undo-system 'undo-redo)
205 #+end_src
206 ** Number incrementing
207 Add back C-a/C-x bindings.
208 #+begin_src emacs-lisp
209   (use-package evil-numbers
210     :straight (evil-numbers :type git :host github :repo "juliapath/evil-numbers")
211     :bind (:map evil-normal-state-map
212                 ("C-M-a" . evil-numbers/inc-at-pt)
213                 ("C-M-x" . evil-numbers/dec-at-pt)))
214 #+end_src
215 ** Evil org
216 #+begin_src emacs-lisp
217   (use-package evil-org
218     :after org
219     :hook (org-mode . evil-org-mode)
220     :config
221     (evil-org-set-key-theme '(textobjects insert navigation shift todo)))
222
223   (use-package evil-org-agenda
224     :straight (:type built-in)
225     :after evil-org
226     :config (evil-org-agenda-set-keys))
227 #+end_src
228 * Org mode
229 ** General
230 #+begin_src emacs-lisp
231   (use-package org
232     :straight (:type built-in)
233     :commands (org-capture org-agenda)
234     :custom
235     (org-ellipsis " ▾")
236     (org-agenda-start-with-log-mode t)
237     (org-agenda-files (quote ("~/Org/tasks.org" "~/Org/break.org")))
238     (org-log-done 'time)
239     (org-log-into-drawer t)
240     (org-src-tab-acts-natively t)
241     (org-src-fontify-natively t)
242     (org-startup-indented t)
243     (org-hide-emphasis-markers t)
244     (org-fontify-whole-block-delimiter-line nil)
245     (org-archive-default-command 'org-archive-to-archive-sibling)
246     :bind
247     ("C-c a" . org-agenda)
248     (:map evil-normal-state-map ("ga" . org-archive-subtree-default)))
249 #+end_src
250 ** Tempo
251 Define templates for lots of common structure elements. Mostly just used within this file.
252 #+begin_src emacs-lisp
253   (use-package org-tempo
254     :after org
255     :straight (:type built-in)
256     :config
257     (dolist (addition '(("el" . "src emacs-lisp")
258                         ("el" . "src emacs-lisp")
259                         ("sp" . "src conf :tangle ~/.spectrwm.conf")
260                         ("ash" . "src shell :tangle ~/.config/ash/ashrc")
261                         ("pi" . "src conf :tangle ~/.config/picom/picom.conf")
262                         ("git" . "src conf :tangle ~/.gitconfig")
263                         ("za" . "src conf :tangle ~/.config/zathura/zathurarc")
264                         ("xr" . "src conf :tangle ~/.Xresources")
265                         ("tm" . "src conf :tangle ~/.tmux.conf")
266                         ("gp" . "src conf :tangle ~/.gnupg/gpg.conf")
267                         ("ag" . "src conf :tangle ~/.gnupg/gpg-agent.conf")
268                         ("xm" . "src conf :tangle ~/.config/xmodmap")))
269       (add-to-list 'org-structure-template-alist addition)))
270 #+end_src
271 * Autocompletion
272 ** Ivy
273 A well balanced completion framework.
274 #+begin_src emacs-lisp
275   (use-package ivy
276     :bind (:map ivy-minibuffer-map
277            ("TAB" . ivy-alt-done))
278            (:map ivy-switch-buffer-map
279            ("M-d" . ivy-switch-buffer-kill))
280     :config (ivy-mode))
281 #+end_src
282 ** Ivy-rich
283 #+begin_src emacs-lisp
284   (use-package ivy-rich
285     :after (ivy counsel)
286     :config (ivy-rich-mode))
287 #+end_src
288 ** Counsel
289 Ivy everywhere.
290 #+begin_src emacs-lisp
291   (use-package counsel
292     :bind ("C-M-j" . 'counsel-switch-buffer)
293     :config (counsel-mode))
294 #+end_src
295 ** Remember frequent commands
296 #+begin_src emacs-lisp
297   (use-package ivy-prescient
298     :after counsel
299     :config
300     (prescient-persist-mode)
301     (ivy-prescient-mode))
302 #+end_src
303 * Emacs OS
304 ** RSS
305 Use elfeed for reading RSS. I have another file with all the feeds in it that I'd rather keep private.
306 #+begin_src emacs-lisp
307   (use-package elfeed
308     :bind (("C-c e" . elfeed))
309     :config (load "~/.emacs.d/feeds.el")
310     :bind (:map elfeed-search-mode-map ("C-c C-o" . 'elfeed-show-visit)))
311 #+end_src
312 ** Email
313 Use mu4e for reading emails.
314 Contexts are a not very well known feature of mu4e that makes it super easy to manage multiple accounts. Much better than some of the hacky methods and external packages that I've seen.
315 *** TODO Switch to mbsync
316 =offlineimap= really crappy (slow and requires python2), and I need to replace it with =mbsync=.
317 *** TODO Include mbsync/offlineimap config
318 *** TODO Split up and document this config a bit
319 *** Setup
320 #+begin_src emacs-lisp
321   (use-package smtpmail
322     :straight (:type built-in))
323   (use-package mu4e
324     :load-path "/usr/share/emacs/site-lisp/mu4e"
325     :straight (:build nil)
326     :bind (("C-c m" . mu4e))
327     :config
328     (setq user-full-name "Armaan Bhojwani"
329           smtpmail-local-domain "armaanb.net"
330           smtpmail-stream-type 'ssl
331           smtpmail-smtp-service '465
332           mu4e-change-filenames-when-moving t
333           mu4e-get-mail-command "offlineimap -q"
334           message-citation-line-format "On %a %d %b %Y at %R, %f wrote:\n"
335           message-citation-line-function 'message-insert-formatted-citation-line
336           mu4e-completing-read-function 'ivy-completing-read
337           mu4e-confirm-quit nil
338           mu4e-view-use-gnus t
339           mail-user-agent 'mu4e-user-agent
340           mu4e-context-policy 'pick-first
341           mu4e-contexts
342           `( ,(make-mu4e-context
343                :name "school"
344                :enter-func (lambda () (mu4e-message "Entering school context"))
345                :leave-func (lambda () (mu4e-message "Leaving school context"))
346                :match-func (lambda (msg)
347                              (when msg
348                                (string-match-p "^/school" (mu4e-message-field msg :maildir))))
349                :vars '((user-mail-address . "abhojwani22@nobles.edu")
350                        (mu4e-sent-folder . "/school/Sent")
351                        (mu4e-drafts-folder . "/school/Drafts")
352                        (mu4e-trash-folder . "/school/Trash")
353                        (mu4e-refile-folder . "/school/Archive")
354                        (message-cite-reply-position . above)
355                        (user-mail-address . "abhojwani22@nobles.edu")
356                        (smtpmail-smtp-user . "abhojwani22@nobles.edu")
357                        (smtpmail-smtp-server . "smtp.gmail.com")))
358              ,(make-mu4e-context
359                :name "personal"
360                :enter-func (lambda () (mu4e-message "Entering personal context"))
361                :leave-func (lambda () (mu4e-message "Leaving personal context"))
362                :match-func (lambda (msg)
363                              (when msg
364                                (string-match-p "^/personal" (mu4e-message-field msg :maildir))))
365                :vars '((mu4e-sent-folder . "/personal/Sent")
366                        (mu4e-drafts-folder . "/personal/Drafts")
367                        (mu4e-trash-folder . "/personal/Trash")
368                        (mu4e-refile-folder . "/personal/Archive")
369                        (user-mail-address . "me@armaanb.net")
370                        (message-cite-reply-position . below)
371                        (smtpmail-smtp-user . "me@armaanb.net")
372                        (smtpmail-smtp-server . "smtp.mailbox.org")))))
373     (add-to-list 'mu4e-bookmarks
374                  '(:name "Unified inbox"
375                          :query "maildir:\"/personal/INBOX\" or maildir:\"/school/INBOX\""
376                          :key ?b))
377     :hook ((mu4e-compose-mode . flyspell-mode)
378            (message-send-hook . (lambda () (unless (yes-or-no-p "Ya sure 'bout that?")
379                                              (signal 'quit nil))))))
380 #+end_src
381 *** Discourage Gnus from displaying HTML emails
382 #+begin_src emacs-lisp
383   (with-eval-after-load "mm-decode"
384     (add-to-list 'mm-discouraged-alternatives "text/html")
385     (add-to-list 'mm-discouraged-alternatives "text/richtext"))
386 #+end_src
387 ** Default browser
388 Set EWW as default browser except for multimedia which should open in MPV.
389 #+begin_src emacs-lisp
390   (defun browse-url-mpv (url &optional new-window)
391     "Ask MPV to load URL."
392     (interactive)
393     (start-process "mpv" "*mpv*" "mpv" url))
394
395   (setq browse-url-handlers
396         (quote
397          (("youtu\\.?be" . browse-url-mpv)
398           ("peertube.*" . browse-url-mpv)
399           ("vid.*" . browse-url-mpv)
400           ("vid.*" . browse-url-mpv)
401           ("*.mp4" . browse-url-mpv)
402           ("*.mp3" . browse-url-mpv)
403           ("*.ogg" . browse-url-mpv)
404           ("." . eww-browse-url)
405           )))
406 #+end_src
407 ** EWW
408 Some EWW enhancements.
409 *** Give buffer a useful name
410 #+begin_src emacs-lisp
411   ;; From https://protesilaos.com/dotemacs/
412   (defun prot-eww--rename-buffer ()
413     "Rename EWW buffer using page title or URL.
414         To be used by `eww-after-render-hook'."
415     (let ((name (if (eq "" (plist-get eww-data :title))
416                     (plist-get eww-data :url)
417                   (plist-get eww-data :title))))
418       (rename-buffer (format "*%s # eww*" name) t)))
419
420   (use-package eww
421     :straight (:type built-in)
422     :bind (("C-c w" . eww))
423     :hook (eww-after-render-hook prot-eww--rename-buffer))
424 #+end_src
425 *** Keybinding
426 #+begin_src emacs-lisp
427   (global-set-key (kbd "C-c w") 'eww)
428 #+end_src
429 ** IRC
430 Circe is a really nice IRC client that claims to be above RCIRC and below ERC in terms of features. ERC felt a bit messy and finicky to me, and Circe has all the features that I need. This setup gets the password for my bouncer (Pounce) instances via my =~/.authinfo.gpg= file.
431 #+begin_src emacs-lisp
432   (defun fetch-password (&rest params)
433     (require 'auth-source)
434     (let ((match (car (apply 'auth-source-search params))))
435       (if match
436           (let ((secret (plist-get match :secret)))
437             (if (functionp secret)
438                 (funcall secret)
439               secret))
440         (error "Password not found for %S" params))))
441
442   (use-package circe
443     :config
444     (enable-lui-track)
445     (enable-circe-color-nicks)
446     (setq circe-network-defaults '(("libera"
447                                     :host "irc.armaanb.net"
448                                     :nick "emacs"
449                                     :user "emacs"
450                                     :use-tls t
451                                     :port 6698
452                                     :pass (lambda (null) (fetch-password
453                                                           :login "emacs"
454                                                           :machine "irc.armaanb.net"
455                                                           :port 6698)))
456                                    ("oftc"
457                                     :host "irc.armaanb.net"
458                                     :nick "emacs"
459                                     :user "emacs"
460                                     :use-tls t
461                                     :port 6699
462                                     :pass (lambda (null) (fetch-password
463                                                           :login "emacs"
464                                                           :machine "irc.armaanb.net"
465                                                           :port 6699)))
466                                    ("tilde"
467                                     :host "irc.armaanb.net"
468                                     :nick "emacs"
469                                     :user "emacs"
470                                     :use-tls t
471                                     :port 6696
472                                     :pass (lambda (null) (fetch-password
473                                                           :login "emacs"
474                                                           :machine "irc.armaanb.net"
475                                                           :port 6696)))))
476     :custom (circe-default-part-message "goodbye!")
477     :bind (:map circe-mode-map ("C-c C-r" . circe-reconnect-all)))
478
479   (defun acheam-irc ()
480     "Open circe"
481     (interactive)
482     (if (get-buffer "irc.armaanb.net:6696")
483         (switch-to-buffer "irc.armaanb.net:6696")
484       (progn (switch-to-buffer "*scratch*")
485              (circe "libera")
486              (circe "oftc")
487              (circe "tilde"))))
488
489   (global-set-key (kbd "C-c i") 'acheam-irc)
490 #+end_src
491 ** Calendar
492 Still experimenting with this setup. Not sure if I will keep it, but it works well for seeing my calendar events. I use =vdirsyncer= to sync my calendar events which I'm really not happy with.
493 #+begin_src emacs-lisp
494   (defun sync-calendar ()
495     "Sync calendars with vdirsyncer"
496     (interactive)
497     (async-shell-command "vdirsyncer sync"))
498
499   (use-package calfw
500     :bind (:map cfw:calendar-mode-map ("C-S-u" . sync-calendar)))
501   (use-package calfw-ical)
502   (use-package calfw-org)
503
504   (defun acheam-calendar ()
505     "Open calendars"
506     (interactive)
507     (cfw:open-calendar-buffer
508      :contents-sources (list
509                         (cfw:org-create-source "Green")
510                         (cfw:ical-create-source
511                          "Personal"
512                          "~/.local/share/vdirsyncer/mailbox/Y2FsOi8vMC8zMQ.ics"
513                          "Gray")
514                         (cfw:ical-create-source
515                          "Personal"
516                          "~/.local/share/vdirsyncer/mailbox/Y2FsOi8vMC8zMQ.ics"
517                          "Red")
518                         (cfw:ical-create-source
519                          "School"
520                          "~/.local/share/vdirsyncer/school/abhojwani22@nobles.edu.ics"
521                          "Cyan"))
522      :view 'week))
523
524   (global-set-key (kbd "C-c c") 'acheam-calendar)
525 #+end_src
526 ** PDF reader
527 #+begin_src emacs-lisp
528   (use-package pdf-tools
529     :hook (pdf-view-mode . pdf-view-midnight-minor-mode))
530 #+end_src
531 * Emacs IDE
532 ** Python formatting
533 #+begin_src emacs-lisp
534   (use-package blacken
535     :hook (python-mode . blacken-mode)
536     :custom (blacken-line-length 79))
537
538 #+end_src
539 ** Strip trailing whitespace
540 #+begin_src emacs-lisp
541   (use-package ws-butler
542     :config (ws-butler-global-mode))
543 #+end_src
544 ** Flycheck
545 Automatic linting. I need to look into configuring this more.
546 #+begin_src emacs-lisp
547   (use-package flycheck
548     :config (global-flycheck-mode))
549 #+end_src
550 ** Project management
551 I never use this, but apparently its very powerful. Another item on my todo list.
552 #+begin_src emacs-lisp
553   (use-package projectile
554     :config (projectile-mode)
555     :custom ((projectile-completion-system 'ivy))
556     :bind-keymap
557     ("C-c p" . projectile-command-map)
558     :init
559     (when (file-directory-p "~/src")
560       (setq projectile-project-search-path '("~/src")))
561     (setq projectile-switch-project-action #'projectile-dired))
562
563   (use-package counsel-projectile
564     :after projectile
565     :config (counsel-projectile-mode))
566 #+end_src
567 ** Dired
568 The best file manager!
569 #+begin_src emacs-lisp
570   (use-package dired
571     :straight (:type built-in)
572     :commands (dired dired-jump)
573     :custom ((dired-listing-switches "-agho --group-directories-first"))
574     :config (evil-collection-define-key 'normal 'dired-mode-map
575               "h" 'dired-single-up-directory
576               "l" 'dired-single-buffer))
577
578   (use-package dired-single
579     :commands (dired dired-jump))
580
581   (use-package dired-open
582     :commands (dired dired-jump)
583     :custom (dired-open-extensions '(("png" . "feh")
584                                      ("mkv" . "mpv"))))
585
586   (use-package dired-hide-dotfiles
587     :hook (dired-mode . dired-hide-dotfiles-mode)
588     :config
589     (evil-collection-define-key 'normal 'dired-mode-map
590       "H" 'dired-hide-dotfiles-mode))
591 #+end_src
592 ** Git
593 *** Magit
594 A very good Git interface.
595 #+begin_src emacs-lisp
596   (use-package magit)
597 #+end_src
598 *** Email
599 #+begin_src emacs-lisp
600   (use-package piem)
601   (use-package git-email
602     :straight (git-email :repo "https://git.sr.ht/~yoctocell/git-email")
603     :config (git-email-piem-mode))
604 #+end_src
605 * General text editing
606 ** Indentation
607 Automatically indent after every change. I'm not sure how much I like this. It slows down the editor and code sometimes ends up in a half-indented state meaning I have to manually reformat using "==" anyways.
608 #+begin_src emacs-lisp
609   (use-package aggressive-indent
610     :config (global-aggressive-indent-mode))
611 #+end_src
612 ** Spell checking
613 Spell check in text mode, and in prog-mode comments.
614 #+begin_src emacs-lisp
615   (dolist (hook '(text-mode-hook
616                   markdown-mode-hook
617                   scdoc-mode-hook))
618     (add-hook hook (lambda () (flyspell-mode))))
619   (dolist (hook '(change-log-mode-hook log-edit-mode-hook))
620     (add-hook hook (lambda () (flyspell-mode -1))))
621   (add-hook 'prog-mode (lambda () (flyspell-prog mode)))
622   (setq ispell-silently-savep t)
623 #+end_src
624 ** Sane tab width
625 #+begin_src emacs-lisp
626   (setq-default tab-width 2)
627 #+end_src
628 ** Save place
629 Opens file where you left it.
630 #+begin_src emacs-lisp
631   (save-place-mode)
632 #+end_src
633 ** Writing mode
634 Distraction free writing a la junegunn/goyo.
635 #+begin_src emacs-lisp
636   (use-package olivetti
637     :bind ("C-c o" . olivetti-mode))
638 #+end_src
639 ** Abbreviations
640 Abbreviate things! I just use this for things like my email address and copyright notice.
641 #+begin_src emacs-lisp
642   (setq abbrev-file-name "~/.emacs.d/abbrevs.el")
643   (setq save-abbrevs 'silent)
644   (setq-default abbrev-mode t)
645 #+end_src
646 ** TRAMP
647 #+begin_src emacs-lisp
648   (setq tramp-default-method "ssh")
649 #+end_src
650 ** Follow version controlled symlinks
651 #+begin_src emacs-lisp
652   (setq vc-follow-symlinks t)
653 #+end_src
654 ** Open file as root
655 #+begin_src emacs-lisp
656   (defun doas-edit (&optional arg)
657     "Edit currently visited file as root.
658
659     With a prefix ARG prompt for a file to visit.
660     Will also prompt for a file to visit if current
661     buffer is not visiting a file.
662
663     Modified from Emacs Redux."
664     (interactive "P")
665     (if (or arg (not buffer-file-name))
666         (find-file (concat "/doas:root@localhost:"
667                            (ido-read-file-name "Find file(as root): ")))
668       (find-alternate-file (concat "/doas:root@localhost:" buffer-file-name))))
669
670     (global-set-key (kbd "C-x C-r") #'doas-edit)
671 #+end_src
672 ** Markdown mode
673 #+begin_src emacs-lisp
674   (use-package markdown-mode)
675 #+end_src
676 ** scdoc mode
677 Get it for yourself at https://git.armaanb.net/scdoc
678 #+begin_src emacs-lisp
679   (add-to-list 'load-path "~/src/scdoc-mode")
680   (autoload 'scdoc-mode "scdoc-mode" "Major mode for editing scdoc files" t)
681   (add-to-list 'auto-mode-alist '("\\.scd\\'" . scdoc-mode))
682 #+end_src
683 * Keybindings
684 ** Switch windows
685 #+begin_src emacs-lisp
686   (use-package ace-window
687     :bind ("M-o" . ace-window))
688 #+end_src
689 ** Kill current buffer
690 Makes "C-x k" binding faster.
691 #+begin_src emacs-lisp
692   (substitute-key-definition 'kill-buffer 'kill-buffer-and-window global-map)
693 #+end_src
694 * Other settings
695 ** OpenSCAD syntax
696 #+begin_src emacs-lisp
697   (use-package scad-mode)
698 #+end_src
699 ** Control backup and lock files
700 Stop backup files from spewing everywhere.
701 #+begin_src emacs-lisp
702   (setq backup-directory-alist `(("." . "~/.emacs.d/backups"))
703         create-lockfiles nil)
704 #+end_src
705 ** Make yes/no easier
706 #+begin_src emacs-lisp
707   (defalias 'yes-or-no-p 'y-or-n-p)
708 #+end_src
709 ** Move customize file
710 No more clogging up init.el.
711 #+begin_src emacs-lisp
712   (setq custom-file "~/.emacs.d/custom.el")
713   (load custom-file)
714 #+end_src
715 ** Better help
716 #+begin_src emacs-lisp
717   (use-package helpful
718     :commands (helpful-callable helpful-variable helpful-command helpful-key)
719     :custom
720     (counsel-describe-function-function #'helpful-callable)
721     (counsel-describe-variable-function #'helpful-variable)
722     :bind
723     ([remap describe-function] . counsel-describe-function)
724     ([remap describe-command] . helpful-command)
725     ([remap describe-variable] . counsel-describe-variable)
726     ([remap describe-key] . helpful-key))
727 #+end_src
728 ** GPG
729 #+begin_src emacs-lisp
730   (use-package epa-file
731     :straight (:type built-in)
732     :custom
733     (epa-file-select-keys nil)
734     (epa-file-encrypt-to '("me@armaanb.net"))
735     (password-cache-expiry (* 60 15)))
736
737   (use-package pinentry
738     :config (pinentry-start))
739 #+end_src
740 ** Pastebin
741 #+begin_src emacs-lisp
742   (use-package 0x0
743     :straight (0x0 :type git :repo "https://git.sr.ht/~zge/nullpointer-emacs")
744     :custom (0x0-default-service 'envs))
745 #+end_src
746 *** TODO Replace this with uploading to my own server
747 Similar to the ufile alias in my ashrc
748 ** Automatically clean buffers
749 Automatically close unused buffers (except those of Circe) at midnight.
750 #+begin_src emacs-lisp
751   (midnight-mode)
752   (add-to-list 'clean-buffer-list-kill-never-regexps (lambda (buffer-name)
753                                                        (with-current-buffer buffer-name
754                                                          (derived-mode-p 'lui-mode))))
755 #+end_src
756 * Tangles
757 ** Spectrwm
758 Spectrwm is a really awesome window manager! Would highly recommend.
759 *** General settings
760 #+begin_src conf :tangle ~/.spectrwm.conf
761   workspace_limit = 5
762   warp_pointer = 1
763   modkey = Mod4
764   autorun = ws[1]:/home/armaa/src/bin/autostart
765 #+end_src
766 *** Bar
767 Disable the bar by default (it can still be brought back up with MOD+b). The font just needs to be set to something that you have installed, otherwise spectrwm won't launch.
768 #+begin_src conf :tangle ~/.spectrwm.conf
769   bar_enabled = 0
770   bar_font = xos4 JetBrains Mono:pixelsize=14:antialias=true # any installed font
771 #+end_src
772 *** Keybindings
773 I'm not a huge fan of how spectrwm handles keybindings, probably my biggest gripe with it.
774 **** WM actions
775 #+begin_src conf :tangle ~/.spectrwm.conf
776   program[term] = st -e tmux
777   program[notif] = /home/armaa/src/bin/setter status
778   program[pass] = /home/armaa/src/bin/passmenu
779   program[lock] = slock
780
781   bind[notif] = MOD+n
782   bind[pass] = MOD+Shift+p
783 #+end_src
784 **** Media keys
785 #+begin_src conf :tangle ~/.spectrwm.conf
786   program[paup] = /home/armaa/src/bin/setter audio +5
787   program[padown] = /home/armaa/src/bin/setter audio -5
788   program[pamute] = /home/armaa/src/bin/setter audio
789   program[brigup] = /home/armaa/src/bin/setter brightness +10%
790   program[brigdown] = /home/armaa/src/bin/setter brightness 10%-
791
792   bind[padown] = XF86AudioLowerVolume
793   bind[paup] = XF86AudioRaiseVolume
794   bind[pamute] = XF86AudioMute
795   bind[brigdown] = XF86MonBrightnessDown
796   bind[brigup] = XF86MonBrightnessUp
797 #+end_src
798 **** HJKL
799 #+begin_src conf :tangle ~/.spectrwm.conf
800   program[h] = xdotool keyup h key --clearmodifiers Left
801   program[j] = xdotool keyup j key --clearmodifiers Down
802   program[k] = xdotool keyup k key --clearmodifiers Up
803   program[l] = xdotool keyup l key --clearmodifiers Right
804
805   bind[h] = MOD + Control + h
806   bind[j] = MOD + Control + j
807   bind[k] = MOD + Control + k
808   bind[l] = MOD + Control + l
809 #+end_src
810 **** Programs
811 #+begin_src conf :tangle ~/.spectrwm.conf
812   program[email] = emacsclient -ce '(progn (switch-to-buffer "*scratch*") (mu4e))'
813   program[irc] = emacsclient -ce '(acheam-irc)'
814   program[rss] = emacsclient -ce '(elfeed)'
815   program[calendar] = emacsclient -ce '(acheam-calendar)'
816   program[calc] = emacsclient -ce '(progn (calc) (windmove-up) (delete-window))'
817   program[emacs] = emacsclient -c
818
819   bind[email] = MOD+Control+1
820   bind[irc] = MOD+Control+2
821   bind[rss] = MOD+Control+3
822   bind[calendar] = MOD+Control+4
823   bind[calc] = MOD+Control+5
824   bind[emacs] = MOD+Control+Return
825 #+end_src
826 *** Quirks
827 Float some specific programs by default.
828 #+begin_src conf :tangle ~/.spectrwm.conf
829   quirk[Castle Menu] = FLOAT
830   quirk[momen] = FLOAT
831 #+end_src
832 ** Ash
833 *** Options
834 Use the vi editing mode. I still haven't found a good way to show visual feedback of the current mode. Ideally the cursor would change to a beam when in insert mode, and a box when in normal mode.
835 #+begin_src conf :tangle ~/.config/ash/ashrc
836   set -o vi
837 #+end_src
838 *** Functions
839 **** Finger
840 #+begin_src shell :tangle ~/.config/ash/ashrc
841   finger() {
842       user=$(echo "$1" | cut -f 1 -d '@')
843       host=$(echo "$1" | cut -f 2 -d '@')
844       echo $user | nc "$host" 79
845   }
846 #+end_src
847 **** Upload to ftp.armaanb.net
848 #+begin_src shell :tangle ~/.config/ash/ashrc
849   _uprint() {
850       echo "https://l.armaanb.net/$(basename "$1")" | tee /dev/tty | xclip -sel c
851   }
852
853   _uup() {
854       rsync "$1" "root@armaanb.net:/var/ftp/pub/$2" --chmod 644
855   }
856
857   ufile() {
858       _uup "$1" "$2"
859       _uprint "$1"
860   }
861
862   uclip() {
863       tmp=$(mktemp)
864       xclip -o -sel c >> "$tmp"
865       basetmp=$(echo "$tmp" | tail -c +5)
866       _uup "$tmp" "$basetmp"
867       _uprint "$basetmp"
868       rm -f "$tmp"
869   }
870 #+end_src
871 *** Exports
872 #+begin_src shell :tangle ~/.config/ash/ashrc
873   export EDITOR="emacsclient -c"
874   export VISUAL="$EDITOR"
875   export TERM=xterm-256color # for compatability
876
877   export GPG_TTY="$(tty)"
878   export MANPAGER='nvim +Man!'
879   export PAGER='less'
880   export GTK_USE_PORTAL=1
881   export CDPATH=:~
882
883   export PATH="/home/armaa/.local/bin:$PATH" # prioritize .local/bin
884   export PATH="/home/armaa/src/bin:$PATH" # prioritize my bin
885   export PATH="//home/armaa/src/bin/bin:$PATH" # prioritize my bins
886   export PATH="$PATH:/usr/sbin"
887
888   export LC_ALL="en_US.UTF-8"
889   export LC_CTYPE="en_US.UTF-8"
890   export LANGUAGE="en_US.UTF-8"
891
892   export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig"
893
894   export KISS_PATH=""
895   export KISS_PATH="$KISS_PATH:$HOME/repos/personal"
896   export KISS_PATH="$KISS_PATH:$HOME/repos/bin/bin"
897   export KISS_PATH="$KISS_PATH:$HOME/repos/main/core"
898   export KISS_PATH="$KISS_PATH:$HOME/repos/main/extra"
899   export KISS_PATH="$KISS_PATH:$HOME/repos/main/xorg"
900   export KISS_PATH="$KISS_PATH:$HOME/repos/main/xorg"
901   export KISS_PATH="$KISS_PATH:$HOME/repos/community/community"
902   export KISS_PATH="$KISS_PATH:$HOME/repos/mid/ports"
903
904   export CFLAGS="-O3 -pipe -march=native"
905   export CXXFLAGS="$CFLAGS"
906   export MAKEFLAGS="-j$(nproc)"
907
908   export XDG_DESKTOP_DIR="/dev/null"
909   export XDG_DOCUMENTS_DIR="$HOME/documents"
910   export XDG_DOWNLOAD_DIR="$HOME/downloads"
911   export XDG_MUSIC_DIR="$HOME/music"
912   export XDG_PICTURES_DIR="$HOME/pictures"
913   export XDG_VIDEOS_DIR="$HOME/videos"
914
915 #+end_src
916 *** Aliases
917 **** SSH
918 #+begin_src shell :tangle ~/.config/ash/ashrc
919   alias bhoji-drop='ssh -p 23 root@armaanb.net'
920   alias irc='ssh root@armaanb.net -t abduco -A irc catgirl freenode'
921   alias union='ssh 192.168.1.18'
922   alias mine='ssh -p 23 root@pickupserver.cc'
923   alias tcf='ssh root@204.48.23.68'
924   alias ngmun='ssh root@157.245.89.25'
925   alias prox='ssh root@192.168.1.224'
926   alias ncq='ssh root@143.198.123.17'
927   alias envs='ssh acheam@envs.net'
928 #+end_src
929 **** File management
930 #+begin_src shell :tangle ~/.config/ash/ashrc
931   alias ls='LC_COLLATE=C ls -lh --group-directories-first'
932   alias la='ls -A'
933   alias df='df -h / /boot'
934   alias du='du -h'
935   alias free='free -m'
936   alias cp='cp -riv'
937   alias rm='rm -iv'
938   alias mv='mv -iv'
939   alias ln='ln -v'
940   alias grep='grep -in'
941   alias mkdir='mkdir -pv'
942   alias lanex='java -jar ~/.local/share/lxc/lanxchange.jar'
943   emacs() { $EDITOR "$@" & }
944   alias vim="emacs"
945 #+end_src
946 **** System management
947 #+begin_src shell :tangle ~/.config/ash/ashrc
948   alias crontab='crontab-argh'
949   alias sudo='doas'
950   alias pasu='git -C ~/.password-store push'
951   alias yadu='yadm add -u && yadm commit -m "Updated `date -Iseconds`" && \
952     yadm push'
953 #+end_src
954 **** Networking
955 #+begin_src shell :tangle ~/.config/ash/ashrc
956   alias ping='ping -c 10'
957   alias gps='gpg --keyserver keyserver.ubuntu.com --search-keys'
958   alias gpp='gpg --keyserver keyserver.ubuntu.com --recv-key'
959   alias plan='T=$(mktemp) && \
960           rsync root@armaanb.net:/etc/finger/plan.txt "$T" && \
961           TT=$(mktemp) && \
962           head -n -2 $T > $TT && \
963           /bin/nvim $TT && \
964           echo >> "$TT" && \
965           echo "Last updated: $(date -R)" >> "$TT" && \
966           fold -sw 72 "$TT" > "$T"| \
967           rsync "$T" root@armaanb.net:/etc/finger/plan.txt && \
968           rm -f "$T"'
969 #+end_src
970 **** Virtual machines, chroots
971 #+begin_src shell :tangle ~/.config/ash/ashrc
972   alias ckiss="doas chrooter ~/Virtual/kiss"
973   alias cdebian="doas chrooter ~/Virtual/debian bash"
974   alias cwindows='devour qemu-system-x86_64 \
975     -smp 3 \
976     -cpu host \
977     -enable-kvm \
978     -m 3G \
979     -device VGA,vgamem_mb=64 \
980     -device intel-hda \
981     -device hda-duplex \
982     -net nic \
983     -net user,smb=/home/armaa/Public \
984     -drive format=qcow2,file=/home/armaa/Virtual/windows.qcow2'
985 #+end_src
986 **** Latin
987 #+begin_src shell :tangle ~/.config/ash/ashrc
988   alias words='gen-shell -c "words"'
989   alias words-e='gen-shell -c "words ~E"'
990 #+end_src
991 **** Other
992 #+begin_src shell :tangle ~/.config/ash/ashrc
993   alias bigrandomfile='dd if=/dev/urandom of=1GB-urandom bs=1M count=1024 \
994     iflag=fullblock'
995   alias bigboringfile='dd if=/dev/zero of=1GB-zero bs=1M count=1024 \
996     iflag=fullblock'
997   alias ytmusic="youtube-dl -x --add-metadata  --audio-format aac \
998     --restrict-filenames -o '%(title)s.%(ext)s'"
999   alias bc='bc -l'
1000 #+end_src
1001 ** MPV
1002 Make MPV play a little bit smoother.
1003 #+begin_src conf :tangle ~/.config/mpv/mpv.conf
1004   ytdl-format="bestvideo[height<=?1080]+bestaudio/best"
1005   hwdec=auto-copy
1006 #+end_src
1007 ** Inputrc
1008 This file is used for any GNU Readline programs. I use Emacs editing mode mostly because of one annoyance which is that to clear the screen using ^L, you have to be in normal mode which is a pain. If there is a way to rebind this, I'd love to know!.
1009 #+begin_src conf :tangle ~/.inputrc
1010   set editing-mode emacs
1011 #+end_src
1012 ** Git
1013 *** User
1014 #+begin_src conf :tangle ~/.gitconfig
1015   [user]
1016   name = Armaan Bhojwani
1017   email = me@armaanb.net
1018   signingkey = 0FEB9471E19C49C60CFBEB133C9ED82FFE788E4A
1019 #+end_src
1020 *** Init
1021 #+begin_src conf :tangle ~/.gitconfig
1022   [init]
1023   defaultBranch = main
1024 #+end_src
1025 *** GPG
1026 #+begin_src conf :tangle ~/.gitconfig
1027   [gpg]
1028   program = gpg
1029 #+end_src
1030 *** Sendemail
1031 #+begin_src conf :tangle ~/.gitconfig
1032   [sendemail]
1033   smtpserver = smtp.mailbox.org
1034   smtpuser = me@armaanb.net
1035   smtpencryption = ssl
1036   smtpserverport = 465
1037   confirm = auto
1038 #+end_src
1039 *** Submodule
1040 #+begin_src conf :tangle ~/.gitconfig
1041   [submodule]
1042   recurse = true
1043 #+end_src
1044 *** Aliases
1045 #+begin_src conf :tangle ~/.gitconfig
1046   [alias]
1047   stat = diff --stat
1048   sclone = clone --depth 1
1049   sclean = clean -dfX
1050   a = add
1051   aa = add .
1052   c = commit
1053   quickfix = commit . --amend --no-edit
1054   p = push
1055   subup = submodule update --remote
1056   loc = diff --stat 4b825dc642cb6eb9a060e54bf8d69288fbee4904 # Empty hash
1057   pushnc = push -o skip-ci
1058 #+end_src
1059 *** Commit
1060 #+begin_src conf :tangle ~/.gitconfig
1061   [commit]
1062   gpgsign = true
1063   verbose = true
1064 #+end_src
1065 ** Zathura
1066 The best document reader!
1067 *** Options
1068 #+begin_src conf :tangle ~/.config/zathura/zathurarc
1069   map <C-i> recolor
1070   map <A-b> toggle_statusbar
1071   set selection-clipboard clipboard
1072   set scroll-step 200
1073
1074   set window-title-basename "true"
1075   set selection-clipboard "clipboard"
1076 #+end_src
1077 *** Colors
1078 #+begin_src conf :tangle ~/.config/zathura/zathurarc
1079   set default-bg         "#000000"
1080   set default-fg         "#ffffff"
1081   set render-loading     true
1082   set render-loading-bg  "#000000"
1083   set render-loading-fg  "#ffffff"
1084
1085   set recolor-lightcolor "#000000" # bg
1086   set recolor-darkcolor  "#ffffff" # fg
1087   set recolor            "true"
1088 #+end_src
1089 ** Xresources
1090 Modus operandi theme. No program I use checks for anything beyond foreground and background, but hey, it can't hurt to have all the colors in there.
1091 #+begin_src conf :tangle ~/.Xresources
1092   ! special
1093   ,*.foreground:   #ffffff
1094   ,*.background:   #000000
1095   ,*.cursorColor:  #ffffff
1096
1097   ! black
1098   ,*.color0:       #000000
1099   ,*.color8:       #555555
1100
1101   ! red
1102   ,*.color1:       #ff8059
1103   ,*.color9:       #ffa0a0
1104
1105   ! green
1106   ,*.color2:       #00fc50
1107   ,*.color10:      #88cf88
1108
1109   ! yellow
1110   ,*.color3:       #eecc00
1111   ,*.color11:      #d2b580
1112
1113   ! blue
1114   ,*.color4:       #29aeff
1115   ,*.color12:      #92baff
1116
1117   ! magenta
1118   ,*.color5:       #feacd0
1119   ,*.color13:      #e0b2d6
1120
1121   ! cyan
1122   ,*.color6:       #00d3d0
1123   ,*.color14:      #a0bfdf
1124
1125   ! white
1126   ,*.color7:       #eeeeee
1127   ,*.color15:      #dddddd
1128 #+end_src
1129 ** Tmux
1130 I use tmux in order to keep my st build light. Still learning how it works.
1131 #+begin_src conf :tangle ~/.tmux.conf
1132   set -g status off
1133   set -g mouse on
1134   set-option -g history-limit 50000
1135   set-window-option -g mode-keys vi
1136   bind-key -T copy-mode-vi 'v' send -X begin-selection
1137   bind -T copy-mode-vi y send-keys -X copy-pipe-and-cancel 'xclip -in -selection clipboard'
1138 #+end_src
1139 ** GPG
1140 *** Config
1141 #+begin_src conf :tangle ~/.gnupg/gpg.conf
1142   default-key 3C9ED82FFE788E4A
1143   use-agent
1144 #+end_src
1145 *** Agent
1146 #+begin_src conf :tangle ~/.gnupg/gpg-agent.conf
1147   pinentry-program /sbin/pinentry-fltk
1148   max-cache-ttl 600
1149   default-cache-ttl 600
1150   allow-emacs-pinentry
1151 #+end_src
1152 ** Xmodmap
1153 #+begin_src conf :tangle ~/.config/xmodmap
1154   !
1155   ! Unmap left super
1156   !
1157   clear mod4
1158
1159   !
1160   ! Turn right alt into super
1161   !
1162   remove mod1 = Alt_R
1163   add mod4 = Alt_R
1164 #+end_src
1165 #+begin_src conf (if (eq system-name "frost.armaanb.net") ":tangle ~/.config/xmodmap")
1166   !
1167   ! Swap caps and control
1168   !
1169   remove Lock = Caps_Lock
1170   remove Control = Control_L
1171   remove Lock = Control_L
1172   remove Control = Caps_Lock
1173   keysym Control_L = Caps_Lock
1174   keysym Caps_Lock = Control_L
1175   add Lock = Caps_Lock
1176   add Control = Control_L
1177 #+end_src