Dotfiles (Tom Ryder)
This is my personal repository of configuration files and scripts for `$HOME`,
including most of the settings that migrate well between machines.
$ git clone https://sanctum.geek.nz/code/dotfiles.git ~/.dotfiles
$ cd ~/.dotfiles
$ git submodule init
$ git submodule update
$ make -n install
$ make install
For the default `all` target, you'll need `git(1)`, `install(1)`, `make(1)`,
and `m4(1)`. This target includes the Bash files, but you don't need `bash` to
actually install them, and the rest of the shell configuration should work
The installation `Makefile` will overwrite things standing in the way of its
installed files without backing them up, so read the output of `make -n
install` before running `make install` to make sure you aren't going to lose
anything unexpected. If you're still not sure, install it in a temporary
directory so you can explore:
$ tmpdir=$(mktemp -d)
$ make install HOME="$tmpdir"
$ env -i HOME="$tmpdir" TERM="$TERM" bash -l
The default target will install the core terminal-only files: cURL, Git, GnuPG,
Vim, shell scripts and functions, and shell and terminal setup files. The
remaining dotfiles can be installed with the other targets. Take a look at the
`Makefile` to see what's available.
Configuration is included for:
* [Abook](http://abook.sourceforge.net/) -- curses address book program
* [Bash](https://www.gnu.org/software/bash/) -- GNU Bourne-Again Shell,
including a `~/.profile` configured to work with most Bourne-compatible
* [cURL](https://curl.haxx.se/) -- Command-line tool for transferring data with
* [Dunst](http://knopwob.org/dunst/) -- A lightweight X11 notification daemon
that works with `libnotify`
* `finger(1)` -- User information lookup program
* [Git](https://git-scm.com/) -- Distributed version control system
* [GnuPG](https://www.gnupg.org/) -- GNU Privacy Guard, for private
communication and file encryption
* [GTK+](http://www.gtk.org/) -- GIMP Toolkit, for graphical user interface
* [i3](https://i3wm.org/) -- Tiling window manager
* [Mutt](http://www.mutt.org/) -- Terminal mail user agent
* [`mysql(1)`](http://linux.die.net/man/1/mysql) -- Command-line MySQL client
* [Ncmpcpp](https://rybczak.net/ncmpcpp/) -- ncurses music player client
* [Newsbeuter](https://www.newsbeuter.org/) -- Terminal RSS/Atom feed reader
* [`pdksh(1)`](http://www.cs.mun.ca/~michael/pdksh/) -- public domain fork
of the Korn shell
* [`psql(1)`](http://linux.die.net/man/1/psql) -- Command-line PostgreSQL
* [Perl::Critic](http://perlcritic.com/) -- static source code analysis engine
* [Perl::Tidy](http://perltidy.sourceforge.net/) -- Perl indenter and
* [Readline](https://cnswww.cns.cwru.edu/php/chet/readline/rltop.html) -- GNU
library for user input used by Bash, MySQL, and others
* [rxvt-unicode](http://software.schmorp.de/pkg/rxvt-unicode.html) -- Fork of
the rxvt terminal emulator with Unicode support
* [Subversion](https://subversion.apache.org/) -- Apache Subversion, a version
* [tmux](https://tmux.github.io/) -- Terminal multiplexer similar to GNU
* [Vim](http://www.vim.org/) -- Vi IMproved, a text editor
* [Wyrd](https://packages.debian.org/sid/wyrd) -- a `curses` calendar
frontend for [Remind](https://www.roaringpenguin.com/products/remind)
* [X11](https://www.x.org/wiki/) -- Windowing system with network transparency
* [Zsh](https://www.zsh.org/) -- Bourne-style shell designed for interactive
The configurations for Bash, GnuPG, Mutt, tmux, and Vim are the most expansive
and most likely to be of interest. The i3 configuration is mostly changed to
make window switching behave like Vim windows and tmux panes do, and there's a
fair few resources defined for rxvt-unicode. Otherwise, the rest of the
configuration isn't too distant from the defaults.
My `.profile` and other files in `sh` are written in POSIX shell script, so
they should work in most `sh(1)` implementations. Individual scripts called by
`.profile` are saved in `.profile.d` and iterated on login for ease of
management. All of these boil down to exporting variables appropriate to the
system and the software it has available.
I make an effort to target POSIX for my functions and scripts where I can, but
Bash is my interactive shell of choice.
My `.bash_profile` calls `.profile`, and then `.bashrc`, which only applies for
interactive shells. Subscripts for `.bashrc` are loaded from `.bashrc.d`. The
contents of the `*.d` directories changes depending on the host, so only
specific scripts in it are versioned.
As I occasionally have work on very old internal systems, my Bash is written to
work with [any version 2.05a or
newer](http://wiki.bash-hackers.org/scripting/bashchanges). This is why I use
older syntax for certain things such as appending items to arrays:
Compare this to the much nicer syntax available since 3.1-alpha1, which
actually works for arrays with sparse indexes, unlike the above syntax:
Where I do use features that are only available in versions of Bash newer than
2.05a, such as newer `shopt` options or `PROMPT_DIRTRIM`, they are only run
after testing `BASH_VERSINFO` appropriately.
When I use any other Bourne-compatible shell, I'm generally happy to accept its
defaults for interactive behavior.
A terminal session with my prompt looks something like this:
~$ ssh remote
tom@remote:~$ cd .dotfiles
tom@remote:~/.dotfiles(master+!)$ git status
foobar: command not found
tom@remote:~/.dotfiles(master+!)<127>$ sleep 5 &
The username and hostname are skipped if not connected via SSH. The right side
of the prompt expands based on context to include these elements in this order:
* Whether in a Git repository if applicable, and punctuation to show
repository status including reference to upstreams at a glance. Subversion
support can also be enabled (I need it at work), in which case a `git:` or
`svn:` prefix is added appropriately
* The number of running background jobs, if non-zero
* The exit status of the last command, if non-zero
You can set `PROMPT_COLOR`, `PROMPT_PREFIX`, and `PROMPT_SUFFIX` too, which all
do about what you'd expect.
This is all managed within the `prompt` function. There's some mildly hacky
logic on `tput` codes included such that it should work correctly for most
common terminals using both `termcap(5)` and `terminfo(5)`, including \*BSD
systems. It's also designed to degrade gracefully for eight-color and no-color
If a function can be written in POSIX `sh` without too much hackery, I put it
in `sh/shrc.d` to be loaded by any POSIX interactive shell. Those include:
* `bc()` silences startup messages from GNU `bc(1)`.
* `bd()` changes into a named ancestor of the current directory.
* `diff()` forces the unified format for `diff(1)`.
* `ed()` tries to get verbose error messages, a prompt, and a Readline
environment for `ed(1)`.
* `env()` sorts the output of `env(1)` if it was invoked with no arguments,
because the various shells have different ways of listing exported
* `gdb()` silences startup messages from `gdb(1)`.
* `gpg()` quietens `gpg(1)` down for most commands.
* `grep()` tries to apply color and other options good for interactive use,
depending on the capabilities of the system `grep(1)`.
* `hgrep()` allows searching `$HISTFILE`.
* `keychain()` keeps `$GPG_TTY` up to date if a GnuPG agent is available.
* `lhn()` gets the history number of the last command, if the POSIX `fc`
builtin is available.
* `ls()` tries to apply color to `ls(1)` for interactive use if available.
* `la()` runs `ls -A` if it can, or `ls -a` otherwise.
* `ll()` runs `ls -Al` if it can, or `ls -al` otherwise.
* `mkcd()` creates a directory and changes into it.
* `mysql()` allows shortcuts to MySQL configuration files stored in
* `path()` manages the contents of `PATH` conveniently.
* `pd()` changes to the argument's parent directory.
* `pwgen()` generates just one decent password with `pwgen(1)`.
* `rcsdiff()` forces a unified format for `rcsdiff(1)`.
* `rd()` replaces the first instance of its first argument with its second
argument in `$PWD`, emulating a feature of the Zsh `cd` builtin that I
* `scp()` tries to detect forgotten hostnames in `scp(1)` command calls.
* `scr()` creates a temporary directory and changes into it.
* `sd()` changes into a sibling of the current directory.
* `sudo()` forces `-H` for `sudo(8)` calls so that `$HOME` is never
preserved; I hate having `root`-owned files in my home directory.
* `tmux()` changes the default command for `tmux(1)` to `attach-session -d`
if a session exists, or creates a new session if one doesn't.
* `ud()` changes into an indexed ancestor of a directory.
* `vim()` defines three functions to always use `vim(1)` as my `ex(1)`,
`vi(1)` and `view(1)` implementation if it's available.
* `vr()` tries to change to the root directory of a source control
There are a few other little tricks defined for other shells, mostly in
* `keep()` stores ad-hoc shell functions and variables.
* `prompt()` sets up my interactive prompt.
* `pushd()` adds a default destination of `$HOME` to the `pushd` builtin.
* `vared()` allows interactively editing a variable with Readline, emulating
a Zsh function I like by the same name.
I find the `bash-completion` package a bit too heavy for my tastes, and turn it
off using a stub file installed in `.config/bash_completion`. The majority of
the time I just want to complete paths anyway, and this makes for a quicker
startup without a lot of junk functions in my Bash namespace.
I do make some exceptions with completions defined in `.bash_completion.d`
files for things I really do get tired of typing repeatedly:
* Builtins, commands, help topics, shell options, and variables
* `ftp(1)` hostnames from `~/.netrc`
* `git(1)` branch names
* `gpg(1)` long options
* `make(1)` targets read from a `Makefile`
* `man(1)` page titles
* `mysql(1)` databases from `~/.mysql/*.cnf`
* `pass(1)` entries
* `ssh(1)` hostnames from `~/.ssh/config`
I also add completions for my own scripts and functions where useful. The
completions are dynamically loaded if Bash is version 4.0 or greater.
Otherwise, they're all loaded on startup.
The pdksh configuration files and functions are not nearly as featureful as the
Bash ones. They're tested on OpenBSD and FreeBSD pdksh implementations, but the
former is the primary system for which I'm maintaining them, and there are some
These are experimental; I do not like Zsh much at the moment. The files started
as a joke (`exec bash`).
The configuration for GnuPG is intended to follow [RiseUp's OpenPGP best
The configuration file is rebuilt using `m4(1)` and `make(1)` because it
requires hard-coding a path to the SKS keyserver certificate authority, and
neither tilde nor `$HOME` expansion works for this.
My mail is kept in individual Maildirs under `~/Mail`, with `inbox` being where
most unfiltered mail is sent. I use
[MSMTP](http://msmtp.sourceforge.net/); the configurations for these are not
included here. I sign whenever I have some indication that the recipient might
be using a PGP implementation, and I encrypt whenever I have a public key
available for them. The GnuPG interfacing is done with
[GPGme](https://www.gnupg.org/related_software/gpgme/), rather than defining
commands for each crypto operation. I wrote [an article about this
setup](https://sanctum.geek.nz/arabesque/linux-crypto-email/) if it sounds
You'll need [Abook](http://abook.sourceforge.net/) installed if you want to use
the `query_command` I have defined, and [msmtp](http://msmtp.sourceforge.net/)
for the `sendmail` command.
I've butchered the URxvt Perl extensions `selection-to-clipboard` and
`selection` into a single `select` extension in `~/.urxvt/ext`, which is the
only extension I define in `~/.Xresources`.
The included `.Xresources` file assumes that `urxvt` can use 256 colors and
Perl extensions. If you're missing functionality, try changing
`perl-ext-common` to `default`.
My choice of font is [Ubuntu Mono](http://font.ubuntu.com/), but the file
should allow falling back to the more common [Deja Vu Sans
Mono](http://dejavu-fonts.org/wiki/Main_Page). I've found
[Terminus](http://terminus-font.sourceforge.net/) works well too, but bitmap
fonts are not really my cup of tea. The Lohit Kannada font bit is purely to
make ಠ\_ಠ work correctly. ( ͡° ͜ʖ ͡°) seems to work out of the box.
These are just generally vi-friendly settings, not much out of the ordinary.
Note that the configuration presently uses a hard-coded 256-color colorscheme,
and uses non-login shells, with an attempt to control the environment to stop
shells thinking they have access to an X display.
The configuration file is created with `m4(1)` to allow specifying a colour
theme. This is just because I use a different colour for my work session. The
default is a dark grey.
The configuration for Bash includes a `tmux` function designed to make `attach`
into the default command if no arguments are given and sessions do already
exist. The default command is normally `new-session`.
The majority of the `.vimrc` file is just setting options, with a few mappings.
I try not to deviate too much from the Vim defaults behaviour in terms of
interactive behavior and keybindings.
The configuration is extensively commented, mostly because I was reading
through it one day and realised I'd forgotten what half of it did. Plugins are
loaded using @tpope's [pathogen.vim](https://github.com/tpope/vim-pathogen).
Where practical, I make short scripts into POSIX (but not Bourne) `sh(1)`,
`awk(1)`, or `sed(1)` scripts in `~/.local/bin`. A few of them still have
Bashisms for various reasons. I try to use shell functions only when I actually
need to, which tends to be when I need to tinker with the namespace of the
user's current shell.
Installed by the `install-bin` target:
* Three SSH-related scripts:
* `sls(1)` prints hostnames read from a `ssh_config(5)` file. It uses
`slsf(1)` to read each one.
* `sra(1)` runs a command on multiple hosts read from `sls(1)` and prints
* `sta(1)` runs a command on multiple hosts read from `sls(1)` and prints
the hostname if the command returns zero.
* Five URL-related shortcut scripts:
* `hurl(1)` extracts values of `href` attributes of `<a>` tags, sorts
them uniquely, and writes them to `stdout`; it requires
* `murl(1)` converts Markdown documents to HTML with `pandoc(1)` and
runs the output through `hurl(1)`.
* `urlc(1)` accepts a list of URLs on `stdin` and writes error messages
to `stderr` if any of the URLs are broken, redirecting, or are insecure
and have working secure versions; requires `curl(1)`.
* `urlh(1)` prints the values for a given HTTP header from a HEAD
* `urlmt(1)` prints the MIME type from the `Content-Type` header as
retrieved by `urlh(1)`.
* Three RFC-related shortcut scripts:
* `rfcf(1)` fetches ASCII RFCs from the IETF website.
* `rfct(1)` formats ASCII RFCs.
* `rfcr(1)` does both, displaying in a pager if appropriate, like a
`man(1)` reader for RFCs.
* Five toy random-number scripts (not for sensitive/dead-serious use):
* `rndi(1)` gets a random integer within two bounds.
* `rnds(1)` attempts to get an optional random seed for `rndi(1)`.
* `rnda(1)` uses `rndi(1)` to choose a random argument.
* `rndf(1)` uses `rnda(1)` to choose a random file from a directory.
* `rndl(1)` uses `rndi(1)` to choose a random line from files.
* Four file formatting scripts:
* `d2u(1)` converts DOS line endings in files to UNIX ones.
* `u2d(1)` converts UNIX line endings in files to DOS ones.
* `stbl(1)` strips a trailing blank line from the files in its arguments.
* `stws(1)` strips trailing spaces from the ends of lines of the files in
* Five stream formatting scripts:
* `sd2u(1)` converts DOS line endings in streams to UNIX ones.
* `su2d(1)` converts UNIX line endings in streams to DOS ones.
* `tl(1)` tags input lines with a prefix or suffix, basically a `sed(1)`
* `tlcs(1)` executes a command and uses `tl(1)` to tag stdout and stderr
lines, and color them if you want.
* `unf(1)` joins lines with leading spaces to the previous line. Intended
for unfolding HTTP headers, but it should work for most RFC 822
* `apf(1)` prepends arguments to a command with ones read from a file,
intended as a framework for shell wrappers or functions.
* `ax(1)` evaluates an awk expression given on the command line; this is
intended as a quick way to test how Awk would interpret a given expression.
* `bel(1)` prints a terminal bell character.
* `br(1)` launches `$BROWSER`, or a more suitable application for an URL if
it knows of one.
* `ca(1)` prints a count of its given arguments.
* `cf(1)` prints a count of entries in a given directory.
* `clrd(1)` sets up a per-line file read, clearing the screen first.
* `clwr(1)` sets up a per-line file write, clearing the screen before each line
* `dmp(1)` copies a pass(1) entry selected by `dmenu(1)` to the X CLIPBOARD.
* `dub(1)` lists the biggest entries in a directory.
* `edda(1)` provides a means to run `ed(1)` over a set of files preserving
any options, mostly useful for scripts.
* `eds(1)` edits executable script files in `EDSPATH`, defaulting to
`~/.local/bin`, for personal scripting snippets.
* `fgscr(1)` finds Git repositories in a directory root and scrubs them with
* `fnl(1)` runs a command and saves its output and error into temporary files,
printing their paths and line counts
* `gms(1)` runs a set of `getmailrc` files; does much the same thing as the
script `getmails` in the `getmail` suite, but runs the requests in parallel
and does up to three silent retries using `try(1)`.
* `grc(1)` quietly tests whether the given directory appears to be a Git
repository with pending changes.
* `gscr(1)` scrubs Git repositories.
* `han(1)` provides a `keywordprg` for Vim's Bash script filetype that will
look for `help` topics. You could use it from the shell too.
* `igex(1)` wraps around a command to allow you to ignore error conditions
that don't actually worry you, exiting with 0 anyway.
* `isgr(1)` quietly tests whether the given directory appears to be a Git
* `jfc(1)` adds and commits lazily to a Git repository.
* `jfcd(1)` watches a directory for changes and runs `jfc(1)` if it sees any.
* `maybe(1)` is like `true(1)` or `false(1)`; given a probability of success,
it exits with success or failure. Good for quick tests.
* `mkcp(1)` creates a directory and copies preceding arguments into it.
* `mkmv(1)` creates a directory and moves preceding arguments into it.
* `motd(1)` shows the system MOTD.
* `pa(1)` prints its arguments, one per line.
* `paz(1)` print its arguments terminated by NULL chars.
* `pit(1)` runs its input through a pager if its standard output looks like a
* `plmu(1)` retrieves a list of installed modules from
[`plenv`](https://github.com/tokuhirom/plenv), filters out any modules in
`~/.plenv/non-cpan-modules`, and updates them all.
* `rmrej(1)` deletes rejected hunks from a failed `patch(1)` run.
* `shb(1)` attempts to build shebang lines for scripts from `$PATH`.
* `spr(1)` posts its input to the sprunge.us pastebin.
* `sshi(1)` prints human-readable SSH connection details.
* `stex(1)` strips extensions from filenames.
* `sue(8)` execs `sudoedit(8)` as the owner of all the file arguments given,
perhaps in cases where you may not necessarily have `root` `sudo(8)`
* `td(1)` manages a to-do file for you with `$EDITOR` and `git(1)`; I used to
use Taskwarrior, but found it too complex and buggy.
* `try(1)` repeats a command up to a given number of times until it succeeds,
only printing error output if all three attempts failed. Good for
tolerating blips or temporary failures in `cron(8)` scripts.
There's some silly stuff in `install-games`:
* `aaf(6)` gets a random [ASCII Art Farts](http://www.asciiartfarts.com/)
* `acq(6)` allows you to interrogate AC, the interplanetary computer.
* `kvlt(6)` translates input to emulate a style of typing unique to black
metal communities on the internet.
* `rndn(6)` implements an esoteric random number generation algorithm.
* `zs(6)` prepends "z" case-appropriately to every occurrence of "s" in the
text on its standard input.
The `install-bin` and `install-games` targets install manuals for each script
they install. There's also an `install-dotfiles-man` target that uses
`pandoc(1)` to reformat this document as a manual page for section 7
(`dotfiles(7)`) if you want that. I haven't made that install by default,
because `pandoc(1)` is a bit heavy.
If you want to use the manuals, you may need to add `~/.local/share/man` to
your `/etc/manpath` configuration, depending on your system.
You can check that both sets of shell scripts are syntactically correct with
`make check-bash`, `make check-sh`, or `make check` for everything including
the scripts in `bin` and `games`. There's no proper test suite for the actual
If you have [ShellCheck](https://www.shellcheck.net/) and/or
[Perl::Critic](http://perlcritic.com/), there's a `lint` target for the shell
script files and Perl files respectively. The files don't need to pass that
check to be installed.
Note for previous visitors
Most of this repository's five-year history was rewritten shortly after I moved
it from GitHub to cgit, taking advantage of the upheaval to reduce its size and
remove useless binary blobs and third-party stuff that I never should have
versioned anyway. If you've checked this out before, you'll probably need to do
it again, and per-commit links are likely to be broken. Sorry about that.
Public domain; see the included `UNLICENSE` file. It's just configuration and
simple scripts, so do whatever you like with it if any of it's useful to you.
If you're feeling generous, please join and/or donate to a free software
advocacy group, and let me know you did it because of this project:
* [Free Software Foundation](https://www.fsf.org/)
* [Software in the Public Interest](http://www.spi-inc.org/)
* [OpenBSD Foundation](http://www.openbsdfoundation.org/)