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

Diff for /mandoc/INSTALL between version 1.3.2.1 and 1.4

version 1.3.2.1, 2014/08/14 20:43:22 version 1.4, 2014/08/16 19:00:01
Line 34  latest bundled and ported versions of mandoc for vario
Line 34  latest bundled and ported versions of mandoc for vario
 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 running "mandoc -V".  If mandoc is installed, you can check the version by running "mandoc -V".
   You can find the version contained in this distribution tarball
   by running "./configure".
   
 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  Regarding how packages and ports are maintained for your operating
 system, please consult your operating system documentation.  system, please consult your operating system documentation.
 To install mandoc manually, the following steps are needed:  To install mandoc manually, the following steps are needed:
   
 1. Decide whether you want to build the base tools mandoc(1),  1. If you want to build the CGI program, man.cgi(8), too, run the
 preconv(1) and demandoc(1) only or whether you also want to build the  command "echo BUILD_CGI=1 > configure.local".
 database tools apropos(1) and makewhatis(8).  For the latter,  
 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.  
   
 2. Read the beginning of the file "Makefile" from "USER SETTINGS"  2. Run "./configure".
 to "END OF USER SETTINGS" and edit it as required.  In particular,  This script attempts autoconfiguration of mandoc for your system.
 disable "BUILD_TARGETS += db-build" if you do not want database  Read both its standard output and the file "Makefile.local" it
 support.  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.
   
 3. Run "make".  No separate "./configure" or "make depend" steps  3. Run "make".
 are needed.  The former is run automatically by "make".  The latter  Any POSIX-compatible make, in particular both BSD make and GNU make,
 is a maintainer target.  If you merely want to build the released  should work.  If the build fails, look at "configure.local.example"
 version as opposed to doing active development, there is no need  and go back to step 2.
 to regenerate the dependency specifications.  Any POSIX-compatible  
 make, in particular both BSD make and GNU make, should work.  
   
 4. 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  installed to the intended places.  Otherwise, put some *DIR variables
 in the Makefile until it is.  into "configure.local" and go back to step 2.
   
 5. 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  package using some kind of fake root mechanism, you may need a
 command like "make DESTDIR=... install".  Read the *-install targets  command like "make DESTDIR=... install".  Read the *-install targets
 in the "Makefile" to understand how DESTDIR is used.  in the "Makefile" to understand how DESTDIR is used.
   
 6. To use mandoc(1) as your man(1) formatter, read the "Deployment"  6. To set up a man.cgi(8) server, read its manual page.
   
   7. To use mandoc(1) as your man(1) formatter, read the "Deployment"
 section below.  section below.
   
   
   Understanding mandoc dependencies
   ---------------------------------
   The mandoc(1), preconv(1), and demandoc(1) utilities have no external
   dependencies.  However, 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.
   
   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 <https://sourceware.org/bugzilla/show_bug.cgi?id=15838>.
   If you run into that problem, set "HAVE_FTS=0" in configure.local.
   
   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.
   
   
 Checking autoconfiguration quality  Checking autoconfiguration quality
 ----------------------------------  ----------------------------------
 If you want to check whether automatic configuration works well  If you want to check whether automatic configuration works well
Line 113  please report whatever is missing on your platform.
Line 131  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 123  output and standard error output these commands produc
Line 141  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".  
   
   
 Deployment  Deployment

Legend:
Removed from v.1.3.2.1  
changed lines
  Added in v.1.4

CVSweb