Nowadays mandb has provision to understand a character set
encoding that is explicitly indicated in the first line
of the source. As pointed out by Colin Watson, including
such an explicit indication on pages encoded in anything
other than ISO 8859-1 or UTF-8 is useful for man-pages
that aren't shipped in UTF-8.
See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=519209
and for some other background (responded to by Colin Watson
in the above report):
http://thread.gmane.org/gmane.comp.internationalization.linux/6040
("man page encoding", 5 Jul 2005)
Reported-by: Colin Watson <cjwatson@debian.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
The page should use the type specified by POSIX,
rather than the (equivalent) type used in the kernel
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
The page should use the types specified by POSIX,
rather than the (equivalent) types used in the kernel.
See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=517074
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Probably it's clearer to describe the length of the IPC object
name as a count that excludes the null terminator.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Because of the "sem." prefix added by glibc to a semaphore
name, the limit on the length of the name (excluding the
terminating null byte) is 251 characters.
Reported-by: Jens Thoms Toerring <jt@toerring.de>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
No actual change to formatted output, but this makes the
page sources more consistent for the purpose of grepping, etc.
Reported-by: Sam Varshavchik <mrsam@courier-mta.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
In SEE ALSO, when a few man pages are referenced, those are divided by commas.
Every reference is on a separate line, and all lines but the last one should
end with comma. I spotted one place where there is no comma in between
references, and mocked up an awk script to find similar places:
for f in man*/*; do awk '/^.SH ["]SEE ALSO["]/ {sa=1; print "== " FILENAME " =="; print; next } /^\.(PP|SH)/ {sa=0; no=0; next} /^\.BR/ { if (sa==1) { print; if (no == 1) print "Missing comma in " FILENAME " +" FNR-1; no=0 } } /^\.BR .*)$/ { if (sa==1) no=1; next } /\.\\"/ {next} /.*/ { if (sa==1) { print; next }}' $f; done | fgrep 'Missing comma'
This patch fixes all the places found by the above script.
Also, there is an extra dot at the end of uri.7 "SEE ALSO" section.
Removed as per man-pages(7) recommendation.
Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
The POSIX timers API is implemented (mostly) within the kernel,
so thse interfaces are system calls. Although there are as yet
no man pages, when they are added they should be in Section 2,
not 3. Therefore fix those pages that currently refer to these
interfaces as being in Section 3.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This /proc interface appeared in 2.6.28. but will be
removed in 2.6.29.
Also, document change in default value of
/proc/sys/fs/epoll/max_user_watches (was 1/32 of lowmem,
now 1/25 of lowmem).
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Document the following /proc files that were added in
Linux 2.6.28:
/proc/sys/fs/epoll/max_user_instances
/proc/sys/fs/epoll/max_user_watches
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Michael Kerrisk