[BACK]Return to INSTALL CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/INSTALL between version 1.1 and 1.15

version 1.1, 2014/08/08 16:45:39 version 1.15, 2016/07/14 11:09:06
Line 1 
Line 1 
 $Id$  $Id$
   
 Installing mdocml, the portable mandoc distribution  About mdocml, the portable mandoc distribution
 ---------------------------------------------------  ----------------------------------------------
   
 The mandoc manpage compiler toolset is a suite of tools compiling  The mandoc manpage compiler toolset is a suite of tools compiling
 mdoc(7), the roff(7) macro language of choice for BSD manual pages,  mdoc(7), the roff(7) macro language of choice for BSD manual pages,
 and man(7), the predominant historical language for UNIX manuals.  and man(7), the predominant historical language for UNIX manuals.
 For general information, see:  http://mdocml.bsd.lv/  It includes a man(1) manual viewer and additional tools.
   For general information, see <http://mdocml.bsd.lv/>.
   
   In case you have questions or want to provide feedback, read
   <http://mdocml.bsd.lv/contact.html>.  Consider subscribing to the
   discuss@ mailing list mentioned on that page.  If you intend to
   help with the development of mandoc, consider subscribing to the
   tech@ mailing list, too.
   
   Enjoy using the mandoc toolset!
   
   Ingo Schwarze, Karlsruhe, July 2016
   
   
   Installation
   ------------
 Before manually installing mandoc on your system, please check  Before manually installing mandoc on your system, please check
 whether the newest version of mandoc is already installed by default  whether the newest version of mandoc is already installed by default
 or available via a binary package or a ports system.  A list of the  or available via a binary package or a ports system.  A list of the
 latest bundled and ported versions of mandoc for various operating  latest bundled and ported versions of mandoc for various operating
 systems is maintained at:  http://mdocml.bsd.lv/ports.html  systems is maintained at <http://mdocml.bsd.lv/ports.html>.
   
 If mandoc is installed, you can check the version by typing:  mandoc -V  Regarding how packages and ports are maintained for your operating
 The version contained in this distribution tarball is listed near  system, please consult your operating system documentation.
 the beginning of the file "Makefile".  Regarding how packages and  To install mandoc manually, the following steps are needed:
 ports are maintained for your operating system, please consult your  
 operating system documentation.  
   
   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.
   
 To install mandoc manually, the following steps are needed:  2. 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.
   On Solaris 10 and earlier, you may have to run "ksh ./configure"
   because the native /bin/sh lacks some POSIX features.
   
 1. Decide whether you want to build just the basic tools mandoc(1),  3. Run "make".
 preconv(1) and demandoc(1) or whether you also want to build the  Any POSIX-compatible make, in particular both BSD make and GNU make,
 database tools apropos(1) and makewhatis(8).  For the latter, a  should work.  If the build fails, look at "configure.local.example"
 working installation of SQLite is required, see: http://sqlite.org/  and go back to step 2.
   
   4. Run "make -n install" and check whether everything will be
   installed to the intended places.  Otherwise, put some *DIR or *NM*
   variables into "configure.local" and go back to step 2.
   
   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.
   
   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 "manpath" line for each directory tree, and the order of these
   lines meets your wishes.
   
   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.
   
   Note that some man(7) pages may contain low-level roff(7) markup
   that mandoc does not yet understand.  On some BSD systems using
   mandoc, third-party software is vetted on whether it may be formatted
   with mandoc.  If not, groff(1) is pulled in as a dependency and
   used to install a pre-formatted "catpage" instead of directly as
   manual page source.
   
   
   Understanding mandoc dependencies
   ---------------------------------
   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  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  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  older than 3.8.3 may not achieve full performance due to the
 missing SQLITE_DETERMINISTIC optimization flag.  Versions older  missing SQLITE_DETERMINISTIC optimization flag.  Versions older
 than 3.8.0 may not show full error information if opening a database  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  fails due to the missing sqlite3_errstr() API.  Both are very minor
 problems, apropos(1) is fully usable with SQLite 3.7.5.  problems, apropos(1) is fully usable with SQLite 3.7.5.  Versions
 The database tools also require Marc Espie's ohash(3) library;  older than 3.7.5 may or may not work, they have not been tested.
 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  2. The fts(3) directory traversion functions.
 you also want to build the CGI program, man.cgi(8).  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>.
   If you run into that problem, set "HAVE_FTS=0" in configure.local.
   
 3. Read the beginning of the file "Makefile" from "USER SETTINGS"  3. Marc Espie's ohash(3) library.
 to "END OF USER SETTINGS" and edit it as required.  In particular,  If your system does not have it, the bundled compatibility version
 disable "BUILD_TARGETS += db-build" if you do not want database  will be used, so you probably need not worry about it.
 support or enable "BUILD_TARGETS += cgi-build" if you do want  
 the CGI program.  
   
 4. Run the command "make".  No separate "./configure" or "make  One of the chief design goals of the mandoc toolbox is to make
 depend" steps are needed.  The former is run automatically by "make".  sure that nothing related to documentation requires C++.
 The latter is a maintainer target.  If you merely want to build the  Consequently, linking mandoc against any kind of C++ program
 released version as opposed to doing active development, there is  would defeat the purpose and is not supported.
 no need to regenerate the dependency specifications.  Any  
 POSIX-compatible make, in particular both BSD make and GNU make,  
 is supposed to work.  
   
 5. Run the command "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".  Instead, if you intend to build a binary  Checking autoconfiguration quality
 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.  
   
   
 If you want to check whether automatic configuration works well  If you want to check whether automatic configuration works well
 on your platform, consider the following:  on your platform, consider the following:
   
Line 94  please report whatever is missing on your platform.
Line 147  please report whatever is missing on your platform.
 The following steps can be used to manually check the automatic  The following steps can be used to manually check the automatic
 configuration on your platform:  configuration on your platform:
   
 1. Run "make clean".  1. Run "make distclean".
   
 2. Run "make config.h"  2. Run "./configure"
   
 3. Read the file "config.log".  It shows the compiler commands used  3. Read the file "config.log".  It shows the compiler commands used
 to test the libraries installed on your system and the standard  to test the libraries installed on your system and the standard
Line 104  output and standard error output these commands produc
Line 157  output and standard error output these commands produc
 for unexpected failures.  Those are most likely to happen if headers  for unexpected failures.  Those are most likely to happen if headers
 or libraries are installed in unusual places or interfaces defined  or libraries are installed in unusual places or interfaces defined
 in unusual headers.  You can also look at the file "config.h" and  in unusual headers.  You can also look at the file "config.h" and
 check that no expected "#define HAVE_*" lines are missing.  The  check that no "#define HAVE_*" differ from your expectations.
 list of tests run can be found in the file "configure".  
   
   
 In case you have questions or want to provide feedback, look at:  
 http://mdocml.bsd.lv/contact.html  
   
 Consider subscribing to the discuss@ mailing list mentioned on that  
 page.  If you intend to help with the development of mandoc, consider  
 subscribing to the tech@ mailing list, too.  
   
 Enjoy using the mandoc toolset!  
 Ingo Schwarze, Karlsruhe, August 2014  
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.15
CVSweb