dotfiles

Dotfiles.

Table of Contents

• Description
• Installation
  • Salt
    • Pillar
      • Pillar example
  • Script
• Usage
• License

Description

Configuration and scripts targeting:

• Usability:
  • Vi keybindings for application movement
  • Emacs keybindings for command-line editing
  • XDG Specification to not clutter $HOME
• Portability:
  • POSIX compliant code
  • Drop-in configuration files
  • Tested in Qubes OS Dom0, Debian, Fedora, OpenBSD
• Tasks:
  • GUI: x11, gtk
  • SCM: git, tig, git-shell
  • Keys: gpg, ssh
  • Networking: curl, urlview, wget, w3m
  • Productivity: tmux, vim
  • Shell: sh, bash, zsh, less, dircolors

Installation

Salt

The formula is part of Qusal, which is designed to work in Qubes OS, as such, it chooses the first user name in the group qubes to place the dotfiles in. If you want a machine independent installation, choose the Script installation method.

Install everything in a qube:

sudo qubesctl --skip-dom0 --targets=QUBE state.apply dotfiles.copy-all

Install specific files in Dom0:

sudo qubesctl state.apply dotfiles.copy-dom0,dotfiles.copy-sh,dotfiles.copy-vim,dotfiles.copy-x11

Pillar

By default, all states are executed when applied. Each component can be be deactivated by configuring the corresponding pillar data to a non true value.

You will need a top and a state file in your pillar_roots. If you followed Qusal's installation instructions, it has already configured the setting for you using the value /srv/pillar/qusal. What you can do, is selectively enable or disable components.

For a complete example of a pillar state and a list of their corresponding formulas states, please refer to pillar.sls.example.

Pillar example

On the following example, we will selectively disable only the dom0 component, therefore, the state copy-dom0.sls is not applied to dom0:

Create a pillar top to apply to all targets, write it to /srv/pillar/qusal/dotfiles.top:

base:
  '*':
    - qusal.dotfiles

Then, create a pillar state do disable only dom0 states, write it to /srv/pillar/qusal/dotfiles.sls:

qusal:
  dotfiles:
    dom0: false

Add the pillar to the highstate:

sudo qubesctl top.enable qusal.dotfiles pillar=true

From now on, when calling the state copy-dom0.sls, it won't execute anything.

Script

You can simply deploy all configurations with:

./files/setup.sh

Or target specific ones by specifying the directory name:

./files/setup.sh sh bash

Note that some files might depend on other directories, specially sh which is a base for bash and zsh but might also have environment variables for net and vim. It also adds $HOME/.local/bin and $HOME/.local/bin/$HOSTNAME to the $PATH variable, so if the project has scripts, install the sh directory.

Reload your shell:

exec $SHELL

Reload you X server:

. ~/.config/x11/xprofile

You need to logout and login again for some changes to take effect.

Usage

The deployment replaces existing files and that is the goal, to make sure that we have the same configuration of every machine. Support for local configuration is implemented by including a local file per application.

Supported programs and the expected file names in $HOME:

• bash: .bashrc.local
• git: .gitconfig.local
• sh: .profile.local, .shrc.local, .config/sh/profile.d/ (.sh suffix)
• ssh: .ssh/config.d/ (.conf suffix), .ssh/known_hosts.d/ (.host suffix)
• tmux: .tmux.conf.local
• vim: .vimrc.local
• x11: .xprofile.local, .config/x11/xprofile.d/ (.sh suffix)
• zsh: .zshrc.local

License

This project is REUSE-compliant. It is difficult to list all licenses and copyrights and keep them up-to-date here.

The easiest way to get the copyright and license of the project with the reuse tool:

reuse spdx

You can also check these information manually by checking in the file header, a companion .license or in .reuse/dep5.