version 1.17, 2016/07/19 22:40:33 |
version 1.24, 2021/09/20 13:25:42 |
|
|
$Id$ |
$Id$ |
|
|
About mdocml, the portable mandoc distribution |
About the portable mandoc distribution |
---------------------------------------------- |
-------------------------------------- |
The mandoc manpage compiler toolset is a suite of tools compiling |
The mandoc manpage compiler toolset (formerly called "mdocml") |
mdoc(7), the roff(7) macro language of choice for BSD manual pages, |
is a suite of tools compiling mdoc(7), the roff(7) macro language |
and man(7), the predominant historical language for UNIX manuals. |
of choice for BSD manual pages, and man(7), the predominant |
|
historical language for UNIX manuals. |
|
|
It includes a man(1) manual viewer and additional tools. |
It includes a man(1) manual viewer and additional tools. |
For general information, see <http://mdocml.bsd.lv/>. |
For general information, see <http://mandoc.bsd.lv/>. |
|
|
In case you have questions or want to provide feedback, read |
In case you have questions or want to provide feedback, read |
<http://mdocml.bsd.lv/contact.html>. Consider subscribing to the |
<http://mandoc.bsd.lv/contact.html>. Consider subscribing to the |
discuss@ mailing list mentioned on that page. If you intend to |
discuss@ mailing list mentioned on that page. If you intend to |
help with the development of mandoc, consider subscribing to the |
help with the development of mandoc, consider subscribing to the |
tech@ mailing list, too. |
tech@ mailing list, too. |
|
|
Enjoy using the mandoc toolset! |
Enjoy using the mandoc toolset! |
|
|
Ingo Schwarze, Karlsruhe, July 2016 |
Ingo Schwarze, Karlsruhe, September 2021 |
|
|
|
|
Installation |
Installation |
Line 25 Before manually installing mandoc on your system, plea |
|
Line 27 Before manually installing mandoc on your system, plea |
|
whether the newest version of mandoc is already installed by default |
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 |
or available via a binary package or a ports system. A list of the |
latest bundled and ported versions of mandoc for various operating |
latest bundled and ported versions of mandoc for various operating |
systems is maintained at <http://mdocml.bsd.lv/ports.html>. |
systems is maintained at <http://mandoc.bsd.lv/ports.html>. |
|
|
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. If you want to build the CGI program, man.cgi(8), too, run the |
1. If you want to build the CGI program, man.cgi(8), too, |
command "echo BUILD_CGI=1 > configure.local". Then run "cp |
run the command "echo BUILD_CGI=1 >> configure.local". |
cgi.h.examples cgi.h" and edit cgi.h as desired. |
Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired. |
|
|
2. Define MANPATH_DEFAULT in configure.local |
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. |
|
|
|
3. Define MANPATH_DEFAULT in configure.local |
if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate |
if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate |
for your operating system. |
for your operating system. |
|
|
3. Run "./configure". |
4. Run "./configure". |
This script attempts autoconfiguration of mandoc for your system. |
This script attempts autoconfiguration of mandoc for your system. |
Read both its standard output and the file "Makefile.local" it |
Read both its standard output and the file "Makefile.local" it |
generates. If anything looks wrong or different from what you |
generates. If anything looks wrong or different from what you |
wish, read the file "configure.local.example", create and edit |
wish, read the file "configure.local.example", create and edit |
a file "configure.local", and re-run "./configure" until the |
a file "configure.local", and re-run "./configure" until the |
result seems right to you. |
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. |
|
|
|
4. Run "make". |
5. Run "make". |
Any POSIX-compatible make, in particular both BSD make and GNU make, |
Any POSIX-compatible make, in particular both BSD make and GNU make, |
should work. If the build fails, look at "configure.local.example" |
should work. If the build fails, look at "configure.local.example" |
and go back to step 2. |
and go back to step 2. |
|
|
5. Run "make -n install" and check whether everything will be |
6. Run "make -n install" and check whether everything will be |
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 3. |
variables into "configure.local" and go back to step 4. |
|
|
6. Run "sudo make install". If you intend to build a binary |
7. Optionally run the regression suite. |
|
Basically, that amounts to "make regress" to do a standard regression |
|
run, running all tests. For more fine-grained control, |
|
read "./mandoc -l regress/regress.pl.1", |
|
then run "cd regress && ./regress.pl" with optional arguments. |
|
The regression suite requires a reasonably modern Perl interpreter. |
|
Examples of systems that are too old to run the regression suite |
|
include Solaris 9, Solaris 10, and Mac OS X 10.4 Tiger. |
|
On Solaris 11, the suite does run, but some tests fail; |
|
look at the BUGS section of that manual page. |
|
|
|
8. 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. Run the command "sudo |
9. Run the command "sudo makewhatis" to build mandoc.db(5) databases |
makewhatis" to build mandoc.db(5) databases in all the directory |
in all the directory trees configured in step 3. Whenever installing |
trees configured in step 6. Whenever installing new manual pages, |
new manual pages, re-run makewhatis(8) to update the databases, or |
re-run makewhatis(8) to update the databases, or apropos(1) will |
apropos(1) will not find the new pages. |
not find the new pages. |
|
|
|
8. To set up a man.cgi(8) server, read its manual page. |
10. 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 a very small number of man(7) pages contain low-level |
that mandoc does not yet understand. On some BSD systems using |
roff(7) markup that mandoc does not yet understand. On some BSD |
mandoc, third-party software is vetted on whether it may be formatted |
systems using mandoc, third-party software is vetted on whether it |
with mandoc. If not, groff(1) is pulled in as a dependency and |
may be formatted with mandoc. If not, groff(1) is pulled in as a |
used to install a pre-formatted "catpage" instead of directly as |
dependency and used to install pre-formatted "catpages" instead of |
manual page source. |
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 |
Understanding mandoc dependencies |
Line 87 The following libraries are required: |
|
Line 105 The following libraries are required: |
|
|
|
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 |
will be used, so you need not worry in that case. But be careful: the |
will be used, so you need not worry in that case. But be careful: old |
glibc version of fts(3) is known to be broken on 32bit platforms, |
glibc versions of fts(3) were known to be broken on 32bit platforms, |
see <https://sourceware.org/bugzilla/show_bug.cgi?id=15838>. |
see <https://sourceware.org/bugzilla/show_bug.cgi?id=11460>. |
|
That was presumably fixed in glibc-2.23. |
If you run into that problem, set "HAVE_FTS=0" in configure.local. |
If you run into that problem, set "HAVE_FTS=0" in configure.local. |
|
|
3. Marc Espie's ohash(3) library. |
3. Marc Espie's ohash(3) library. |