=================================================================== RCS file: /cvs/mandoc/INSTALL,v retrieving revision 1.1 retrieving revision 1.21 diff -u -p -r1.1 -r1.21 --- mandoc/INSTALL 2014/08/08 16:45:39 1.1 +++ mandoc/INSTALL 2018/07/31 10:18:15 1.21 @@ -1,70 +1,124 @@ -$Id: INSTALL,v 1.1 2014/08/08 16:45:39 schwarze Exp $ +$Id: INSTALL,v 1.21 2018/07/31 10:18:15 schwarze Exp $ -Installing mdocml, the portable mandoc distribution ---------------------------------------------------- +About the portable mandoc distribution +-------------------------------------- +The mandoc manpage compiler toolset (formerly called "mdocml") +is a suite of tools compiling mdoc(7), the roff(7) macro language +of choice for BSD manual pages, and man(7), the predominant +historical language for UNIX manuals. -The mandoc manpage compiler toolset is a suite of tools compiling -mdoc(7), the roff(7) macro language of choice for BSD manual pages, -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 . +In case you have questions or want to provide feedback, read +. 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 2018 + + +Installation +------------ Before manually installing mandoc on your system, please check 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 latest bundled and ported versions of mandoc for various operating -systems is maintained at: http://mdocml.bsd.lv/ports.html +systems is maintained at . -If mandoc is installed, you can check the version by typing: mandoc -V -The version contained in this distribution tarball is listed near -the beginning of the file "Makefile". Regarding how packages and -ports are maintained for your operating system, please consult your -operating system documentation. +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: +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. -To install mandoc manually, the following steps are needed: +2. If you also want to build the 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. -1. Decide whether you want to build just the basic tools mandoc(1), -preconv(1) and demandoc(1) or whether you also want to build the -database tools apropos(1) and makewhatis(8). For the latter, a -working installation of SQLite is required, 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. -The database tools also require 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. +3. Define MANPATH_DEFAULT in configure.local +if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate +for your operating system. -2. If you choose to build the database tools, too, decide whether -you also want to build the CGI program, man.cgi(8). +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. +On Solaris 10 and earlier, you may have to run "ksh ./configure" +because the native /bin/sh lacks some POSIX features. -3. 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. +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. -4. Run the command "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, -is supposed to work. +6. 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 4. -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. +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. -6. Run "sudo make install". Instead, 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. +9. Run the command "sudo makewhatis" to build mandoc.db(5) databases +in all the directory trees configured in step 3. Whenever installing +new manual pages, re-run makewhatis(8) to update the databases, or +apropos(1) will not find the new pages. +10. To set up a man.cgi(8) server, read its manual page. + +Note that a very small number of man(7) pages 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 pre-formatted "catpages" instead of +manual page sources. This mechanism is used much less frequently +than in the past. On OpenBSD, only 25 out of about 10000 ports +still require formatting with groff(1). + + +Understanding mandoc dependencies +--------------------------------- +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 +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 . +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. + +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 +---------------------------------- If you want to check whether automatic configuration works well on your platform, consider the following: @@ -94,9 +148,9 @@ please report whatever is missing on your platform. The following steps can be used to manually check the automatic 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 to test the libraries installed on your system and the standard @@ -104,16 +158,4 @@ output and standard error output these commands produc for unexpected failures. Those are most likely to happen if headers or libraries are installed in unusual places or interfaces defined in unusual headers. You can also look at the file "config.h" and -check that no expected "#define HAVE_*" lines are missing. The -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 +check that no "#define HAVE_*" differ from your expectations.