➡ Moved to Codeberg

This repository now lives at https://codeberg.org/scy/dotfiles. See Why are you leaving GitHub? for my reasons. Please update your bookmarks accordingly and/or notify the creator(s) of whatever brought you here.

dotfiles

Good Unix tools are configured by files written by the user, so-called dotfiles. Bad tools are configured by databases and GUIs. This repository tries to apply my preferred settings to both of them.

What's configured

• bash environment
• Git
• Karabiner-Elements
• keyboard layout on macOS (manually)
• OpenSSH
• Terminal.app (manually)
• Termux
• tmux
• unicompose
• Vim (needs to be fleshed out further)
• Visual Studio Code

Status

This is currently replacing dotscy in order to have a fresh start. The old repo contained a lot of configs for tools that I no longer use, even fonts and binaries that I don't want anymore, but still had in the history.

These settings have been in use on macOS and Debian/Ubuntu (in WSL and standalone); they should run on other Unixes as well.

Setting up

Instead of symlinking lots of files into your home directory, this repository is supposed to be your home directory. This has the added benefit of you being aware (via git status) of new config files that some tool might generate.

The setup procedure will clone the repo into a subdir of your home, then moving everything in it (including .git) directly into your home dir. Files/directories that would be overwritten will be backed up to ~/.orig_home.

Termux

Install required (and my favorite) packages and setup storage access.

pkg install curl git neovim perl rsync termux-api &&
termux-setup-storage

Then, continue as described below in the "Unix" section.

Ubuntu / Debian

Install required packages.

sudo apt update            &&
sudo apt install git rsync

These might also make sense:

sudo apt install scdaemon vim

When I might be working on the machine primarily via the text-only console (e.g. on Raspberry Pis), styling that console might be a good thing, too. I prefer these settings in /etc/default/console-setup:

CHARMAP="UTF-8"
CODESET="Uni2"
FONTFACE="Fixed"
FONTSIZE="8x16"

Also, to get my Sihaya color scheme in the console, I add these values to the kernel command line (/boot/cmdline.txt on a Pi):

vt.default_red=36,207,74,195,0,145,0,205,83,255,112,255,0,197,0,255 vt.default_grn=35,0,166,127,112,0,147,198,81,0,249,166,140,0,220,247 vt.default_blu=32,0,9,0,203,188,165,178,76,0,13,0,255,255,247,226

Then, continue as described below in the "Unix" section.

Windows

Install Git for Windows. Then, in a command prompt at your home directory, run

git clone --recurse-submodules https://github.com/scy/dotfiles.git

Afterwards, symlink VS Code's settings.json as described in it.

Unix

which rsync > /dev/null                                             &&
umask 0022 && cd                                                    &&
test ! -e .orig_home                                                &&
git clone --recurse-submodules https://github.com/scy/dotfiles.git  &&
rsync -avb --backup-dir=.orig_home dotfiles/ .                      &&
rm -rf dotfiles

Hint: If you'd like to run these commands on a machine you can't copy/paste to, you can extract and run that section of the readme using this piece of sed magic:

curl -sL raw.githubusercontent.com/scy/dotfiles/master/README.md | sed -n '/^### Unix$/,/^```$/ { /```/d; p }' | sh

Manual configuration

Although I'm aiming to automate as much as possible with this repo, for some things it's currently too complicated, at least at the moment. Maybe I'll add automation scripts in the future, but right now it's not worth the effort.

On machines without HTTPS push to GitHub

On some machines, especially those without full disk encryption, I don’t want to store GitHub credentials directly on disk. Instead, I configure them to clone (anonymously) via HTTPS, but push via SSH:

git config -f ~/.gitconfig-local url.ssh://git@github.com/.pushInsteadOf https://github.com/

On a Mac

• Install Karabiner-Elements.
• Change the keyboard layout to US English. Not US International, because this results in dead keys which massively disturb my programming flow.
• In Terminal.app:
  • on startup, new window with Pro
  • change default profile to Pro
  • in the Window tab of the profile, change the default size to 160x40
  • in the Shell tab of the profile, change the setting to close the window when the shell exits without error

On Windows

• The default Windows console doesn't provide a visual bell, but the audible one is annoying. Therefore, mash Backspace in a bash for a few times to produce an audible bell. Then, right-click on the volume symbol in the task bar, choose "Open Volume Mixer" and mute "Console Window Host".
• See settings.json for instructions on how to symlink the VS Code settings from this repo into %APPDATA%.