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

Annotation of mandoc/INSTALL, Revision 1.18

1.18    ! schwarze    1: $Id: INSTALL,v 1.17 2016/07/19 22:40:33 schwarze Exp $
1.1       schwarze    2:
1.2       schwarze    3: About mdocml, the portable mandoc distribution
                      4: ----------------------------------------------
1.1       schwarze    5: The mandoc manpage compiler toolset is a suite of tools compiling
                      6: mdoc(7), the roff(7) macro language of choice for BSD manual pages,
                      7: and man(7), the predominant historical language for UNIX manuals.
1.10      schwarze    8: It includes a man(1) manual viewer and additional tools.
1.2       schwarze    9: For general information, see <http://mdocml.bsd.lv/>.
                     10:
                     11: In case you have questions or want to provide feedback, read
                     12: <http://mdocml.bsd.lv/contact.html>.  Consider subscribing to the
                     13: discuss@ mailing list mentioned on that page.  If you intend to
                     14: help with the development of mandoc, consider subscribing to the
                     15: tech@ mailing list, too.
                     16:
                     17: Enjoy using the mandoc toolset!
                     18:
1.18    ! schwarze   19: Ingo Schwarze, Karlsruhe, February 2017
1.2       schwarze   20:
1.1       schwarze   21:
1.2       schwarze   22: Installation
                     23: ------------
1.1       schwarze   24: Before manually installing mandoc on your system, please check
                     25: whether the newest version of mandoc is already installed by default
                     26: or available via a binary package or a ports system.  A list of the
                     27: latest bundled and ported versions of mandoc for various operating
1.2       schwarze   28: systems is maintained at <http://mdocml.bsd.lv/ports.html>.
1.1       schwarze   29:
1.2       schwarze   30: Regarding how packages and ports are maintained for your operating
                     31: system, please consult your operating system documentation.
                     32: To install mandoc manually, the following steps are needed:
1.1       schwarze   33:
1.18    ! schwarze   34: 1. If you want to build the CGI program, man.cgi(8), too,
        !            35: run the command "echo BUILD_CGI=1 >> configure.local".
        !            36: Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.
        !            37:
        !            38: 2. If you also want to build the new catman(8) utility, run the
        !            39: command "echo BUILD_CATMAN=1 >> configure.local".  Note that it
        !            40: is unlikely to be a drop-in replacement providing the same
        !            41: functionality as your system's "catman", if your operating
        !            42: system contains one.
1.1       schwarze   43:
1.18    ! schwarze   44: 3. Define MANPATH_DEFAULT in configure.local
1.17      schwarze   45: if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate
                     46: for your operating system.
                     47:
1.18    ! schwarze   48: 4. Run "./configure".
1.4       schwarze   49: This script attempts autoconfiguration of mandoc for your system.
                     50: Read both its standard output and the file "Makefile.local" it
                     51: generates.  If anything looks wrong or different from what you
                     52: wish, read the file "configure.local.example", create and edit
                     53: a file "configure.local", and re-run "./configure" until the
                     54: result seems right to you.
1.11      schwarze   55: On Solaris 10 and earlier, you may have to run "ksh ./configure"
                     56: because the native /bin/sh lacks some POSIX features.
1.4       schwarze   57:
1.18    ! schwarze   58: 5. Run "make".
1.4       schwarze   59: Any POSIX-compatible make, in particular both BSD make and GNU make,
                     60: should work.  If the build fails, look at "configure.local.example"
                     61: and go back to step 2.
                     62:
1.18    ! schwarze   63: 6. Run "make -n install" and check whether everything will be
1.7       schwarze   64: installed to the intended places.  Otherwise, put some *DIR or *NM*
1.18    ! schwarze   65: variables into "configure.local" and go back to step 4.
1.4       schwarze   66:
1.18    ! schwarze   67: 7. Optionally run the regression suite.
        !            68: Basically, that amounts to "cd regress && ./regress.pl".
        !            69: But you should probably look at "./mandoc -l regress/regress.pl.1"
        !            70: first.
        !            71:
        !            72: 8. Run "sudo make install".  If you intend to build a binary
1.4       schwarze   73: package using some kind of fake root mechanism, you may need a
                     74: command like "make DESTDIR=... install".  Read the *-install targets
                     75: in the "Makefile" to understand how DESTDIR is used.
1.10      schwarze   76:
1.18    ! schwarze   77: 9. Run the command "sudo makewhatis" to build mandoc.db(5) databases
        !            78: in all the directory trees configured in step 6.  Whenever installing
        !            79: new manual pages, re-run makewhatis(8) to update the databases, or
        !            80: apropos(1) will not find the new pages.
1.10      schwarze   81:
1.18    ! schwarze   82: 10. To set up a man.cgi(8) server, read its manual page.
1.10      schwarze   83:
                     84: Note that some man(7) pages may contain low-level roff(7) markup
                     85: that mandoc does not yet understand.  On some BSD systems using
                     86: mandoc, third-party software is vetted on whether it may be formatted
                     87: with mandoc.  If not, groff(1) is pulled in as a dependency and
                     88: used to install a pre-formatted "catpage" instead of directly as
                     89: manual page source.
1.4       schwarze   90:
                     91:
                     92: Understanding mandoc dependencies
                     93: ---------------------------------
1.16      schwarze   94: The following libraries are required:
                     95:
                     96: 1. zlib for decompressing gzipped manual pages.
1.2       schwarze   97:
1.7       schwarze   98: 2. The fts(3) directory traversion functions.
1.3       schwarze   99: If your system does not have them, the bundled compatibility version
1.18    ! schwarze  100: will be used, so you need not worry in that case.  But be careful: old
        !           101: glibc versions of fts(3) were known to be broken on 32bit platforms,
        !           102: see <https://sourceware.org/bugzilla/show_bug.cgi?id=11460>.
        !           103: That was presumably fixed in glibc-2.23.
1.4       schwarze  104: If you run into that problem, set "HAVE_FTS=0" in configure.local.
1.2       schwarze  105:
1.7       schwarze  106: 3. Marc Espie's ohash(3) library.
1.2       schwarze  107: If your system does not have it, the bundled compatibility version
1.1       schwarze  108: will be used, so you probably need not worry about it.
1.13      schwarze  109:
                    110: One of the chief design goals of the mandoc toolbox is to make
                    111: sure that nothing related to documentation requires C++.
                    112: Consequently, linking mandoc against any kind of C++ program
                    113: would defeat the purpose and is not supported.
1.1       schwarze  114:
                    115:
1.2       schwarze  116: Checking autoconfiguration quality
                    117: ----------------------------------
1.1       schwarze  118: If you want to check whether automatic configuration works well
                    119: on your platform, consider the following:
                    120:
                    121: The mandoc package intentionally does not use GNU autoconf because
                    122: we consider that toolset a blatant example of overengineering that
                    123: is obsolete nowadays, since all modern operating systems are now
                    124: reasonably close to POSIX and do not need arcane shell magic any
                    125: longer.  If your system does need such magic, consider upgrading
                    126: to reasonably modern POSIX-compliant tools rather than asking for
                    127: autoconf-style workarounds.
                    128:
                    129: As far as mandoc is using any features not mandated by ANSI X3.159-1989
                    130: ("ANSI C") or IEEE Std 1003.1-2008 ("POSIX") that some modern systems
                    131: do not have, we intend to provide autoconfiguration tests and
                    132: compat_*.c implementations.  Please report any that turn out to be
                    133: missing.  Note that while we do strive to produce portable code,
                    134: we do not slavishly restrict ourselves to POSIX-only interfaces.
                    135: For improved security and readability, we do use well-designed,
                    136: modern interfaces like reallocarray(3) even if they are still rather
                    137: uncommon, of course bundling compat_*.c implementations as needed.
                    138:
                    139: Where mandoc is using ANSI C or POSIX features that some systems
                    140: still lack and that compat_*.c implementations can be provided for
                    141: without too much hassle, we will consider adding them, too, so
                    142: please report whatever is missing on your platform.
                    143:
                    144: The following steps can be used to manually check the automatic
                    145: configuration on your platform:
                    146:
1.4       schwarze  147: 1. Run "make distclean".
1.1       schwarze  148:
1.4       schwarze  149: 2. Run "./configure"
1.1       schwarze  150:
                    151: 3. Read the file "config.log".  It shows the compiler commands used
                    152: to test the libraries installed on your system and the standard
                    153: output and standard error output these commands produce.  Watch out
                    154: for unexpected failures.  Those are most likely to happen if headers
                    155: or libraries are installed in unusual places or interfaces defined
                    156: in unusual headers.  You can also look at the file "config.h" and
1.4       schwarze  157: check that no "#define HAVE_*" differ from your expectations.

CVSweb