README: Update generally

    * Reflect fact that project ships pages in sections 1-8.

    * Resync documentation of the basic Makefile targets with what they
      actually do at present.  Slighly simplify discussion.

    * Put the man page overlaps into a table.
      + Drop references to overlaps with the old a.out ld.so, long dead.

    * Update reference to Announce file to use current naming convention.
      + Send people looking for copyright information there rather than
        duplicating some of it here.

    * Direct reader to the top-level homepage instead of more deeply to the
      "Contributing" page.

    * Reflow paragraphs to 72 columns.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/README b/README
index 0ec038fed28b05f3438db39a1a2746417169b5ae..b24099f23c09963115f18b36cc9eb6e5f07ebb64 100644 (file)
--- a/README
+++ b/README
@@ -1,33 +1,37 @@
-This package contains Linux man pages for sections
-2, 3, 4, 5, and 7. Some more information is given in the
-`Announce' file.
+This package contains Linux man pages for sections 1 through 8.  Some
+more information is given in the 'man-pages-x.y.Announce' file.
 
-Install by copying to your favourite location.
-"make install" will just copy them to /usr/share/man/man[1-8].
-To install to a path different from /usr use
+Installing and uninstalling
+===========================
+"make install" will copy these man pages to /usr/share/man/man[1-8].
+
+To install to a path different from /usr, use
 "make install prefix=/install/path".
-"make" will move the pages from this package that are older than
-the already installed ones to a subdirectory `not_installed',
-then remove old versions (compressed or not),
-compress the pages, and copy them to /usr/share/man/man[1-8].
-
-
-Note that you may have to remove preformatted pages.
-
-Note that sometimes these pages are duplicates of pages
-also distributed in other packages. This has been reported
-about dlclose.3, dlerror.3, dlopen.3, dlsym.3 (found in ld.so),
-about resolver.3, resolv.conf.5 (found in bind-utils),
-and about passwd.5, and mailaddr.7. Be careful not to
-overwrite more up-to-date versions.
-Reports on further duplicates are welcome.
-Formerly present and now removed duplicates:
- exports.5 (found in nfs-server-2.2*),
- fstab.5, nfs.5 (found in util-linux-2.12*),
- lilo.8, lilo.conf.5 (found in lilo-21.6*).
-
-Copyrights: These man pages come under various copyrights.
-All pages are freely distributable when the nroff source is included.
-
-If you have corrections and additions to suggest, see
-http://www.kernel.org/doc/man-pages/contributing.html
+
+"make remove" or "make uninstall" will remove any man page in this
+distribution from its destination.  Use with caution, and remember to
+use "prefix" if desired, as with the "install" target.
+
+"make" or "make all" will perform "make uninstall" followed by "make
+install".
+
+Man page overlap and duplication
+================================
+Note that sometimes these pages are duplicates of pages also distributed
+in other packages.  This has been reported about:
+
+man page                also found in
+-------------------------------------
+resolver.3              bind-utils, bind9utils
+resolv.conf.5           "
+passwd.5                shadow, passwd
+mailaddr.7              ?
+
+Copyrights
+==========
+See the 'man-pages-x.y.Announce' file.
+
+Homepage
+========
+For much more about the Linux man-pages project, see
+< http://www.kernel.org/doc/man-pages/index.html >.