From 0cfffaef5409f99bbc4140b97b769a400b7467f8 Mon Sep 17 00:00:00 2001 From: Daniel Patterson Date: Wed, 2 Mar 2022 03:38:59 +0000 Subject: config: specify sharedir during build We should use the Makefile value of SHAREDIR when searching for config files and templates etc. This is important for systems which do not use the standard file hierarchy or which do not have a consistent location for installing program files, for example NixOS, which will have a different install location with every update. Signed-off-by: Daniel Patterson Acked-by: Robin Jarry --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e562c23a..fabed0c0 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,25 @@ To install aerc locally: # make install +By default, aerc will install config files to directories under `/usr/local/aerc`, +and will search for templates and stylesets in these locations in order: + +- `${XDG_CONFIG_HOME:-~/.config}/aerc` +- `${XDG_DATA_HOME:-~/.local/share}/aerc` +- `/usr/local/share/aerc` +- `/usr/share/aerc` + +At build time it is possible to add an extra location to this list and to use +that location as the default install location for config files by setting the +`PREFIX` option like so: + + # make PREFIX=/custom/location + # make install PREFIX=/custom/location + +This will install templates and other config files to `/custom/location/share/aerc`, +and man pages to `/custom/location/share/man`. This extra location will have lower +priority than the XDG locations but higher than the fixed paths. + ## Contribution Quick Start Anyone can contribute to aerc. First you need to clone the repository and build -- cgit