summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README138
1 files changed, 138 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..9925ac1
--- /dev/null
+++ b/README
@@ -0,0 +1,138 @@
+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
+ 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.
+
+ Makefile, share/mk/*
+ Build system. For help, consult the <INSTALL> file, and run
+ 'make help'.
+
+ lsm
+ Linux software map. See also <https://lsm.qqx.org/>.
+
+ .mailmap
+ See gitmailmap(5).
+
+ 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
+ Tarballs
+ <https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/>
+
+ Git
+ <git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git>
+ <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/>
+
+ A secondary git(1) repository can be found at:
+ <git://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git>
+ <http://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/>
+
+ Online man-pages
+ PDF
+ <https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/book/>
+
+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> <http://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
+ <http://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/>