version 1.11, 2015/03/19 14:57:29 |
version 1.16, 2016/07/19 21:31:55 |
Line 16 tech@ mailing list, too. |
|
Line 16 tech@ mailing list, too. |
|
|
|
Enjoy using the mandoc toolset! |
Enjoy using the mandoc toolset! |
|
|
Ingo Schwarze, Karlsruhe, March 2015 |
Ingo Schwarze, Karlsruhe, July 2016 |
|
|
|
|
Installation |
Installation |
Line 52 and go back to step 2. |
|
Line 52 and go back to step 2. |
|
|
|
4. Run "make -n install" and check whether everything will be |
4. 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 2. |
variables into "configure.local" and go back to step 2. |
|
|
5. Run "sudo make install". If you intend to build a binary |
5. 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 |
Line 63 in the "Makefile" to understand how DESTDIR is used. |
|
Line 63 in the "Makefile" to understand how DESTDIR is used. |
|
manpath(1), make sure it is configured correctly, in particular, |
manpath(1), make sure it is configured correctly, in particular, |
it returns all directory trees where manual pages are installed. |
it returns all directory trees where manual pages are installed. |
Otherwise, if your system uses man.conf(5), make sure it contains |
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. |
lines meets your wishes. |
|
|
7. If you compiled with database support, run the command "sudo |
7. Run the command "sudo |
makewhatis" to build mandoc.db(5) databases in all the directory |
makewhatis" to build mandoc.db(5) databases in all the directory |
trees configured in step 6. Whenever installing new manual pages, |
trees configured in step 6. Whenever installing new manual pages, |
re-run makewhatis(8) to update the databases, or apropos(1) will |
re-run makewhatis(8) to update the databases, or apropos(1) will |
Line 84 manual page source. |
|
Line 84 manual page source. |
|
|
|
Understanding mandoc dependencies |
Understanding mandoc dependencies |
--------------------------------- |
--------------------------------- |
The mandoc(1), man(1), and demandoc(1) utilities have no external |
The following libraries are required: |
dependencies, but makewhatis(8) and apropos(1) depend on the |
|
following 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. |
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 |
Line 108 If you run into that problem, set "HAVE_FTS=0" in conf |
|
Line 98 If you run into that problem, set "HAVE_FTS=0" in conf |
|
3. Marc Espie's ohash(3) library. |
3. Marc Espie's ohash(3) library. |
If your system does not have it, the bundled compatibility version |
If your system does not have it, the bundled compatibility version |
will be used, so you probably need not worry about it. |
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 |
Checking autoconfiguration quality |