Annotation of mandoc/INSTALL, Revision 1.17
1.17 ! schwarze 1: $Id: INSTALL,v 1.16 2016/07/19 21:31:55 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.15 schwarze 19: Ingo Schwarze, Karlsruhe, July 2016
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.4 schwarze 34: 1. If you want to build the CGI program, man.cgi(8), too, run the
1.5 kristaps 35: command "echo BUILD_CGI=1 > configure.local". Then run "cp
36: cgi.h.examples cgi.h" and edit cgi.h as desired.
1.1 schwarze 37:
1.17 ! schwarze 38: 2. Define MANPATH_DEFAULT in configure.local
! 39: if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate
! 40: for your operating system.
! 41:
! 42: 3. Run "./configure".
1.4 schwarze 43: This script attempts autoconfiguration of mandoc for your system.
44: Read both its standard output and the file "Makefile.local" it
45: generates. If anything looks wrong or different from what you
46: wish, read the file "configure.local.example", create and edit
47: a file "configure.local", and re-run "./configure" until the
48: result seems right to you.
1.11 schwarze 49: On Solaris 10 and earlier, you may have to run "ksh ./configure"
50: because the native /bin/sh lacks some POSIX features.
1.4 schwarze 51:
1.17 ! schwarze 52: 4. Run "make".
1.4 schwarze 53: Any POSIX-compatible make, in particular both BSD make and GNU make,
54: should work. If the build fails, look at "configure.local.example"
55: and go back to step 2.
56:
1.17 ! schwarze 57: 5. Run "make -n install" and check whether everything will be
1.7 schwarze 58: installed to the intended places. Otherwise, put some *DIR or *NM*
1.17 ! schwarze 59: variables into "configure.local" and go back to step 3.
1.4 schwarze 60:
1.17 ! schwarze 61: 6. Run "sudo make install". If you intend to build a binary
1.4 schwarze 62: package using some kind of fake root mechanism, you may need a
63: command like "make DESTDIR=... install". Read the *-install targets
64: in the "Makefile" to understand how DESTDIR is used.
1.10 schwarze 65:
1.16 schwarze 66: 7. Run the command "sudo
1.10 schwarze 67: makewhatis" to build mandoc.db(5) databases in all the directory
68: trees configured in step 6. Whenever installing new manual pages,
69: re-run makewhatis(8) to update the databases, or apropos(1) will
70: not find the new pages.
71:
72: 8. To set up a man.cgi(8) server, read its manual page.
73:
74: Note that some man(7) pages may contain low-level roff(7) markup
75: that mandoc does not yet understand. On some BSD systems using
76: mandoc, third-party software is vetted on whether it may be formatted
77: with mandoc. If not, groff(1) is pulled in as a dependency and
78: used to install a pre-formatted "catpage" instead of directly as
79: manual page source.
1.4 schwarze 80:
81:
82: Understanding mandoc dependencies
83: ---------------------------------
1.16 schwarze 84: The following libraries are required:
85:
86: 1. zlib for decompressing gzipped manual pages.
1.2 schwarze 87:
1.7 schwarze 88: 2. The fts(3) directory traversion functions.
1.3 schwarze 89: If your system does not have them, the bundled compatibility version
90: will be used, so you need not worry in that case. But be careful: the
1.2 schwarze 91: glibc version of fts(3) is known to be broken on 32bit platforms,
92: see <https://sourceware.org/bugzilla/show_bug.cgi?id=15838>.
1.4 schwarze 93: If you run into that problem, set "HAVE_FTS=0" in configure.local.
1.2 schwarze 94:
1.7 schwarze 95: 3. Marc Espie's ohash(3) library.
1.2 schwarze 96: If your system does not have it, the bundled compatibility version
1.1 schwarze 97: will be used, so you probably need not worry about it.
1.13 schwarze 98:
99: One of the chief design goals of the mandoc toolbox is to make
100: sure that nothing related to documentation requires C++.
101: Consequently, linking mandoc against any kind of C++ program
102: would defeat the purpose and is not supported.
1.1 schwarze 103:
104:
1.2 schwarze 105: Checking autoconfiguration quality
106: ----------------------------------
1.1 schwarze 107: If you want to check whether automatic configuration works well
108: on your platform, consider the following:
109:
110: The mandoc package intentionally does not use GNU autoconf because
111: we consider that toolset a blatant example of overengineering that
112: is obsolete nowadays, since all modern operating systems are now
113: reasonably close to POSIX and do not need arcane shell magic any
114: longer. If your system does need such magic, consider upgrading
115: to reasonably modern POSIX-compliant tools rather than asking for
116: autoconf-style workarounds.
117:
118: As far as mandoc is using any features not mandated by ANSI X3.159-1989
119: ("ANSI C") or IEEE Std 1003.1-2008 ("POSIX") that some modern systems
120: do not have, we intend to provide autoconfiguration tests and
121: compat_*.c implementations. Please report any that turn out to be
122: missing. Note that while we do strive to produce portable code,
123: we do not slavishly restrict ourselves to POSIX-only interfaces.
124: For improved security and readability, we do use well-designed,
125: modern interfaces like reallocarray(3) even if they are still rather
126: uncommon, of course bundling compat_*.c implementations as needed.
127:
128: Where mandoc is using ANSI C or POSIX features that some systems
129: still lack and that compat_*.c implementations can be provided for
130: without too much hassle, we will consider adding them, too, so
131: please report whatever is missing on your platform.
132:
133: The following steps can be used to manually check the automatic
134: configuration on your platform:
135:
1.4 schwarze 136: 1. Run "make distclean".
1.1 schwarze 137:
1.4 schwarze 138: 2. Run "./configure"
1.1 schwarze 139:
140: 3. Read the file "config.log". It shows the compiler commands used
141: to test the libraries installed on your system and the standard
142: output and standard error output these commands produce. Watch out
143: for unexpected failures. Those are most likely to happen if headers
144: or libraries are installed in unusual places or interfaces defined
145: in unusual headers. You can also look at the file "config.h" and
1.4 schwarze 146: check that no "#define HAVE_*" differ from your expectations.
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to INSTALL CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc