README.org (2858B)
1 #+TITLE:README 2 3 This is my repo of literate system configuration files. 4 5 It provides the following: 6 7 8 * [[file:email.org][email config]] 9 10 Setting up [[http://isync.sourceforge.net][mbsync]], [[https://marlam.de/msmtp][msmtp]], and [[https://notmuchmail.org][notmuch]]. 11 12 * [[file:terminal.org][tty setup]] 13 14 Config files for bash and readline. 15 16 * [[file:screen.org][GNU screen]] 17 18 Some setup for [[https://www.gnu.org/software/screen][GNU Screen]], including a nice status line, and some 19 emacsy keybindings 20 21 * [[file:nethack.org][Nethack config]] 22 23 A simple curses configuration for one of the [[https://www.nethack.org/index.html][most complicated games of 24 all time]] 25 26 * [[file:vimb.org][Vimb configuration]] 27 28 EWW is usually enough for me, but when you need some javascript you 29 may as well use an extensible keyboard-based browser like [[https://fanglingsu.github.io/vimb][Vimb]]. 30 31 * [[file:mpd.org][minimal mpd setup]] 32 33 [[https://www.musicpd.org][MPD]] doesn't require much setup, so this just changes some default 34 directories. 35 36 * [[file:dunst.org][Dunst config]] 37 38 [[https://dunst-project.org/][Dunst]] is a simple notification daemon. My config makes it a small 39 popup in the bottom right-hand side, with a dark background and white 40 monospaced text. 41 42 * [[file:xorg.org][Xorg settings]] 43 44 =xinitrc= which loads the dvorak keyboard layout, disables the mouse, 45 starts dunst, then starts either emacs or twm. 46 47 =sxhkdrc= with volume/brightness controls, and a lockscreen. 48 49 ** [[file:ratpoison.org][Ratpoison config]] 50 51 High contrast colours, terminus font, =s-t= as the prefix key. As well 52 as a guile script which enables/disables the border depending on how 53 many frames there are. 54 55 ** [[file:twm.org][twm config]] 56 57 - Specific colours for the programs I use most. 58 - Menus for editors, window managers, dmenu scripts. 59 - Some customised key and mouse bindings. 60 61 * [[file:Makefile][A Makefile to put it all together]] 62 63 ** Generating the output 64 65 Files that go in $HOME are tangled to the directory =out/=, and files 66 that go into $XDG_CONFIG_HOME are tangled to =xdg-config/=. 67 68 To do this, run the following command. 69 70 #+begin_src shell 71 make all 72 #+end_src 73 74 You can also only tangle specific files. For example, to tangle only 75 [[file:email.org][email.org]], run the following. 76 77 #+begin_src shell 78 make email 79 #+end_src 80 81 ** Installing the output in the right place 82 83 To install all these files using stow, run the following. 84 85 #+begin_src shell 86 # Install all files 87 make install 88 89 # Install files that end up in $XDG_CONFIG_HOME 90 make xdg-install 91 92 # Install file that ned up in $HOME 93 make home-install 94 #+end_src 95 96 ** Uninstalling 97 98 If you decide to give up, you can do the following: 99 100 #+begin_src shell 101 # Uninstall all files 102 make uninstall 103 104 # Uninstall files in $XDG_CONFIG_HOME 105 make xdg-uninstall 106 107 # Uninstall files in $HOME 108 make home-uninstall 109 #+end_src