mandoc/INSTALL - diff

Return to INSTALL CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/INSTALL between version 1.12 and 1.15.2.3

version 1.12, 2015/07/19 06:05:16

version 1.15.2.3, 2017/02/21 17:57:33

Line 16 tech@ mailing list, too.

Enjoy using the mandoc toolset!

Ingo Schwarze, Karlsruhe, March 2015

Ingo Schwarze, Karlsruhe, February 2017

Installation

Line 31 Regarding how packages and ports are maintained for yo

system, please consult your operating system documentation.

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. Run "./configure".

This script attempts autoconfiguration of mandoc for your system.

Line 52 and go back to step 2.

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

5. Run "sudo make install". If you intend to build a binary

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

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.

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

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

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

it returns all directory trees where manual pages are installed.

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

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

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

lines meets your wishes.

7. If you compiled with database support, run the command "sudo

8. 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 6. 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.

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

that mandoc does not yet understand. On some BSD systems using

Line 109 If you run into that problem, set "HAVE_FTS=0" in conf

Line 113 If you run into that problem, set "HAVE_FTS=0" in conf

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

If your system does not have it, the bundled compatibility version

will be used, so you probably need not worry about it.

One of the chief design goals of the mandoc toolbox is to make

sure that nothing related to documentation requires C++.

Consequently, linking mandoc against any kind of C++ program

would defeat the purpose and is not supported.

Checking autoconfiguration quality

CVSweb