[PATCH 23/23] INSTALL: Tweak help for man-page-related configuration options.

[G. Branden Robinson]

---
 INSTALL | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)

diff --git a/INSTALL b/INSTALL
index 73b6d065e..da0b79e55 100644
--- a/INSTALL
+++ b/INSTALL
@@ -709,7 +709,7 @@ CONFIGURE OPTIONS:
        Use rpath option when generating shared libraries, and (with some
        restrictions) when linking the corresponding programs.  This originally
        (in 1997) applied mainly to systems using the GNU linker (read the
-       manpage).
+       man page).
 
        More recently it is useful for systems that require special treatment
        shared libraries in "unusual" locations.  The "system" libraries reside
@@ -1103,34 +1103,35 @@ CONFIGURE OPTIONS:
                ./configure --enable-static
 
     --with-manpage-aliases
-       Tell the configure script you wish to create entries in the
-       man-directory for aliases to manpages which list them, e.g., the
-       functions in the panel manpage.  This is the default.  You can disable
-       it if your man program does this.  You can also disable
-       --with-manpage-symlinks to install files containing a ".so" command
-       rather than symbolic links.
+       Create files in subdirectories of the installation "man" directory that
+       alias the man pages documenting them.  For example, the "beep" man page
+       also documents the function "flash".  This is the default.  You can
+       disable this procedure if your system's makewhatis(8) or mandb(8)
+       program indexes the directory to which the pages are installed.  If you
+       disable man page symlinks by specifying "--without-manpage-symlinks",
+       the alias pages are created as stubs containing ".so" *roff requests.
 
     --with-manpage-format=XXX
        Tell the configure script how you would like to install man-pages.  The
-       option value must be one of these:  gzip, compress, BSDI, normal,
-       formatted.  If you do not give this option, the configure script
+       option value must be one of these: "gzip", "compress", "BSDI", "normal",
+       "formatted".  If you do not specify this option, the configure script
        attempts to determine which is the case.
 
     --with-manpage-renames=XXX
-       Tell the configure script that you wish to rename the manpages while
-       installing.  Currently the only distribution which does this is Debian.
+       Tell the configure script that you wish to rename the man pages when
+       installing them.  Debian and distributions descended from it do this.
        The option value specifies the name of a file that lists the renamed
-       files, e.g., $srcdir/man/man_db.renames
+       files, e.g., "$srcdir/man/man_db.renames".
 
     --with-manpage-symlinks
        Tell the configure script that you wish to make symbolic links in the
        man-directory for aliases to the man-pages.  This is the default, but
-       can be disabled for systems that provide this automatically.  Doing
-       this on systems that do not support symbolic links will result in
-       copying the man-page for each alias.
+       can be disabled for systems that provide this service automatically.
+       Doing this on systems that do not support symbolic links creates a copy
+       of the target man page for each alias.
 
     --with-manpage-tbl
-       Tell the configure script that you wish to preprocess the manpages
+       Tell the configure script that you wish to preprocess the man pages
        by running them through tbl to generate tables understandable by
        nroff.
 
@@ -1397,10 +1398,10 @@ CONFIGURE OPTIONS:
 
     --without-curses-h
        Don't install the ncurses header with the name "curses.h".  Rather,
-       install as "ncurses.h" and modify the installed headers and manpages
+       install as "ncurses.h" and modify the installed headers and man pages
        accordingly.
 
-       Likewise, do not install an alias "curses" for the ncurses manpage.
+       Likewise, do not install an alias "curses" for the ncurses man page.
 
     --without-cxx
        XSI curses declares "bool" as part of the interface.  C++ also declares
@@ -1423,7 +1424,7 @@ CONFIGURE OPTIONS:
        Do not use dlsym() to load GPM dynamically.
 
     --without-manpages
-       Tell the configure script to suppress the install of ncurses' manpages.
+       Tell the configure script to suppress the install of ncurses' man pages.
 
     --without-progs
        Tell the configure script to suppress the build of ncurses' application
-- 
2.30.2

signature.asc
Description: PGP signature