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=.
---
doc/build.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
(limited to 'doc')
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