clarify the difference between .Cm and .Ic;

[mandoc.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 2a908e91c5c30e747fd342ff26f6a3efa5ccf072..3c09f3f214cb91044a718cd6f4e973e06d7ac491 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,4 @@
-$Id: INSTALL,v 1.19 2017/06/23 15:58:14 schwarze Exp $
+$Id: INSTALL,v 1.23 2019/03/06 15:58:10 schwarze Exp $

 
 About the portable mandoc distribution
 --------------------------------------
 
 About the portable mandoc distribution
 --------------------------------------


@@ -18,7 +18,7 @@ tech@ mailing list, too.
 
 Enjoy using the mandoc toolset!
 
 
 Enjoy using the mandoc toolset!
 

-Ingo Schwarze, Karlsruhe, February 2017
+Ingo Schwarze, Karlsruhe, March 2019

 
 
 Installation
 
 
 Installation


@@ -37,7 +37,7 @@ To install mandoc manually, the following steps are needed:
 run the command "echo BUILD_CGI=1 >> configure.local".
 Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.
 
 run the command "echo BUILD_CGI=1 >> configure.local".
 Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.
 

-2. If you also want to build the new catman(8) utility, run the
+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
 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


@@ -54,8 +54,6 @@ generates.  If anything looks wrong or different from what you
 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.
 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,
 
 5. Run "make".
 Any POSIX-compatible make, in particular both BSD make and GNU make,


@@ -69,7 +67,8 @@ variables into "configure.local" and go back to step 4.
 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"
 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.
+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
 package using some kind of fake root mechanism, you may need a
 
 8. Run "sudo make install".  If you intend to build a binary
 package using some kind of fake root mechanism, you may need a


@@ -77,18 +76,20 @@ command like "make DESTDIR=... install".  Read the *-install targets
 in the "Makefile" to understand how DESTDIR is used.
 
 9. Run the command "sudo makewhatis" to build mandoc.db(5) databases
 in the "Makefile" to understand how DESTDIR is used.
 
 9. Run the command "sudo makewhatis" to build mandoc.db(5) databases

-in all the directory trees configured in step 6.  Whenever installing
+in all the directory trees configured in step 3.  Whenever installing

 new manual pages, re-run makewhatis(8) to update the databases, or
 apropos(1) will not find the new pages.
 
 10. To set up a man.cgi(8) server, read its manual page.
 
 new manual pages, re-run makewhatis(8) to update the databases, or
 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
-that mandoc does not yet understand.  On some BSD systems using
-mandoc, third-party software is vetted on whether it may be formatted
-with mandoc.  If not, groff(1) is pulled in as a dependency and
-used to install a pre-formatted "catpage" instead of directly as
-manual page source.
+Note that a very small number of man(7) pages contain low-level
+roff(7) markup that mandoc does not yet understand.  On some BSD
+systems using mandoc, third-party software is vetted on whether it
+may be formatted with mandoc.  If not, groff(1) is pulled in as a
+dependency and used to install pre-formatted "catpages" instead of
+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