version 1.20, 2017/07/28 14:57:56 |
version 1.23, 2019/03/06 15:58:10 |
Line 18 tech@ mailing list, too. |
|
Line 18 tech@ mailing list, too. |
|
|
|
Enjoy using the mandoc toolset! |
Enjoy using the mandoc toolset! |
|
|
Ingo Schwarze, Karlsruhe, July 2017 |
Ingo Schwarze, Karlsruhe, March 2019 |
|
|
|
|
Installation |
Installation |
Line 54 generates. If anything looks wrong or different from |
|
Line 54 generates. If anything looks wrong or different from |
|
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. |
|
|
|
5. 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, |
Line 69 variables into "configure.local" and go back to step 4 |
|
Line 67 variables into "configure.local" and go back to step 4 |
|
7. Optionally run the regression suite. |
7. Optionally run the regression suite. |
Basically, that amounts to "cd regress && ./regress.pl". |
Basically, that amounts to "cd regress && ./regress.pl". |
But you should probably look at "./mandoc -l regress/regress.pl.1" |
But you should probably look at "./mandoc -l regress/regress.pl.1" |
first. |
first. In particular, regarding Solaris systems, look at the BUGS |
|
section of that manual page. |
|
|
8. 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 |
package using some kind of fake root mechanism, you may need a |
Line 83 apropos(1) will not find the new pages. |
|
Line 82 apropos(1) will not find the new pages. |
|
|
|
10. 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 |