mandoc/INSTALL - diff

Return to INSTALL CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/INSTALL between version 1.20 and 1.24

version 1.20, 2017/07/28 14:57:56

version 1.24, 2021/09/20 13:25:42

Line 18 tech@ mailing list, too.

Enjoy using the mandoc toolset!

Ingo Schwarze, Karlsruhe, July 2017

Ingo Schwarze, Karlsruhe, September 2021

Installation

Line 54 generates. If anything looks wrong or different from

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.

5. Run "make".

Any POSIX-compatible make, in particular both BSD make and GNU make,

Line 67 installed to the intended places. Otherwise, put some

Line 65 installed to the intended places. Otherwise, put some

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

7. Optionally run the regression suite.

Basically, that amounts to "cd regress && ./regress.pl".

Basically, that amounts to "make regress" to do a standard regression

But you should probably look at "./mandoc -l regress/regress.pl.1"

run, running all tests. For more fine-grained control,

first.

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

Line 83 apropos(1) will not find the new pages.

Line 87 apropos(1) will not find the new pages.

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

CVSweb