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

Diff for /mandoc/INSTALL between version 1.15.2.4 and 1.16

version 1.15.2.4, 2017/02/22 09:41:23 version 1.16, 2016/07/19 21:31:55
Line 1 
Line 1 
 $Id$  $Id$
   
 ************************************************************************  
 * This is a backward compatibility release.  
 * Unless you need compatibility with the old SQLite3-based mandoc.db(5)  
 * database format, please use the mandoc-1.14.1 release instead:  
 * http://mdocml.bsd.lv/snapshots/mdocml-1.14.1.tar.gz  
 ************************************************************************  
   
 About 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
Line 23  tech@ mailing list, too.
Line 16  tech@ mailing list, too.
   
 Enjoy using the mandoc toolset!  Enjoy using the mandoc toolset!
   
 Ingo Schwarze, Karlsruhe, February 2017  Ingo Schwarze, Karlsruhe, July 2016
   
   
 Installation  Installation
Line 38  Regarding how packages and ports are maintained for yo
Line 31  Regarding how packages and ports are maintained for yo
 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. If you want to build the CGI program, man.cgi(8), too,  1. If you want to build the CGI program, man.cgi(8), too, run the
 run the command "echo BUILD_CGI=1 >> configure.local".  command "echo BUILD_CGI=1 > configure.local".  Then run "cp
 Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.  cgi.h.examples cgi.h" and edit cgi.h as desired.
   
 2. Run "./configure".  2. Run "./configure".
 This script attempts autoconfiguration of mandoc for your system.  This script attempts autoconfiguration of mandoc for your system.
Line 61  and go back to step 2.
Line 54  and go back to step 2.
 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 2.
   
 5. Optionally run the regression suite.  5. Run "sudo make install".  If you intend to build a binary
 Basically, that amounts to "cd regress && ./regress.pl".  
 But you should probably look at "./mandoc -l regress/regress.pl.1"  
 first.  
   
 6. 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.
   
 7. If you want to use the integrated man(1) and your system uses  6. If you want to use the integrated man(1) and your system uses
 manpath(1), make sure it is configured correctly, in particular,  manpath(1), make sure it is configured correctly, in particular,
 it returns all directory trees where manual pages are installed.  it returns all directory trees where manual pages are installed.
 Otherwise, if your system uses man.conf(5), make sure it contains  Otherwise, if your system uses man.conf(5), make sure it contains
 a "manpath" line for each directory tree, and the order of these  a "manpath" line for each directory tree, and the order of these
 lines meets your wishes.  lines meets your wishes.
   
 8. Run the command "sudo makewhatis" to build mandoc.db(5) databases  7. Run the command "sudo
 in all the directory trees configured in step 6.  Whenever installing  makewhatis" to build mandoc.db(5) databases in all the directory
 new manual pages, re-run makewhatis(8) to update the databases, or  trees configured in step 6.  Whenever installing new manual pages,
 apropos(1) will not find the new pages.  re-run makewhatis(8) to update the databases, or apropos(1) will
   not find the new pages.
   
 9. To set up a man.cgi(8) server, read its manual page.  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  Note that some man(7) pages may contain low-level roff(7) markup
 that mandoc does not yet understand.  On some BSD systems using  that mandoc does not yet understand.  On some BSD systems using
Line 95  manual page source.
Line 84  manual page source.
   
 Understanding mandoc dependencies  Understanding mandoc dependencies
 ---------------------------------  ---------------------------------
 The mandoc(1), man(1), and demandoc(1) utilities only depend  The following libraries are required:
 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/>.  1. zlib for decompressing gzipped manual pages.
 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.  
   
 2. The fts(3) directory traversion functions.  2. The fts(3) directory traversion functions.
 If your system does not have them, the bundled compatibility version  If your system does not have them, the bundled compatibility version
Legend:
Removed from v.1.15.2.4  
changed lines
  Added in v.1.16
CVSweb