Update docstring

[config.org.git] / config.org

diff --git a/config.org b/config.org
index 58575bfbee8d484243ace6468939234cc7b36f10..287e2fd2a499a5f5dabb580683a140dc78fe45c1 100644 (file)
--- a/config.org
+++ b/config.org
@@ -13,9 +13,6 @@ I chose to create a powerful, yet not overly heavy Emacs configuration. Things l
 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.
 
 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.
 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.
 
 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.

-** TODOs
-*** TODO Turn keybinding and hook declarations into use-package declarations where possible
-*** TODO Include offlineimap config

 ** License
 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.
 * Package management
 ** License
 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.
 * Package management


@@ -131,14 +128,19 @@ Show a ruler at a certain number of chars depending on mode.
   (blink-cursor-mode)
 #+end_src
 ** Visual line mode
   (blink-cursor-mode)
 #+end_src
 ** Visual line mode

-Soft wrap words and do operations by visual lines except in programming modes.
+Soft wrap words and do operations by visual lines in some modes.

 #+begin_src emacs-lisp
 #+begin_src emacs-lisp

-  (global-visual-line-mode 1)
-  (dolist (hook '(prog-mode-hook
-                  calc-trail-mode-hook
-                  org-agenda-mode-hook
-                  mu4e-headers-mode-hook))
-    (add-hook hook (lambda () (visual-line-mode -1))))
+  (dolist (hook '(text-mode-hook
+                  org-mode-hook
+                  markdown-mode-hook
+                  mu4e-view-mode-hook))
+    (add-hook hook (lambda () (visual-line-mode 1))))
+#+end_src
+** Auto fill mode
+#+begin_src emacs-lisp
+  (dolist (hook '(scdoc-mode-hook
+                  mu4e-compose-mode-hook))
+    (add-hook hook (lambda () (auto-fill-mode 1))))

 #+end_src
 ** Display number of matches in search
 #+begin_src emacs-lisp
 #+end_src
 ** Display number of matches in search
 #+begin_src emacs-lisp


@@ -148,6 +150,7 @@ Soft wrap words and do operations by visual lines except in programming modes.
     ([remap query-replace] . anzu-query-replace)
     ([remap query-replace-regexp] . anzu-query-replace-regexp))
 #+end_src
     ([remap query-replace] . anzu-query-replace)
     ([remap query-replace-regexp] . anzu-query-replace-regexp))
 #+end_src

+*** TODO This config doesn't work right

 ** Visual bell
 Invert modeline color instead of audible bell or the standard visual bell.
 #+begin_src emacs-lisp
 ** Visual bell
 Invert modeline color instead of audible bell or the standard visual bell.
 #+begin_src emacs-lisp


@@ -235,7 +238,10 @@ Add back C-a/C-x bindings.
     (org-startup-indented t)
     (org-hide-emphasis-markers t)
     (org-fontify-whole-block-delimiter-line nil)
     (org-startup-indented t)
     (org-hide-emphasis-markers t)
     (org-fontify-whole-block-delimiter-line nil)

-    :bind ("C-c a" . org-agenda))
+    (org-archive-default-command 'org-archive-to-archive-sibling)
+    :bind
+    ("C-c a" . org-agenda)
+    (:map evil-normal-state-map ("ga" . org-archive-subtree-default)))

 #+end_src
 ** Tempo
 Define templates for lots of common structure elements. Mostly just used within this file.
 #+end_src
 ** Tempo
 Define templates for lots of common structure elements. Mostly just used within this file.


@@ -244,30 +250,30 @@ Define templates for lots of common structure elements. Mostly just used within
     :after org
     :straight (:type built-in)
     :config
     :after org
     :straight (:type built-in)
     :config

-    ;; TODO: There's gotta be a more efficient way to write this
-    (add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp"))
-    (add-to-list 'org-structure-template-alist '("sp" . "src conf :tangle ~/.spectrwm.conf"))
-    (add-to-list 'org-structure-template-alist '("ash" . "src shell :tangle ~/.config/ash/ashrc"))
-    (add-to-list 'org-structure-template-alist '("pi" . "src conf :tangle ~/.config/picom/picom.conf"))
-    (add-to-list 'org-structure-template-alist '("git" . "src conf :tangle ~/.gitconfig"))
-    (add-to-list 'org-structure-template-alist '("du" . "src conf :tangle ~/.config/dunst/dunstrc"))
-    (add-to-list 'org-structure-template-alist '("za" . "src conf :tangle ~/.config/zathura/zathurarc"))
-    (add-to-list 'org-structure-template-alist '("ff1" . "src css :tangle ~/.mozilla/firefox/armaan-release/chrome/userChrome.css"))
-    (add-to-list 'org-structure-template-alist '("ff2" . "src css :tangle ~/.mozilla/firefox/armaan-release/chrome/userContent.css"))
-    (add-to-list 'org-structure-template-alist '("xr" . "src conf :tangle ~/.Xresources"))
-    (add-to-list 'org-structure-template-alist '("tm" . "src conf :tangle ~/.tmux.conf"))
-    (add-to-list 'org-structure-template-alist '("gp" . "src conf :tangle ~/.gnupg/gpg.conf"))
-    (add-to-list 'org-structure-template-alist '("ag" . "src conf :tangle ~/.gnupg/gpg-agent.conf")))
+    (dolist (addition '(("el" . "src emacs-lisp")
+                        ("el" . "src emacs-lisp")
+                        ("sp" . "src conf :tangle ~/.spectrwm.conf")
+                        ("ash" . "src shell :tangle ~/.config/ash/ashrc")
+                        ("pi" . "src conf :tangle ~/.config/picom/picom.conf")
+                        ("git" . "src conf :tangle ~/.gitconfig")
+                        ("du" . "src conf :tangle ~/.config/dunst/dunstrc")
+                        ("za" . "src conf :tangle ~/.config/zathura/zathurarc")
+                        ("ff1" . "src css :tangle ~/.mozilla/firefox/armaan-release/chrome/userChrome.css")
+                        ("ff2" . "src css :tangle ~/.mozilla/firefox/armaan-release/chrome/userContent.css")
+                        ("xr" . "src conf :tangle ~/.Xresources")
+                        ("tm" . "src conf :tangle ~/.tmux.conf")
+                        ("gp" . "src conf :tangle ~/.gnupg/gpg.conf")
+                        ("ag" . "src conf :tangle ~/.gnupg/gpg-agent.conf")))
+      (add-to-list 'org-structure-template-alist addition)))

 #+end_src
 * Autocompletion
 ** Ivy
 A well balanced completion framework.
 #+begin_src emacs-lisp
   (use-package ivy
 #+end_src
 * Autocompletion
 ** Ivy
 A well balanced completion framework.
 #+begin_src emacs-lisp
   (use-package ivy

-    :bind (("C-s" . swiper)
-           :map ivy-minibuffer-map
-           ("TAB" . ivy-alt-done)
-           :map ivy-switch-buffer-map
+    :bind (:map ivy-minibuffer-map
+           ("TAB" . ivy-alt-done))
+           (:map ivy-switch-buffer-map

            ("M-d" . ivy-switch-buffer-kill))
     :config (ivy-mode))
 #+end_src
            ("M-d" . ivy-switch-buffer-kill))
     :config (ivy-mode))
 #+end_src


@@ -281,49 +287,34 @@ A well balanced completion framework.
 Ivy everywhere.
 #+begin_src emacs-lisp
   (use-package counsel
 Ivy everywhere.
 #+begin_src emacs-lisp
   (use-package counsel

-    :bind (("C-M-j" . 'counsel-switch-buffer)
-           :map minibuffer-local-map
-           ("C-r" . 'counsel-minibuffer-history))
-    :custom (counsel-linux-app-format-function #'counsel-linux-app-format-function-name-only)
+    :bind ("C-M-j" . 'counsel-switch-buffer)

     :config (counsel-mode))
 #+end_src
 ** Remember frequent commands
 #+begin_src emacs-lisp
   (use-package ivy-prescient
     :after counsel
     :config (counsel-mode))
 #+end_src
 ** Remember frequent commands
 #+begin_src emacs-lisp
   (use-package ivy-prescient
     :after counsel

-    :custom (ivy-prescient-enable-filtering nil)

     :config
     (prescient-persist-mode)
     (ivy-prescient-mode))
 #+end_src
     :config
     (prescient-persist-mode)
     (ivy-prescient-mode))
 #+end_src

-** Swiper
-Better search utility.
-#+begin_src emacs-lisp
-  (use-package swiper)
-#+end_src

 * Emacs OS
 ** RSS
 Use elfeed for reading RSS. I have another file with all the feeds in it that I'd rather keep private.
 #+begin_src emacs-lisp
   (use-package elfeed
     :bind (("C-c e" . elfeed))
 * Emacs OS
 ** RSS
 Use elfeed for reading RSS. I have another file with all the feeds in it that I'd rather keep private.
 #+begin_src emacs-lisp
   (use-package elfeed
     :bind (("C-c e" . elfeed))

-    :config
-    (load "~/.emacs.d/feeds.el")
-    (add-hook 'elfeed-new-entry-hook
-              (elfeed-make-tagger :feed-url "youtube\\.com"
-                                  :add '(youtube)))
+    :config (load "~/.emacs.d/feeds.el")

     :bind (:map elfeed-search-mode-map ("C-c C-o" . 'elfeed-show-visit)))
     :bind (:map elfeed-search-mode-map ("C-c C-o" . 'elfeed-show-visit)))

-
-  (use-package elfeed-goodies
-    :after elfeed
-    :config (elfeed-goodies/setup))

 #+end_src
 ** Email
 Use mu4e for reading emails.
 #+end_src
 ** Email
 Use mu4e for reading emails.

-
-I use `offlineimap` to sync my maildirs. It is slower than mbsync, but is fast enough for me, especially when ran with the =-q= option.
-

 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.
 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.

+*** TODO Switch to mbsync
+=offlineimap= really crappy (slow and requires python2), and I need to replace it with =mbsync=.
+*** TODO Include mbsync/offlineimap config
+*** TODO Split up and document this config a bit
+*** Setup

 #+begin_src emacs-lisp
   (use-package smtpmail
     :straight (:type built-in))
 #+begin_src emacs-lisp
   (use-package smtpmail
     :straight (:type built-in))


@@ -382,12 +373,10 @@ Contexts are a not very well known feature of mu4e that makes it super easy to m
                          :query "maildir:\"/personal/INBOX\" or maildir:\"/school/INBOX\""
                          :key ?b))
     :hook ((mu4e-compose-mode . flyspell-mode)
                          :query "maildir:\"/personal/INBOX\" or maildir:\"/school/INBOX\""
                          :key ?b))
     :hook ((mu4e-compose-mode . flyspell-mode)

-           (mu4e-compose-mode . auto-fill-mode)
-           (mu4e-view-mode-hook . turn-on-visual-line-mode)

            (message-send-hook . (lambda () (unless (yes-or-no-p "Ya sure 'bout that?")
                                              (signal 'quit nil))))))
 #+end_src
            (message-send-hook . (lambda () (unless (yes-or-no-p "Ya sure 'bout that?")
                                              (signal 'quit nil))))))
 #+end_src

-Discourage Gnus from displaying HTML emails
+*** Discourage Gnus from displaying HTML emails

 #+begin_src emacs-lisp
   (with-eval-after-load "mm-decode"
     (add-to-list 'mm-discouraged-alternatives "text/html")
 #+begin_src emacs-lisp
   (with-eval-after-load "mm-decode"
     (add-to-list 'mm-discouraged-alternatives "text/html")


@@ -397,7 +386,7 @@ Discourage Gnus from displaying HTML emails
 Set EWW as default browser except for multimedia which should open in MPV.
 #+begin_src emacs-lisp
   (defun browse-url-mpv (url &optional new-window)
 Set EWW as default browser except for multimedia which should open in MPV.
 #+begin_src emacs-lisp
   (defun browse-url-mpv (url &optional new-window)

-    "Open URL in MPV."
+    "Ask MPV to load URL."

     (interactive)
     (start-process "mpv" "*mpv*" "mpv" url))
 
     (interactive)
     (start-process "mpv" "*mpv*" "mpv" url))
 


@@ -481,12 +470,21 @@ Circe is a really nice IRC client that claims to be above RCIRC and below ERC in
                                     :pass (lambda (null) (fetch-password
                                                           :login "emacs"
                                                           :machine "irc.armaanb.net"
                                     :pass (lambda (null) (fetch-password
                                                           :login "emacs"
                                                           :machine "irc.armaanb.net"

-                                                          :port 6696)))
-                                   (circe "libera")
-                                   (circe "oftc")
-                                   (circe "tilde")))
+                                                          :port 6696)))))

     :custom (circe-default-part-message "goodbye!")
     :bind (:map circe-mode-map ("C-c C-r" . circe-reconnect-all)))
     :custom (circe-default-part-message "goodbye!")
     :bind (:map circe-mode-map ("C-c C-r" . circe-reconnect-all)))

+
+  (defun acheam-irc ()
+    "Open circe"
+    (interactive)
+    (if (get-buffer "irc.armaanb.net:6696")
+        (switch-to-buffer "irc.armaanb.net:6696")
+      (progn (switch-to-buffer "*scratch*")
+             (circe "libera")
+             (circe "oftc")
+             (circe "tilde"))))
+
+  (global-set-key (kbd "C-c i") 'acheam-irc)

 #+end_src
 ** Calendar
 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.
 #+end_src
 ** Calendar
 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.


@@ -591,7 +589,6 @@ The best file manager!
 #+end_src
 ** Git
 *** Magit
 #+end_src
 ** Git
 *** Magit

-**** TODO Write a command that commits hunk, skipping staging step.

 A very good Git interface.
 #+begin_src emacs-lisp
   (use-package magit)
 A very good Git interface.
 #+begin_src emacs-lisp
   (use-package magit)


@@ -613,7 +610,9 @@ Automatically indent after every change. I'm not sure how much I like this. It s
 ** Spell checking
 Spell check in text mode, and in prog-mode comments.
 #+begin_src emacs-lisp
 ** Spell checking
 Spell check in text mode, and in prog-mode comments.
 #+begin_src emacs-lisp

-  (dolist (hook '(text-mode-hook))
+  (dolist (hook '(text-mode-hook
+                  markdown-mode-hook
+                  scdoc-mode-hook))

     (add-hook hook (lambda () (flyspell-mode))))
   (dolist (hook '(change-log-mode-hook log-edit-mode-hook))
     (add-hook hook (lambda () (flyspell-mode -1))))
     (add-hook hook (lambda () (flyspell-mode))))
   (dolist (hook '(change-log-mode-hook log-edit-mode-hook))
     (add-hook hook (lambda () (flyspell-mode -1))))


@@ -735,6 +734,8 @@ No more clogging up init.el.
     :straight (0x0 :type git :repo "https://git.sr.ht/~zge/nullpointer-emacs")
     :custom (0x0-default-service 'envs))
 #+end_src
     :straight (0x0 :type git :repo "https://git.sr.ht/~zge/nullpointer-emacs")
     :custom (0x0-default-service 'envs))
 #+end_src

+*** TODO Replace this with uploading to my own server
+Similar to the ufile alias in my ashrc

 ** Automatically clean buffers
 Automatically close unused buffers (except those of Circe) at midnight.
 #+begin_src emacs-lisp
 ** Automatically clean buffers
 Automatically close unused buffers (except those of Circe) at midnight.
 #+begin_src emacs-lisp


@@ -805,8 +806,8 @@ I'm not a huge fan of how spectrwm handles keybindings, probably my biggest grip
 #+end_src
 **** Programs
 #+begin_src conf :tangle ~/.spectrwm.conf
 #+end_src
 **** Programs
 #+begin_src conf :tangle ~/.spectrwm.conf

-  program[email] = emacsclient -ce "(mu4e)"
-  program[irc] = emacsclient -ce '(switch-to-buffer "irc.armaanb.net:6698")'
+  program[email] = emacsclient -ce '(progn (switch-to-buffer "*scratch*") (mu4e))'
+  program[irc] = emacsclient -ce '(acheam-irc)'

   program[rss] = emacsclient -ce '(elfeed)'
   program[calendar] = emacsclient -ce '(acheam-calendar)'
   program[calc] = emacsclient -ce '(progn (calc) (windmove-up) (delete-window))'
   program[rss] = emacsclient -ce '(elfeed)'
   program[calendar] = emacsclient -ce '(acheam-calendar)'
   program[calc] = emacsclient -ce '(progn (calc) (windmove-up) (delete-window))'


@@ -834,15 +835,6 @@ Use the vi editing mode. I still haven't found a good way to show visual feedbac
   set -o vi
 #+end_src
 *** Functions
   set -o vi
 #+end_src
 *** Functions

-**** Interact with 0x0
-#+begin_src shell :tangle ~/.config/ash/ashrc
-  zxz="https://envs.sh"
-  ufile() { curl -F"file=@$1" "$zxz" ; }
-  upb() { curl -F"file=@-;" "$zxz" ; }
-  uurl() { curl -F"url=$1" "$zxz" ; }
-  ushort() { curl -F"shorten=$1" "$zxz" ; }
-  uclip() { xclip -out | curl -F"file=@-;" "$zxz" ; }
-#+end_src

 **** Finger
 #+begin_src shell :tangle ~/.config/ash/ashrc
   finger() {
 **** Finger
 #+begin_src shell :tangle ~/.config/ash/ashrc
   finger() {


@@ -853,9 +845,26 @@ Use the vi editing mode. I still haven't found a good way to show visual feedbac
 #+end_src
 **** Upload to ftp.armaanb.net
 #+begin_src shell :tangle ~/.config/ash/ashrc
 #+end_src
 **** Upload to ftp.armaanb.net
 #+begin_src shell :tangle ~/.config/ash/ashrc

-  pubup() {
-      rsync "$1" "root@armaanb.net:/var/ftp/pub/${2}"
-      echo "https://ftp.armaanb.net/pub/"$(basename "$1") | tee /dev/tty | xclip -sel c
+  _uprint() {
+      echo "https://l.armaanb.net/$(basename "$1")" | tee /dev/tty | xclip -sel c
+  }
+
+  _uup() {
+      rsync "$1" "root@armaanb.net:/var/ftp/pub/$2" --chmod 644
+  }
+
+  ufile() {
+      _uup "$1" "$2"
+      _uprint "$1"
+  }
+
+  uclip() {
+      tmp=$(mktemp)
+      xclip -o -sel c >> "$tmp"
+      basetmp=$(echo "$tmp" | tail -c +5)
+      _uup "$tmp" "$basetmp"
+      _uprint "$basetmp"
+      rm -f "$tmp"

   }
 #+end_src
 *** Exports
   }
 #+end_src
 *** Exports


@@ -882,6 +891,8 @@ Use the vi editing mode. I still haven't found a good way to show visual feedbac
   export LC_CTYPE="en_US.UTF-8"
   export LANGUAGE="en_US.UTF-8"
 
   export LC_CTYPE="en_US.UTF-8"
   export LANGUAGE="en_US.UTF-8"
 

+  export CDPATH=:~
+

   export KISS_PATH="/home/armaa/Virtual/kiss/home/armaa/kiss-repo"
   export KISS_PATH="$KISS_PATH:/home/armaa/Clone/repo-main/core"
   export KISS_PATH="$KISS_PATH:/home/armaa/Clone/repo-main/extra"
   export KISS_PATH="/home/armaa/Virtual/kiss/home/armaa/kiss-repo"
   export KISS_PATH="$KISS_PATH:/home/armaa/Clone/repo-main/core"
   export KISS_PATH="$KISS_PATH:/home/armaa/Clone/repo-main/extra"


@@ -905,7 +916,7 @@ Use the vi editing mode. I still haven't found a good way to show visual feedbac
 #+end_src
 **** File management
 #+begin_src shell :tangle ~/.config/ash/ashrc
 #+end_src
 **** File management
 #+begin_src shell :tangle ~/.config/ash/ashrc

-  alias ls='ls -lh --group-directories-first'
+  alias ls='LC_COLLATE=C ls -lh --group-directories-first'

   alias la='ls -A'
   alias df='df -h / /boot'
   alias du='du -h'
   alias la='ls -A'
   alias df='df -h / /boot'
   alias du='du -h'


@@ -934,13 +945,15 @@ Use the vi editing mode. I still haven't found a good way to show visual feedbac
   alias gps='gpg --keyserver keyserver.ubuntu.com --search-keys'
   alias gpp='gpg --keyserver keyserver.ubuntu.com --recv-key'
   alias plan='T=$(mktemp) && \
   alias gps='gpg --keyserver keyserver.ubuntu.com --search-keys'
   alias gpp='gpg --keyserver keyserver.ubuntu.com --recv-key'
   alias plan='T=$(mktemp) && \

-        rsync root@armaanb.net:/etc/finger/plan.txt "$T" && \
-        TT=$(mktemp) && \
-        head -n -2 $T > $TT && \
-        /bin/nvim $TT && \
-        echo "\nLast updated: $(date -R)" >> "$TT" && \
-        fold -sw 72 "$TT" > "$T"| \
-        rsync "$T" root@armaanb.net:/etc/finger/plan.txt'
+          rsync root@armaanb.net:/etc/finger/plan.txt "$T" && \
+          TT=$(mktemp) && \
+          head -n -2 $T > $TT && \
+          /bin/nvim $TT && \
+          echo >> "$TT" && \
+          echo "Last updated: $(date -R)" >> "$TT" && \
+          fold -sw 72 "$TT" > "$T"| \
+          rsync "$T" root@armaanb.net:/etc/finger/plan.txt && \
+          rm -f "$T"'

 #+end_src
 **** Virtual machines, chroots
 #+begin_src shell :tangle ~/.config/ash/ashrc
 #+end_src
 **** Virtual machines, chroots
 #+begin_src shell :tangle ~/.config/ash/ashrc