Now that markdown output is tested for almost everything, test all

[mandoc.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index eb8b5dd2c2b564002525f35453ae2f4e0e7d63ec..3f0d3bbc54aca9d185b13c6b4d06fa11e94ce09c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,4 @@
-$Id: INSTALL,v 1.10 2015/03/09 21:00:14 schwarze Exp $
+$Id: INSTALL,v 1.18 2017/02/08 12:24:10 schwarze Exp $

 
 About mdocml, the portable mandoc distribution
 ----------------------------------------------
 
 About mdocml, the portable mandoc distribution
 ----------------------------------------------


@@ -16,7 +16,7 @@ tech@ mailing list, too.
 
 Enjoy using the mandoc toolset!
 
 
 Enjoy using the mandoc toolset!
 

-Ingo Schwarze, Karlsruhe, March 2015
+Ingo Schwarze, Karlsruhe, February 2017

 
 
 Installation
 
 
 Installation


@@ -31,46 +31,55 @@ Regarding how packages and ports are maintained for your operating
 system, please consult your operating system documentation.
 To install mandoc manually, the following steps are needed:
 
 system, please consult your operating system documentation.
 To install mandoc manually, the following steps are needed:
 

-1. If you want to build the CGI program, man.cgi(8), too, run the
-command "echo BUILD_CGI=1 > configure.local".  Then run "cp
-cgi.h.examples cgi.h" and edit cgi.h as desired.
+1. If you want to build the CGI program, man.cgi(8), too,
+run the command "echo BUILD_CGI=1 >> configure.local".
+Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.

 
 

-2. Run "./configure".
+2. If you also want to build the new catman(8) utility, run the
+command "echo BUILD_CATMAN=1 >> configure.local".  Note that it
+is unlikely to be a drop-in replacement providing the same
+functionality as your system's "catman", if your operating
+system contains one.
+
+3. Define MANPATH_DEFAULT in configure.local
+if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate
+for your operating system.
+
+4. Run "./configure".

 This script attempts autoconfiguration of mandoc for your system.
 Read both its standard output and the file "Makefile.local" it
 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.
 This script attempts autoconfiguration of mandoc for your system.
 Read both its standard output and the file "Makefile.local" it
 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".
+5. Run "make".

 Any POSIX-compatible make, in particular both BSD make and GNU make,
 should work.  If the build fails, look at "configure.local.example"
 and go back to step 2.
 
 Any POSIX-compatible make, in particular both BSD make and GNU make,
 should work.  If the build fails, look at "configure.local.example"
 and go back to step 2.
 

-4. Run "make -n install" and check whether everything will be
+6. Run "make -n install" and check whether everything will be

 installed to the intended places.  Otherwise, put some *DIR or *NM*
 installed to the intended places.  Otherwise, put some *DIR or *NM*

-variables into "configure.local" and go back to step 2.
+variables into "configure.local" and go back to step 4.
+
+7. Optionally run the regression suite.
+Basically, that amounts to "cd regress && ./regress.pl".
+But you should probably look at "./mandoc -l regress/regress.pl.1"
+first.

 
 

-5. Run "sudo make install".  If you intend to build a binary
+8. Run "sudo make install".  If you intend to build a binary

 package using some kind of fake root mechanism, you may need a
 command like "make DESTDIR=... install".  Read the *-install targets
 in the "Makefile" to understand how DESTDIR is used.
 
 package using some kind of fake root mechanism, you may need a
 command like "make DESTDIR=... install".  Read the *-install targets
 in the "Makefile" to understand how DESTDIR is used.
 

-6. If you want to use the integrated man(1) and your system uses
-manpath(1), make sure it is configured correctly, in particular,
-it returns all directory trees where manual pages are installed.
-Otherwise, if your system uses man.conf(5), make sure it contains
-a "_whatdb" line for each directory tree, and the order of these
-lines meets your wishes.
+9. Run the command "sudo makewhatis" to build mandoc.db(5) databases
+in all the directory trees configured in step 6.  Whenever installing
+new manual pages, re-run makewhatis(8) to update the databases, or
+apropos(1) will not find the new pages.

 
 

-7. If you compiled with database support, run the command "sudo
-makewhatis" to build mandoc.db(5) databases in all the directory
-trees configured in step 6.  Whenever installing new manual pages,
-re-run makewhatis(8) to update the databases, or apropos(1) will
-not find the new pages.
-
-8. To set up a man.cgi(8) server, read its manual page.
+10. To set up a man.cgi(8) server, read its manual page.

 
 Note that some man(7) pages may contain low-level roff(7) markup
 that mandoc does not yet understand.  On some BSD systems using
 
 Note that some man(7) pages may contain low-level roff(7) markup
 that mandoc does not yet understand.  On some BSD systems using


@@ -82,31 +91,27 @@ manual page source.
 
 Understanding mandoc dependencies
 ---------------------------------
 
 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:
-
-1. The SQLite database system, see <http://sqlite.org/>.
-The recommended version of SQLite is 3.8.4.3 or newer.  The mandoc
-toolset is known to work with version 3.7.5 or newer.  Versions
-older than 3.8.3 may not achieve full performance due to the
-missing SQLITE_DETERMINISTIC optimization flag.  Versions older
-than 3.8.0 may not show full error information if opening a database
-fails due to the missing sqlite3_errstr() API.  Both are very minor
-problems, apropos(1) is fully usable with SQLite 3.7.5.  Versions
-older than 3.7.5 may or may not work, they have not been tested.
+The following libraries are required:
+
+1. zlib for decompressing gzipped manual pages.

 
 2. The fts(3) directory traversion functions.
 If your system does not have them, the bundled compatibility version
 
 2. The fts(3) directory traversion functions.
 If your system does not have them, the bundled compatibility version

-will be used, so you need not worry in that case.  But be careful: the
-glibc version of fts(3) is known to be broken on 32bit platforms,
-see <https://sourceware.org/bugzilla/show_bug.cgi?id=15838>.
+will be used, so you need not worry in that case.  But be careful: old
+glibc versions of fts(3) were known to be broken on 32bit platforms,
+see <https://sourceware.org/bugzilla/show_bug.cgi?id=11460>.
+That was presumably fixed in glibc-2.23.

 If you run into that problem, set "HAVE_FTS=0" in configure.local.
 
 3. Marc Espie's ohash(3) library.
 If your system does not have it, the bundled compatibility version
 will be used, so you probably need not worry about it.
 
 If you run into that problem, set "HAVE_FTS=0" in configure.local.
 
 3. Marc Espie's ohash(3) library.
 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
 ----------------------------------
 
 Checking autoconfiguration quality
 ----------------------------------