From 4d36557a007f06196affe14afd1a2bd2a4945c44 Mon Sep 17 00:00:00 2001
From: Guilhem Moulin <guilhem@fripost.org>
Date: Wed, 23 Feb 2022 20:00:28 +0100
Subject: Document how to install without root privileges.

And make location for systemd user unit files configurable with
systemd_userunitdir=.
---
 Makefile     |  7 ++++---
 doc/build.md | 27 +++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 14656c4..7bcda70 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,7 @@ sitelib ?= $(libdir)/site_perl
 datarootdir ?= $(prefix)/share
 mandir ?= $(datarootdir)/man
 man1dir ?= $(mandir)/man1
+systemd_userunitdir ?= $(libdir)/systemd/user
 
 CSS ?= /usr/share/javascript/bootstrap4/css/bootstrap.css
 HTML_TEMPLATE ?= $(srcdir)/doc/template.html
@@ -89,11 +90,11 @@ install: install-nodoc
 install-nodoc: all-nodoc
 	$(INSTALL_PROGRAM) -vDt $(DESTDIR)$(bindir) $(builddir)/interimap $(builddir)/pullimap
 	$(INSTALL_DATA) -vDT $(srcdir)/lib/Net/IMAP/InterIMAP.pm $(DESTDIR)$(sitelib)/Net/IMAP/InterIMAP.pm
-	$(INSTALL_DATA) -vDt $(DESTDIR)$(libdir)/systemd/user $(SERVICE_FILES)
+	$(INSTALL_DATA) -vDt $(DESTDIR)$(systemd_userunitdir) $(SERVICE_FILES)
 
 uninstall:
-	rm -vf -- $(DESTDIR)$(bindir)/interimap $(DESTDIR)$(man1dir)/interimap.1 $(DESTDIR)$(libdir)/systemd/user/interimap*.service
-	rm -vf -- $(DESTDIR)$(bindir)/pullimap $(DESTDIR)$(man1dir)/pullimap.1 $(DESTDIR)$(libdir)/systemd/user/pullimap*.service
+	rm -vf -- $(DESTDIR)$(bindir)/interimap $(DESTDIR)$(man1dir)/interimap.1 $(DESTDIR)$(systemd_userunitdir)/interimap*.service
+	rm -vf -- $(DESTDIR)$(bindir)/pullimap $(DESTDIR)$(man1dir)/pullimap.1 $(DESTDIR)$(systemd_userunitdir)/pullimap*.service
 	rm -vf -- $(DESTDIR)$(sitelib)/Net/IMAP/InterIMAP.pm
 	rm -rvf -- $(DESTDIR)$(datarootdir)/doc/interimap $(DESTDIR)$(datarootdir)/doc/pullimap
 
diff --git a/doc/build.md b/doc/build.md
index 6c812dc..1936c13 100644
--- a/doc/build.md
+++ b/doc/build.md
@@ -71,6 +71,33 @@ The `doc` target generates all documentation, manuals as well as HTML
 pages.
 
 
+Installation without root privileges
+====================================
+
+By default `` `make install` `` installs [`interimap`(1)] under
+`/usr/local`, hence requires root privileges.  However another prefix
+can be used in order to perform the (un)installation as an unprivileged
+user.  For instance
+
+    $ install -m0700 -vd "${XDG_DATA_HOME:-~/.local/share}/interimap"
+    $ make install-nodoc \
+		prefix=~/.local \
+		sitelib="${XDG_DATA_HOME:-~/.local/share}/interimap/lib" \
+		systemd_userunitdir="${XDG_DATA_HOME:-~/.local/share}/systemd/user"
+
+skips documentation and installs
+
+  * executables into `~/.local/bin` (instead of `/usr/local/bin`);
+  * libraries into `$XDG_DATA_HOME/interimap/lib` or `~/.local/share/interimap/lib`
+    (instead of `/usr/local/lib/site_perl`); and
+  * [systemd user unit files][`systemd.unit`(5)] into `$XDG_DATA_HOME/systemd/user`
+    or `~/.local/share/systemd/user` (instead of `/usr/local/lib/systemd/user`).
+
+Note that for uninstallation one must call `` `make uninstall prefix=…` ``
+with the very same assignment(s) used for installation.
+
+[`systemd.unit`(5)]: https://www.freedesktop.org/software/systemd/man/systemd.unit.html
+
 Build custom Debian packages
 ============================
 
-- 
cgit v1.2.3