aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/configure.local.example
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2021-08-07 13:02:10 +0000
committerIngo Schwarze <schwarze@openbsd.org>2021-08-07 13:02:10 +0000
commitae3479c0b3b054123f6cd2e229271f9435c958de (patch)
tree5ef1b6ffc6c6d69d73bd3a98f92fa8bf50eee136 /configure.local.example
parent7b94adabd443dc8d33b11c14f66e46f48100de1c (diff)
downloadmandoc-ae3479c0b3b054123f6cd2e229271f9435c958de.tar.gz
mandoc-ae3479c0b3b054123f6cd2e229271f9435c958de.tar.zst
mandoc-ae3479c0b3b054123f6cd2e229271f9435c958de.zip
Rename the compile-time configuration variable $HOMEBREWDIR to
$READ_ALLOWED_PATH, allow it to contain more than one directory, and explain how to use it for NixOS and for GNU Guix Linux. Feature improvement based on observations, input, and earlier patches from Lukas Epple <sternenseemann at systemli dot org>, and final patch also tested by Lukas.
Diffstat (limited to 'configure.local.example')
-rw-r--r--configure.local.example28
1 files changed, 21 insertions, 7 deletions
diff --git a/configure.local.example b/configure.local.example
index b717e477..7bd5bb5e 100644
--- a/configure.local.example
+++ b/configure.local.example
@@ -1,4 +1,4 @@
-# $Id: configure.local.example,v 1.39 2020/07/20 16:57:30 schwarze Exp $
+# $Id: configure.local.example,v 1.40 2021/08/07 13:02:10 schwarze Exp $
#
# Copyright (c) 2014-2019 Ingo Schwarze <schwarze@openbsd.org>
#
@@ -209,14 +209,28 @@ INSTALL_LIB="${INSTALL} -m 0444"
INSTALL_MAN="${INSTALL} -m 0444"
INSTALL_DATA="${INSTALL} -m 0444"
-# When using the "homebrew" package manager on Mac OS X, the actual
-# manuals are located in a so-called "cellar" and only symlinked
-# into the manual trees. To allow mandoc to follow such symlinks,
-# you have to specify the physical location of the cellar as returned
-# by realpath(3), for example:
+# By default, makewhatis(8) can only read from the paths passed on the
+# command line or configured in man.conf(5).
+# But some package managers on some operating systems store manual pages
+# in separate "cellar" or "store" directories and only symlink them
+# into the manual trees.
+# To support one or more such package managers, give makewhatis(8)
+# read access to the cellars and stores on your system, in the form
+# of a colon-separated path:
+# Homebrow package manager on Mac OS X:
PREFIX="/usr/local"
-HOMEBREWDIR="${PREFIX}/Cellar"
+READ_ALLOWED_PATH="${PREFIX}/Cellar"
+
+# Nix package manager and/or NixOS Linux distribution:
+READ_ALLOWED_PATH="/nix/store"
+
+# GNU Guix package manager and/or GNU Guix Linux distribution:
+READ_ALLOWED_PATH="/gnu/store"
+
+# If multiple package managers are used concurrently:
+PREFIX="/usr/local"
+READ_ALLOWED_PATH="/nix/store:${PREFIX}/Cellar"
# --- user settings for the mandoc(3) library --------------------------