diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2020-05-03 21:59:46 +1200 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2020-05-03 21:59:46 +1200 |
commit | 4534b0f7ba1a537e75618e47f3925fbd73e7bf84 (patch) | |
tree | 727552735f9c0efad3f59ac0a0e8b647251c0c15 /README.md | |
parent | Merge branch 'hotfix/v8.25.2' (diff) | |
parent | Update PGP key (diff) | |
download | dotfiles-4534b0f7ba1a537e75618e47f3925fbd73e7bf84.tar.gz dotfiles-4534b0f7ba1a537e75618e47f3925fbd73e7bf84.zip |
Merge branch 'release/v8.26.0'v8.26.0
* release/v8.26.0:
Update PGP key
Update dotfiles(7) manual page
Reformat paragraphs in README.md
Remove outdated description of GnuPG config gen
Update documentation of personal mail paths
Add comment to installation dry run command
Suggest creation of recommended path in docs
Update recommended path in documentation
Remove trailing slashes from default XDG basedir
Use a dash rather than a three-period ellipsis
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 17 insertions, 24 deletions
@@ -11,12 +11,13 @@ into a personal suite of custom Unix tools. Installation ------------ - $ git clone https://sanctum.geek.nz/code/dotfiles.git ~/.dotfiles - $ cd ~/.dotfiles + $ mkdir -p ~/.local/share + $ git clone https://sanctum.geek.nz/code/dotfiles.git ~/.local/share/dotfiles + $ cd ~/.local/share/dotfiles $ git submodule init $ git submodule update $ make - $ make -n install + $ make -n install # Check output carefully $ make install For the default `all` target, you'll need a POSIX-fearing userland, including @@ -56,16 +57,16 @@ The remaining files can be installed with the other `install-*` targets. Try ### Configuration To save a set of `make` targets useful for a specific user or host, you can -save them in a newline-separated file `~/.dotfiles.conf`, and install using -that with the special `install-conf` target. This can include variable -settings, too: +save them in a newline-separated file `~/.local/share/dotfiles.conf`, and +install using that with the special `install-conf` target. This can include +variable settings, too: $ cd - $ cat .dotfiles.conf + $ cat .local/share/dotfiles.conf install-bash install-bin EMAIL=you@example.com - $ make -C .dotfiles install-conf + $ make -C .local/share/dotfiles install-conf Tools ----- @@ -115,7 +116,7 @@ Configuration is included for: * [X11](https://www.x.org/wiki/) -- Windowing system with network transparency for Unix -The configurations for shells, GnuPG, Mutt, tmux, and Vim are the most +The configurations for shells, 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. @@ -156,16 +157,16 @@ testing `BASH_VERSINFO` appropriately. A terminal session with my prompt looks something like this: ~$ ssh remote - remote:~$ cd .dotfiles - remote:~/.dotfiles(master+!)$ git status + remote:~$ cd .local/share/dotfiles + remote:~/.local/share/dotfiles(master+!)$ git status M README.md M bash/bashrc.d/prompt.bash A init - remote:~/.dotfiles(master+!)$ foobar + remote:~/.local/share/dotfiles(master+!)$ foobar foobar: command not found - remote:~/.dotfiles(master+!)<127>$ sleep 5 & + remote:~/.local/share/dotfiles(master+!)<127>$ sleep 5 & [1] 28937 - remote:~/.dotfiles(master+!){1}$ + remote:~/.local/share/dotfiles(master+!){1}$ The hostname is elided if not connected via SSH. The working directory with tilde abbreviation for `$HOME` is always shown. The rest of the prompt expands @@ -290,18 +291,10 @@ These are experimental; I do not like Z shell much at the moment. The files started as a joke (`exec bash`). `zsh` shells default to having a prompt colored cyan. -### GnuPG - -The configuration for GnuPG is intended to follow [RiseUp's OpenPGP best -practices](https://riseup.net/en/security/message-security/openpgp/best-practices). -The configuration file is rebuilt using `mi5(1df)` 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. - ### Mutt -My mail is kept in individual Maildirs under `~/Mail`, with `inbox` being where -most unfiltered mail is sent. I use +My mail is kept in individual Maildirs under `~/mail`, with the system mail +spool in e.g. `/var/mail/tejr` being where most unfiltered mail is sent. I use [Getmail](http://pyropus.ca/software/getmail/), [maildrop](https://www.courier-mta.org/maildrop/), and [msmtp](https://marlam.de/msmtp/); the configurations for these are not |