=================================================================== RCS file: /cvs/mandoc/INSTALL,v retrieving revision 1.3 retrieving revision 1.3.2.1 diff -u -p -r1.3 -r1.3.2.1 --- mandoc/INSTALL 2014/08/11 01:39:00 1.3 +++ mandoc/INSTALL 2014/08/14 20:43:22 1.3.2.1 @@ -1,4 +1,4 @@ -$Id: INSTALL,v 1.3 2014/08/11 01:39:00 schwarze Exp $ +$Id: INSTALL,v 1.3.2.1 2014/08/14 20:43:22 schwarze Exp $ About mdocml, the portable mandoc distribution ---------------------------------------------- @@ -34,9 +34,18 @@ latest bundled and ported versions of mandoc for vario systems is maintained at . If mandoc is installed, you can check the version by running "mandoc -V". -The version contained in this distribution tarball is listed near -the beginning of the file "Makefile". +The version contained in this distribution tarball is 1.12.4. +This is not the newest version available, you can also get 1.13.1. +Installing 1.12.4 only makes sense if all of the following conditions +hold for you: + + - You need apropos(1) and makewhatis(8) functionality. + - You do not need the man.cgi(8) web frontend. + - You do have the Berkeley database library, version 1.85. + - You lack at least one of the following: the SQLite3 database + library and/or the fts(3) file hierarchy traversal functions. + 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: @@ -44,56 +53,32 @@ To install mandoc manually, the following steps are ne 1. Decide whether you want to build the base tools mandoc(1), preconv(1) and demandoc(1) only or whether you also want to build the database tools apropos(1) and makewhatis(8). For the latter, -the following dependencies are required: +the Berkeley database system, version 1.85, is required. +It is installed by default on BSD systems and available as an +optional software package on other systems. -1.1. The SQLite database system, see . -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. - -1.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 . - -1.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. - -2. If you choose to build the database tools, too, decide whether -you also want to build the CGI program, man.cgi(8). - -3. Read the beginning of the file "Makefile" from "USER SETTINGS" +2. Read the beginning of the file "Makefile" from "USER SETTINGS" to "END OF USER SETTINGS" and edit it as required. In particular, disable "BUILD_TARGETS += db-build" if you do not want database -support or enable "BUILD_TARGETS += cgi-build" if you do want -the CGI program. +support. -4. Run "make". No separate "./configure" or "make depend" steps +3. Run "make". No separate "./configure" or "make depend" steps are needed. The former is run automatically by "make". The latter is a maintainer target. If you merely want to build the released version as opposed to doing active development, there is no need to regenerate the dependency specifications. Any POSIX-compatible make, in particular both BSD make and GNU make, should work. -5. Run "make -n install" and check whether everything will be +4. Run "make -n install" and check whether everything will be installed to the intended places. Otherwise, edit the *DIR variables in the Makefile until it is. -6. Run "sudo make install". If you intend to build a binary +5. 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. -7. To set up a man.cgi(8) server, read its manual page. - -8. To use mandoc(1) as your man(1) formatter, read the "Deployment" +6. To use mandoc(1) as your man(1) formatter, read the "Deployment" section below.