summaryrefslogtreecommitdiffstats
path: root/contrib/mdocml/INSTALL
diff options
context:
space:
mode:
authorgjb <gjb@FreeBSD.org>2016-01-20 09:50:54 +0000
committergjb <gjb@FreeBSD.org>2016-01-20 09:50:54 +0000
commit37e4197e4f1c5dfdc9f6f47c3e2eaa08db678932 (patch)
treeb62bad40f6761e8b139ebb94b63befbbbfc84604 /contrib/mdocml/INSTALL
parent97d822085265f5640a3640a45f0df10d55dad4b1 (diff)
parent698583cc5f183065a9346fa8f3ded4bb29671987 (diff)
downloadFreeBSD-src-37e4197e4f1c5dfdc9f6f47c3e2eaa08db678932.zip
FreeBSD-src-37e4197e4f1c5dfdc9f6f47c3e2eaa08db678932.tar.gz
MFH
Sponsored by: The FreeBSD Foundation
Diffstat (limited to 'contrib/mdocml/INSTALL')
-rw-r--r--contrib/mdocml/INSTALL16
1 files changed, 12 insertions, 4 deletions
diff --git a/contrib/mdocml/INSTALL b/contrib/mdocml/INSTALL
index eb8b5dd..085fb3e 100644
--- a/contrib/mdocml/INSTALL
+++ b/contrib/mdocml/INSTALL
@@ -1,4 +1,4 @@
-$Id: INSTALL,v 1.10 2015/03/09 21:00:14 schwarze Exp $
+$Id: INSTALL,v 1.13 2015/11/07 14:01:16 schwarze Exp $
About mdocml, the portable mandoc distribution
----------------------------------------------
@@ -42,6 +42,8 @@ generates. If anything looks wrong or different from what you
wish, read the file "configure.local.example", create and edit
a file "configure.local", and re-run "./configure" until the
result seems right to you.
+On Solaris 10 and earlier, you may have to run "ksh ./configure"
+because the native /bin/sh lacks some POSIX features.
3. Run "make".
Any POSIX-compatible make, in particular both BSD make and GNU make,
@@ -82,9 +84,10 @@ manual page source.
Understanding mandoc dependencies
---------------------------------
-The mandoc(1), man(1), and demandoc(1) utilities have no external
-dependencies, but makewhatis(8) and apropos(1) depend on the
-following software:
+The mandoc(1), man(1), and demandoc(1) utilities only depend
+on the zlib library for decompressing gzipped manual pages,
+but makewhatis(8) and apropos(1) depend on the following
+additional software:
1. The SQLite database system, see <http://sqlite.org/>.
The recommended version of SQLite is 3.8.4.3 or newer. The mandoc
@@ -107,6 +110,11 @@ If you run into that problem, set "HAVE_FTS=0" in configure.local.
If your system does not have it, the bundled compatibility version
will be used, so you probably need not worry about it.
+One of the chief design goals of the mandoc toolbox is to make
+sure that nothing related to documentation requires C++.
+Consequently, linking mandoc against any kind of C++ program
+would defeat the purpose and is not supported.
+
Checking autoconfiguration quality
----------------------------------
OpenPOWER on IntegriCloud