share/mk/: build-html: Don't build mbind.2 and set_mempolicy.2

[thirdparty/man-pages.git] / README

diff --git a/README b/README
index 05f0e5117c283d88ba7a33c69107085860f848a1..ad65c8d008e726a8fec2e6742b921f2095a2dc22 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,136 @@
-This package contains Linux man pages for sections 1 through 8.  Some
-more information is given in the 'man-pages-x.y.Announce' file.
-
-Homepage
-========
-For information about the Linux man-pages project, see
-http://www.kernel.org/doc/man-pages/index.html.
-
-Bug reports and contributing
-============================
-If you have corrections and additions to suggest, see
-http://www.kernel.org/doc/man-pages/contributing.html
-(Although there is a mirror of this repository on GitHub,
-please don't report issues via the GitHub issue tracker!)
-
-For further information on contributing, see the CONTRIBUTING file.
-
-Installing and uninstalling
-===========================
-See the 'INSTALL' file.
-
-Copyrights
-==========
-See the 'man-pages-x.y.Announce' file.
+Name
+       Linux man-pages - manual pages for GNU/Linux
+
+Synopsis
+       This package contains GNU/Linux manual pages for sections 1
+       through 8.
+
+Description
+       The manual pages in this project document primarily the Linux
+       kernel and the GNU C library, but also consider relevant
+       differences in other kernels or C libraries.
+
+       These pages are most of the section 2, 3, 4, 5, 7 man pages for
+       GNU/Linux.  A few pages are provided in sections 1 and 8 for
+       commands that are not documented in other packages, and there are
+       a few pages in sections 5 and 8 for the timezone utilities.
+
+Files
+   CONTRIBUTING
+   CONTRIBUTING.d/*
+       Instructions for reporting bugs and contributing.
+
+   INSTALL
+       Instructions for installing and uninstalling.
+
+   MAINTAINER_NOTES
+       Notes for maintainers.
+
+   README
+       Main information about the project and the repository.
+
+   RELEASE
+       Instructions for releasing and distributing new versions.
+
+   Changes, Changes.old
+       Change log.  Includes most relevant changes.  However, it's not
+       as complete as the git(1) log.
+
+   GNUmakefile, share/mk/*
+       Build system.  For help, consult the <INSTALL> file, and run
+       'make help'.
+
+   lsm
+       Linux software map.  See also <https://lsm.qqx.org/>.
+
+   LICENSES/*.txt
+       Licenses in use by the project.
+
+   etc/*
+       Configuration files for (linter) programs called by the build
+       system.
+
+   man*/*
+       Manual pages.
+
+   scripts/*
+       Useful scripts for maintainers.
+
+   .tmp/
+       Default directory for files created by the build system.
+
+Versions
+   Distribution
+       <https://kernel.org/pub/linux/docs/man-pages/>
+       <https://www.alejandro-colomar.es/share/dist/man-pages/>
+
+   Git
+       <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/>
+       <https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/>
+
+   Online man-pages
+       PDF
+             <https://kernel.org/pub/linux/docs/man-pages/book/>
+             <https://www.alejandro-colomar.es/share/dist/man-pages/>
+       HTML
+             <https://man7.org/linux/man-pages/index.html>
+
+History
+   Tarballs
+       Tarballs of man-pages-1.* releases are available at:
+       <https://www.win.tue.nl/~aeb/ftpdocs/linux-local/manpages.archive/>
+
+   Maintainers
+       Alejandro Colomar <alx@kernel.org> <https://www.alejandro-colomar.es/>
+             2020 - present (5.09 - HEAD)
+       Michael Kerrisk <mtk.manpages@gmail.com> <https://man7.org/>
+             2004 - 2021    (2.00 - 5.13)
+       Andries Brouwer <aeb@cwi.nl> <https://www.win.tue.nl/~aeb>
+             1995 - 2004    (1.6  - 1.70)
+       Rik Faith <https://www.cs.unc.edu/~faith/>
+             1993 - 1995    (1.0  - 1.5)
+
+Caveats
+       Some projects provide their own manual pages, not related to the
+       Linux man-pages project.
+
+Bugs
+       See the <CONTRIBUTING> file.
+
+Copyright
+       Several free/open source licenses.  See the <LICENSES/>
+       directory, and the comment at the top of each source file.
+
+See also
+       man-pages(7)
+
+   Website
+       <https://www.kernel.org/doc/man-pages/index.html>.
+
+   Downstream packages
+       Arch man-pages
+             <https://archlinux.org/packages/core/any/man-pages/>
+       Debian manpages
+             <https://tracker.debian.org/pkg/manpages>
+       Fedora rpms/man-pages
+             <https://src.fedoraproject.org/rpms/man-pages>
+       Gentoo sys-apps/man-pages
+             <https://packages.gentoo.org/packages/sys-apps/man-pages>
+       openSUSE man-pages
+             <https://software.opensuse.org/package/man-pages>
+
+   Related projects
+       Debian manpages-l10n
+             <https://manpages-l10n-team.pages.debian.net/manpages-l10n/>
+       GNU C Library (glibc)
+             <https://www.gnu.org/software/libc/>
+       GNU Compiler Collection (GCC)
+             <https://gcc.gnu.org/>
+       GNU roff (groff)
+             <https://www.gnu.org/software/groff/>
+       Linux kernel
+             <https://www.kernel.org/doc/html/latest/
+       man-db
+             <https://man-db.gitlab.io/man-db/>
+       mandoc
+             <https://mandoc.bsd.lv/>