share/mk/: Fix includes
[man-pages.git] / README
blobad65c8d008e726a8fec2e6742b921f2095a2dc22
1 Name
2        Linux man-pages - manual pages for GNU/Linux
4 Synopsis
5        This package contains GNU/Linux manual pages for sections 1
6        through 8.
8 Description
9        The manual pages in this project document primarily the Linux
10        kernel and the GNU C library, but also consider relevant
11        differences in other kernels or C libraries.
13        These pages are most of the section 2, 3, 4, 5, 7 man pages for
14        GNU/Linux.  A few pages are provided in sections 1 and 8 for
15        commands that are not documented in other packages, and there are
16        a few pages in sections 5 and 8 for the timezone utilities.
18 Files
19    CONTRIBUTING
20    CONTRIBUTING.d/*
21        Instructions for reporting bugs and contributing.
23    INSTALL
24        Instructions for installing and uninstalling.
26    MAINTAINER_NOTES
27        Notes for maintainers.
29    README
30        Main information about the project and the repository.
32    RELEASE
33        Instructions for releasing and distributing new versions.
35    Changes, Changes.old
36        Change log.  Includes most relevant changes.  However, it's not
37        as complete as the git(1) log.
39    GNUmakefile, share/mk/*
40        Build system.  For help, consult the <INSTALL> file, and run
41        'make help'.
43    lsm
44        Linux software map.  See also <https://lsm.qqx.org/>.
46    LICENSES/*.txt
47        Licenses in use by the project.
49    etc/*
50        Configuration files for (linter) programs called by the build
51        system.
53    man*/*
54        Manual pages.
56    scripts/*
57        Useful scripts for maintainers.
59    .tmp/
60        Default directory for files created by the build system.
62 Versions
63    Distribution
64        <https://kernel.org/pub/linux/docs/man-pages/>
65        <https://www.alejandro-colomar.es/share/dist/man-pages/>
67    Git
68        <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/>
69        <https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/>
71    Online man-pages
72        PDF
73              <https://kernel.org/pub/linux/docs/man-pages/book/>
74              <https://www.alejandro-colomar.es/share/dist/man-pages/>
75        HTML
76              <https://man7.org/linux/man-pages/index.html>
78 History
79    Tarballs
80        Tarballs of man-pages-1.* releases are available at:
81        <https://www.win.tue.nl/~aeb/ftpdocs/linux-local/manpages.archive/>
83    Maintainers
84        Alejandro Colomar <alx@kernel.org> <https://www.alejandro-colomar.es/>
85              2020 - present (5.09 - HEAD)
86        Michael Kerrisk <mtk.manpages@gmail.com> <https://man7.org/>
87              2004 - 2021    (2.00 - 5.13)
88        Andries Brouwer <aeb@cwi.nl> <https://www.win.tue.nl/~aeb>
89              1995 - 2004    (1.6  - 1.70)
90        Rik Faith <https://www.cs.unc.edu/~faith/>
91              1993 - 1995    (1.0  - 1.5)
93 Caveats
94        Some projects provide their own manual pages, not related to the
95        Linux man-pages project.
97 Bugs
98        See the <CONTRIBUTING> file.
100 Copyright
101        Several free/open source licenses.  See the <LICENSES/>
102        directory, and the comment at the top of each source file.
104 See also
105        man-pages(7)
107    Website
108        <https://www.kernel.org/doc/man-pages/index.html>.
110    Downstream packages
111        Arch man-pages
112              <https://archlinux.org/packages/core/any/man-pages/>
113        Debian manpages
114              <https://tracker.debian.org/pkg/manpages>
115        Fedora rpms/man-pages
116              <https://src.fedoraproject.org/rpms/man-pages>
117        Gentoo sys-apps/man-pages
118              <https://packages.gentoo.org/packages/sys-apps/man-pages>
119        openSUSE man-pages
120              <https://software.opensuse.org/package/man-pages>
122    Related projects
123        Debian manpages-l10n
124              <https://manpages-l10n-team.pages.debian.net/manpages-l10n/>
125        GNU C Library (glibc)
126              <https://www.gnu.org/software/libc/>
127        GNU Compiler Collection (GCC)
128              <https://gcc.gnu.org/>
129        GNU roff (groff)
130              <https://www.gnu.org/software/groff/>
131        Linux kernel
132              <https://www.kernel.org/doc/html/latest/
133        man-db
134              <https://man-db.gitlab.io/man-db/>
135        mandoc
136              <https://mandoc.bsd.lv/>