mandoc/INSTALL - diff

Return to INSTALL CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/INSTALL between version 1.15.2.4 and 1.21

version 1.15.2.4, 2017/02/22 09:41:23

version 1.21, 2018/07/31 10:18:15

Line 1

$Id$

************************************************************************

About the portable mandoc distribution

* This is a backward compatibility release.

--------------------------------------

* Unless you need compatibility with the old SQLite3-based mandoc.db(5)

The mandoc manpage compiler toolset (formerly called "mdocml")

* database format, please use the mandoc-1.14.1 release instead:

is a suite of tools compiling mdoc(7), the roff(7) macro language

* http://mdocml.bsd.lv/snapshots/mdocml-1.14.1.tar.gz

of choice for BSD manual pages, and man(7), the predominant

************************************************************************

historical language for UNIX manuals.

About mdocml, the portable mandoc distribution

----------------------------------------------

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.

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

<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

help with the development of mandoc, consider subscribing to the

tech@ mailing list, too.

Enjoy using the mandoc toolset!

Ingo Schwarze, Karlsruhe, February 2017

Ingo Schwarze, Karlsruhe, August 2018

Installation

Line 32 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

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 <http://mandoc.bsd.lv/ports.html>.

Regarding how packages and ports are maintained for your operating

system, please consult your operating system documentation.

Line 42 To install mandoc manually, the following steps are ne

Line 37 To install mandoc manually, the following steps are ne

run the command "echo BUILD_CGI=1 >> configure.local".

Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.

2. Run "./configure".

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

for your operating system.

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

Line 52 result seems right to you.

Line 57 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. Run "make".

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 "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*

variables into "configure.local" and go back to step 2.

variables into "configure.local" and go back to step 4.

5. Optionally run the regression suite.

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". 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.

7. If you want to use the integrated man(1) and your system uses

9. Run the command "sudo makewhatis" to build mandoc.db(5) databases

manpath(1), make sure it is configured correctly, in particular,

in all the directory trees configured in step 3. Whenever installing

it returns all directory trees where manual pages are installed.

Otherwise, if your system uses man.conf(5), make sure it contains

a "manpath" line for each directory tree, and the order of these

lines meets your wishes.

8. Run the command "sudo makewhatis" to build mandoc.db(5) databases

in all the directory trees configured in step 6. Whenever installing

new manual 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.

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

---------------------------------

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.

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.

3. Marc Espie's ohash(3) library.

CVSweb