X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fman-pages.git;a=blobdiff_plain;f=README;h=9de67a06fa8e2ab40b6121b453ea1aa10a7be9e3;hp=239f41532b281ff1b35bdca97f34a169c3b144cb;hb=HEAD;hpb=c11b1abf2e2241d8efe19feb04c2a7e1e06c19b0 diff --git a/README b/README index 239f41532b..ad65c8d008 100644 --- a/README +++ b/README @@ -1,40 +1,136 @@ -This package contains the Linux man pages for all chapters -except 1, 6 and 8. Some more information is given in the -`Announce' file. - -Install by copying to your favourite location. -"make install" will just copy them to /usr/share/man/man[1-8]. -"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: - *_module.2, get_kernel_syms.2 (found in modutils-2.1.*), - 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*). - -Note that the pages that come with GNU fileutils are really -help texts (indeed, are generated automatically from help texts), -and worse than worthless. Without them people would have good -detailed man pages, such as those found here in man1. -As it is, many distributions install these "man pages", -to the detriment of their users. - -Copyrights: These man pages come under various copyrights. -For the POSIX pages, see the file POSIX-COPYRIGHT. -All other pages are freely distributable when the nroff source is included. - -Send corrections and additions to mtk.manpages@gmail.com -(man.7 has some info on the macros to use). +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 file, and run + 'make help'. + + lsm + Linux software map. See also . + + 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 + + + + Git + + + + Online man-pages + PDF + + + HTML + + +History + Tarballs + Tarballs of man-pages-1.* releases are available at: + + + Maintainers + Alejandro Colomar + 2020 - present (5.09 - HEAD) + Michael Kerrisk + 2004 - 2021 (2.00 - 5.13) + Andries Brouwer + 1995 - 2004 (1.6 - 1.70) + Rik 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 file. + +Copyright + Several free/open source licenses. See the + directory, and the comment at the top of each source file. + +See also + man-pages(7) + + Website + . + + Downstream packages + Arch man-pages + + Debian manpages + + Fedora rpms/man-pages + + Gentoo sys-apps/man-pages + + openSUSE man-pages + + + Related projects + Debian manpages-l10n + + GNU C Library (glibc) + + GNU Compiler Collection (GCC) + + GNU roff (groff) + + Linux kernel + + mandoc +