]> git.ipfire.org Git - thirdparty/man-pages.git/log
thirdparty/man-pages.git
4 years agowait.2, getaddrinfo.3, getnameinfo.3: ffix: Bring greater consistency to FTM layout
Michael Kerrisk [Mon, 4 Jan 2021 09:10:05 +0000 (10:10 +0100)] 
wait.2, getaddrinfo.3, getnameinfo.3: ffix: Bring greater consistency to FTM layout

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoqecvt.3: Update feature test macro requirements
Michael Kerrisk [Mon, 4 Jan 2021 08:33:01 +0000 (09:33 +0100)] 
qecvt.3: Update feature test macro requirements

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Use .nf/.fi in SYNOPSIS
Michael Kerrisk [Mon, 4 Jan 2021 08:08:47 +0000 (09:08 +0100)] 
Various pages: Use .nf/.fi in SYNOPSIS

Fix various pages missed in commit
c7db92b96a3f88dc146a35d6851453e3b354f4fc.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agogetutent.3: ffix
Michael Kerrisk [Mon, 4 Jan 2021 07:54:44 +0000 (08:54 +0100)] 
getutent.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agobsd_signal.3: ffix
Michael Kerrisk [Mon, 4 Jan 2021 07:53:50 +0000 (08:53 +0100)] 
bsd_signal.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoscandir.3: ffix
Michael Kerrisk [Mon, 4 Jan 2021 07:48:01 +0000 (08:48 +0100)] 
scandir.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agostring.3: tfix
Michael Kerrisk [Sun, 3 Jan 2021 19:50:04 +0000 (20:50 +0100)] 
string.3: tfix

Reported-by: Pádraig Brady <P@draigBrady.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agostring.3: SEE ALSO: add bstring(3)
Michael Kerrisk [Sun, 3 Jan 2021 12:04:17 +0000 (13:04 +0100)] 
string.3: SEE ALSO: add bstring(3)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agobstring.3: SEE ALSO: add string(3)
Michael Kerrisk [Sun, 3 Jan 2021 12:03:47 +0000 (13:03 +0100)] 
bstring.3: SEE ALSO: add string(3)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Use .nf/.fi in SYNOPSIS
Michael Kerrisk [Sun, 3 Jan 2021 11:49:03 +0000 (12:49 +0100)] 
Various pages: Use .nf/.fi in SYNOPSIS

The majority of pages use .nf/.fi in SYNOPSIS, but there are
still many that don't and use .br to achieve newlines. Fix many
of those. This brings greater consistency to the pages, which
eases editing and may ease future scripted edits to the pages.

Many of these changes were script-assisted, with some additional
manual edits.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Further clean-ups after "bring more whitespace consistency in SYNOPSIS"
Michael Kerrisk [Sun, 3 Jan 2021 09:58:23 +0000 (10:58 +0100)] 
Various pages: Further clean-ups after "bring more whitespace consistency in SYNOPSIS"

Yet more clean-ups after commit
15d6565317dad749ef57e69023139bc405caab88.

Reported-by: Alejandro Colomar (man-pages) <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agowordexp.3: ffix
Michael Kerrisk [Sat, 2 Jan 2021 19:57:59 +0000 (20:57 +0100)] 
wordexp.3: ffix

Reported-by: "Alejandro Colomar" <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agogetcpu.2: Rewrite page to describe glibc wrapper function
Michael Kerrisk [Sat, 2 Jan 2021 08:33:10 +0000 (09:33 +0100)] 
getcpu.2: Rewrite page to describe glibc wrapper function

Since glibc 2.29, there is a wrapper for getcpu(2).
The wrapper has only 2 arguments, omitting the unused
third system call argument. Rework the manual page
to reflect this.

Reported-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Consistently use 'unsigned int'
Alejandro Colomar [Sat, 2 Jan 2021 07:31:43 +0000 (08:31 +0100)] 
Various pages: Consistently use 'unsigned int'

Most pages use 'unsigned int' (and the kernel too).
Make them all do so.

$ find man? -type f \
  | xargs sed -i \
-e 's/unsigned \*/unsigned int */g'
-e 's/unsigned "/unsigned int "/g';

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoget_phys_pages.3: Minor relocation of text
Michael Kerrisk [Fri, 1 Jan 2021 22:38:00 +0000 (23:38 +0100)] 
get_phys_pages.3: Minor relocation of text

Reported-by: Alejandro Colomar (man-pages) <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agooff64_t.3: New link to system_data_types(7)
Alejandro Colomar [Thu, 31 Dec 2020 19:14:58 +0000 (20:14 +0100)] 
off64_t.3: New link to system_data_types(7)

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosystem_data_types.7: Add off64_t to system_data_types(7)
Alejandro Colomar [Thu, 31 Dec 2020 19:14:57 +0000 (20:14 +0100)] 
system_data_types.7: Add off64_t to system_data_types(7)

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: clean-ups after "bring more whitespace consistency in SYNOPSIS"
Michael Kerrisk [Fri, 1 Jan 2021 21:24:55 +0000 (22:24 +0100)] 
Various pages: clean-ups after "bring more whitespace consistency in SYNOPSIS"

Cleann-ups after commit 15d6565317dad749ef57e69023139bc405caab88.

Reported-by: Alejandro Colomar (man-pages) <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: bring more whitespace consistency in SYNOPSIS
Michael Kerrisk [Fri, 1 Jan 2021 11:35:16 +0000 (12:35 +0100)] 
Various pages: bring more whitespace consistency in SYNOPSIS

The use of vertical white space in the SYNOPSIS sections
is rather inconsistent. Make it more consistent, subject to the
following heuristics:

* Prefer no blank lines between function signatures by default.
* Where many functions are defined in the SYNOPSIS, add blank
  lines where needed to improve readability, possibly by using
  blank lines to separate logical groups of functions.

Reported-by: Alejandro Colomar (man-pages) <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agogethostbyname.3: Move mention of <sys/socket.h> from SYNOPSIS to DESCRIPTION
Michael Kerrisk [Fri, 1 Jan 2021 11:23:57 +0000 (12:23 +0100)] 
gethostbyname.3: Move mention of <sys/socket.h> from SYNOPSIS to DESCRIPTION

The functions are all declared in <netdb.h>. <sys/socket.h> is only
needed for the AF_* constants.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoputs.3: Reorder functions more logically (group related fuinctions together)
Michael Kerrisk [Thu, 31 Dec 2020 22:38:02 +0000 (23:38 +0100)] 
puts.3: Reorder functions more logically (group related fuinctions together)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agogetdirentries.3: tfix
Michael Kerrisk [Thu, 31 Dec 2020 21:50:57 +0000 (22:50 +0100)] 
getdirentries.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agodrand48.3: tfix (Oxford comma)
Michael Kerrisk [Thu, 31 Dec 2020 20:19:28 +0000 (21:19 +0100)] 
drand48.3: tfix (Oxford comma)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agodl_iterate_phdr.3: wsppfix
Michael Kerrisk [Thu, 31 Dec 2020 20:16:41 +0000 (21:16 +0100)] 
dl_iterate_phdr.3: wsppfix

Reported-by: Alejandro Colomar (man-pages) <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoperfmonctl.2, pidfd_send_signal.2: ffix: Ensure statement about no wrapper function...
Michael Kerrisk [Thu, 31 Dec 2020 14:13:41 +0000 (15:13 +0100)] 
perfmonctl.2, pidfd_send_signal.2: ffix: Ensure statement about no wrapper function is a new paragraph

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agocopy_file_range.2: Document glibc wrapper instead of kernel syscall
Alejandro Colomar [Thu, 31 Dec 2020 13:24:08 +0000 (14:24 +0100)] 
copy_file_range.2: Document glibc wrapper instead of kernel syscall

Glibc uses 'off64_t' instead of 'loff_t'.

......

Glibc prototype:

$ syscall='copy_file_range';
$ ret='ssize_t';
$ find glibc/ -type f -name '*.h' \
  |xargs pcregrep -Mn "(?s)^[\w\s]*${ret}\s*${syscall}\s*\(.*?;";
glibc/posix/unistd.h:1121:
ssize_t copy_file_range (int __infd, __off64_t *__pinoff,
 int __outfd, __off64_t *__poutoff,
 size_t __length, unsigned int __flags);

......

Testing example:

$ man ./man2/copy_file_range.2 \
  |sed -n '/^EXAMPLES/,/^SEE ALSO/p' \
  |head -n -1 \
  |tail -n +2 \
  >copy_file_range.c
$ gcc -Wall -Wextra -Werror -pedantic
copy_file_range.c -o copy_file_range
$ ./copy_file_range
Usage: ./copy_file_range <source> <destination>
$ tee a >/dev/null
asdf
$ tee b >/dev/null
qwerty
zxcvbn
$ ./copy_file_range a b
$ cat a
asdf
$ cat b
asdf

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agowait4.2, endian.3, isalpha.3, unlocked_stdio.3: Minor consistency fix for Feature...
Michael Kerrisk [Thu, 31 Dec 2020 10:04:34 +0000 (11:04 +0100)] 
wait4.2, endian.3, isalpha.3, unlocked_stdio.3: Minor consistency fix for Feature Test Macro info

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agostrsignal.3: ffix
Michael Kerrisk [Thu, 31 Dec 2020 09:54:24 +0000 (10:54 +0100)] 
strsignal.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: s/Glibc versions </Glibc </ in Feature Test Macro discussions
Michael Kerrisk [Thu, 31 Dec 2020 09:52:41 +0000 (10:52 +0100)] 
Various pages: s/Glibc versions </Glibc </ in Feature Test Macro discussions

Use a more compact notation that will render less wide
on the terminal.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopread.2, rename.2, syscall.2, utimensat.2, gethostid.3, rcmd.3, seekdir.3, setnetgren...
Michael Kerrisk [Thu, 31 Dec 2020 09:48:51 +0000 (10:48 +0100)] 
pread.2, rename.2, syscall.2, utimensat.2, gethostid.3, rcmd.3, seekdir.3, setnetgrent.3, strerror.3, strsignal.3: ffix: Various tweaks for greater consistency in Feature Test Macros

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agochown.2, ffs.3, fpclassify.3, gamma.3, getgrent.3, ilogb.3, strdup.3: ffix
Michael Kerrisk [Thu, 31 Dec 2020 09:27:24 +0000 (10:27 +0100)] 
chown.2, ffs.3, fpclassify.3, gamma.3, getgrent.3, ilogb.3, strdup.3: ffix

Bring a bit more consistency to Feature Test Macro information
(mainly .PP between differnt FTM lists).

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoChanges.old: tfix
Michael Kerrisk [Thu, 31 Dec 2020 09:07:18 +0000 (10:07 +0100)] 
Changes.old: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Formatting fix
Michael Kerrisk [Thu, 31 Dec 2020 08:41:12 +0000 (09:41 +0100)] 
Various pages: Formatting fix

Use .PP (which gives a bit of vertical white space) rather than
.br to separate functions in Feature Test Macro requirement lists.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: srcfix: remove redundant .br
Michael Kerrisk [Thu, 31 Dec 2020 08:27:39 +0000 (09:27 +0100)] 
Various pages: srcfix: remove redundant .br

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agorecv.2: srcfix
Michael Kerrisk [Thu, 31 Dec 2020 08:24:56 +0000 (09:24 +0100)] 
recv.2: srcfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoget_phys_pages.3: glibc gets the info from sysinfo(2) since 2.23
Alejandro Colomar [Wed, 30 Dec 2020 21:41:47 +0000 (22:41 +0100)] 
get_phys_pages.3: glibc gets the info from sysinfo(2) since 2.23

See glibc's commit: 0ce657c576bf1b24
https://sourceware.org/git/?p=glibc.git;a=commitdiff;h=0ce657c576bf1b24

Reported-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agokeyctl.2: SYNOPSIS: Fix prototype parameter types
Alejandro Colomar [Wed, 30 Dec 2020 21:41:44 +0000 (22:41 +0100)] 
keyctl.2: SYNOPSIS: Fix prototype parameter types

The Linux kernel uses 'unsigned long'.
There's no reason to use the typedef '__kernel_ulong_t'.

......

$ syscall='keyctl';
$ find linux/ -type f -name '*.c' \
  |xargs pcregrep -Mn "(?s)^[\w_]*SYSCALL_DEFINE.\(${syscall},.*?\)";
linux/security/keys/keyctl.c:1869:
SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
unsigned long, arg4, unsigned long, arg5)
linux/security/keys/compat.c:17:
COMPAT_SYSCALL_DEFINE5(keyctl, u32, option,
       u32, arg2, u32, arg3, u32, arg4, u32, arg5)

Cc: Eugene Syromyatnikov <evgsyr@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agodelete_module.2: SYNOPSIS: Fix prototype parameter types
Alejandro Colomar [Wed, 30 Dec 2020 21:41:43 +0000 (22:41 +0100)] 
delete_module.2: SYNOPSIS: Fix prototype parameter types

The Linux kernel uses 'unsigned int' instead of 'int' for the
'flags' parameter.  As glibc provides no wrapper, use the same
type the kernel uses.

......

$ syscall='delete_module';
$ find linux/ -type f -name '*.c' \
  |xargs pcregrep -Mn "(?s)^[\w_]*SYSCALL_DEFINE.\(${syscall},.*?\)";
linux/kernel/module.c:977:
SYSCALL_DEFINE2(delete_module, const char __user *, name_user,
unsigned int, flags)

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agokexec_load.2: wfix
Michael Kerrisk [Wed, 30 Dec 2020 16:02:42 +0000 (17:02 +0100)] 
kexec_load.2: wfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Normalize NOTES about nonexistent glibc wrappers
Ganimedes Colomar [Wed, 30 Dec 2020 15:20:26 +0000 (16:20 +0100)] 
Various pages: Normalize NOTES about nonexistent glibc wrappers

See previous commit.

This commit normalizes texts under sections other than SYNOPSIS
(most of them in NOTES).

Signed-off-by: Ganimedes Colomar <gacoan.linux@gmail.com>
Cowritten-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Normalize SYNOPSIS notes about nonexistent glibc wrappers
Ganimedes Colomar [Wed, 30 Dec 2020 15:20:25 +0000 (16:20 +0100)] 
Various pages: Normalize SYNOPSIS notes about nonexistent glibc wrappers

To easily distinguish documentation about glibc wrappers from
documentation about kernel syscalls, let's have a normalized
'Note' in the SYNOPSIS, and a further explanation in the page body
(NOTES in most of them), as already happened in many (but not all)
of the manual pages for syscalls without a wrapper.  Furthermore,
let's normalize the messages, following membarrier.2 (because it's
already quite extended), so that it's easy to use grep to find
those pages.

To find these pages, we used:
$ grep -rn wrapper man? | sort -V
and
$ grep -rni support.*glibc | sort -V

delete_module.2, init_module.2:  glibc 2.23 is no longer
  maintained, so we changed the notes about wrappers, to say that
  there are no glibc wrappers for these system calls; see NOTES.

We didn't fix some obsolete pages such as create_module.2.

Signed-off-by: Ganimedes Colomar <gacoan.linux@gmail.com>
Cowritten-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosyscalls.2: Add epoll_pwait2()
Michael Kerrisk [Wed, 30 Dec 2020 14:18:54 +0000 (15:18 +0100)] 
syscalls.2: Add epoll_pwait2()

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoreadlink.2: Emphasize that the returned buffer is not null-terminated
Michael Kerrisk [Wed, 30 Dec 2020 13:55:38 +0000 (14:55 +0100)] 
readlink.2: Emphasize that the returned buffer is not null-terminated

Reported-by: Jonny Grant <jg@jguk.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agofilesystems.5: tfix
Jakub Wilk [Tue, 29 Dec 2020 20:37:48 +0000 (21:37 +0100)] 
filesystems.5: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoftime.3: tfix
Jakub Wilk [Tue, 29 Dec 2020 20:37:47 +0000 (21:37 +0100)] 
ftime.3: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agocgroups.7: tfix
Jakub Wilk [Tue, 29 Dec 2020 20:37:46 +0000 (21:37 +0100)] 
cgroups.7: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosignal.7: tfix
Jakub Wilk [Tue, 29 Dec 2020 20:37:45 +0000 (21:37 +0100)] 
signal.7: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopkeys.7: srcfix: remove redundant .PP
Michael Kerrisk [Sun, 27 Dec 2020 10:44:02 +0000 (11:44 +0100)] 
pkeys.7: srcfix: remove redundant .PP

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agouser_namespaces.7: srcfix: remove redundant .PP after .SS
Michael Kerrisk [Sun, 27 Dec 2020 09:59:08 +0000 (10:59 +0100)] 
user_namespaces.7: srcfix: remove redundant .PP after .SS

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agouserfaultfd.2, posix_spawn.3: srcfix: remove redundant .PP
Michael Kerrisk [Sun, 27 Dec 2020 10:12:56 +0000 (11:12 +0100)] 
userfaultfd.2, posix_spawn.3: srcfix: remove redundant .PP

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_mutexattr_setrobust.3: wfix: remove redundant comments
Michael Kerrisk [Sun, 27 Dec 2020 10:34:42 +0000 (11:34 +0100)] 
pthread_mutexattr_setrobust.3: wfix: remove redundant comments

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agobind.2: wfix: remove redundant comment
Michael Kerrisk [Sun, 27 Dec 2020 10:01:22 +0000 (11:01 +0100)] 
bind.2: wfix: remove redundant comment

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agospu_run.2: Minor fix-ups for comments
Michael Kerrisk [Sun, 27 Dec 2020 10:25:27 +0000 (11:25 +0100)] 
spu_run.2: Minor fix-ups for comments

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agofanotify.7, inotify.7: wfix: Tweak location of tag comments
Michael Kerrisk [Sun, 27 Dec 2020 10:15:08 +0000 (11:15 +0100)] 
fanotify.7, inotify.7: wfix: Tweak location of tag comments

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoioctl_ns.2, keyctl.2, memfd_create.2, pidfd_send_signal.2, poll.2, seccomp.2, signalf...
Michael Kerrisk [Sun, 27 Dec 2020 10:42:50 +0000 (11:42 +0100)] 
ioctl_ns.2, keyctl.2, memfd_create.2, pidfd_send_signal.2, poll.2, seccomp.2, signalfd.2, timerfd_create.2, unshare.2, dlinfo.3, duplocale.3, fopencookie.3, getgrouplist.3, getifaddrs.3, getprotoent_r.3, getservent_r.3, insque.3, printf.3, pthread_attr_init.3, pthread_cancel.3, pthread_create.3, pthread_mutexattr_setrobust.3, pthread_setaffinity_np.3, qsort.3, sem_wait.3, core.5, elf.5, aio.7, epoll.7, pkeys.7, system_data_types.7, unix.7: Use periods more consistently inside code comments

In general, complete sentences in free-standing comments
should be terminated by periods.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agobind.2, clone.2, dup.2, futex.2, mprotect.2, open_by_handle_at.2, pivot_root.2, selec...
Michael Kerrisk [Sun, 27 Dec 2020 09:56:48 +0000 (10:56 +0100)] 
bind.2, clone.2, dup.2, futex.2, mprotect.2, open_by_handle_at.2, pivot_root.2, select_tut.2, shmop.2, timer_create.2, userfaultfd.2, getaddrinfo.3, getaddrinfo_a.3, inet_net_pton.3, malloc_info.3, mbstowcs.3, newlocale.3, posix_spawn.3, pthread_sigmask.3, shm_open.3, strtol.3, inotify.7, user_namespaces.7: Add periods at end of sentences in comments

Try to bring a little more consistency on the use of periods
in comments in example code.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoman-pages.7: Add some notes on comments in example code
Michael Kerrisk [Sun, 27 Dec 2020 10:50:11 +0000 (11:50 +0100)] 
man-pages.7: Add some notes on comments in example code

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoslist.3: tfix
Michael Kerrisk [Wed, 23 Dec 2020 13:24:43 +0000 (14:24 +0100)] 
slist.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agostailq.3: ffix
Michael Kerrisk [Wed, 23 Dec 2020 13:23:39 +0000 (14:23 +0100)] 
stailq.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agolist.3, slist.3, stailq.3, tailq.3: tfix
Michael Kerrisk [Wed, 23 Dec 2020 13:20:50 +0000 (14:20 +0100)] 
list.3, slist.3, stailq.3, tailq.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoseccomp.2, circleq.3, list.3, malloc_hook.3, slist.3, stailq.3, tailq.3, ip.7, unix...
Michael Kerrisk [Wed, 23 Dec 2020 13:17:30 +0000 (14:17 +0100)] 
seccomp.2, circleq.3, list.3, malloc_hook.3, slist.3, stailq.3, tailq.3, ip.7, unix.7: tfix

Remove "." at the end of sentence fragments/short single sentences
in comments.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosystem_data_types.7: tfix
Michael Kerrisk [Wed, 23 Dec 2020 13:10:05 +0000 (14:10 +0100)] 
system_data_types.7: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoVarious pages: Remove explicit blank lines, replacing them with .PP when appropriate
Alejandro Colomar [Tue, 22 Dec 2020 19:17:46 +0000 (20:17 +0100)] 
Various pages: Remove explicit blank lines, replacing them with .PP when appropriate

Rationale:
$ man 7 man-pages 2>/dev/null | sed -n /Paragraphs/,/^$/p
       Paragraphs should be separated by suitable markers (usually
       either .PP or .IP).  Do not separate paragraphs using blank
       lines,  as  this  results  in poor rendering in some output
       formats (such as PostScript and PDF).

Fix:
$ sed -i -e '1,/^\.EX/s/^$/.PP/' -e '/^\.EE/,/^\.EX/s/^$/.PP/' man?/*

And then some manual adjustments.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosyscall.2: Update superh syscall convention
Peter H. Froehlich [Tue, 22 Dec 2020 12:20:53 +0000 (13:20 +0100)] 
syscall.2: Update superh syscall convention

I noticed this while working on some silly "hello, world"
programs, see https://git.sr.ht/~phf/hello-again if you're
curious.  Disassembling sh4 code showed trap #31 all over the
place but the syscall(2) man page talked about trap #0x17 and
friends. Checking the kernel sources I got lucky in
arch/sh/kernel/entry-common.S where in commit 3623d138213ae Rich
Felker clarifies the situation.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agomallinfo2.3: New link to mallinfo(3)
Michael Kerrisk [Sat, 17 Oct 2020 17:08:42 +0000 (19:08 +0200)] 
mallinfo2.3: New link to mallinfo(3)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agomallinfo.3: Update example program to use mallinfo2()
Michael Kerrisk [Sat, 17 Oct 2020 17:04:58 +0000 (19:04 +0200)] 
mallinfo.3: Update example program to use mallinfo2()

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agomallinfo.3: Document mallinfo2() and note that mallinfo() is deprecated
Michael Kerrisk [Sat, 17 Oct 2020 17:02:44 +0000 (19:02 +0200)] 
mallinfo.3: Document mallinfo2() and note that mallinfo() is deprecated

Document the mallinfo2() function added in glibc 2.33.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agold.so.8: srcfix
Michael Kerrisk [Sun, 1 Nov 2020 13:52:35 +0000 (14:52 +0100)] 
ld.so.8: srcfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agold.so.8: Document the --argv0 option added in glibc 2.33
Michael Kerrisk [Sun, 1 Nov 2020 13:50:03 +0000 (14:50 +0100)] 
ld.so.8: Document the --argv0 option added in glibc 2.33

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoftime.3: glibc 2.33 has removed ftime()
Michael Kerrisk [Sat, 24 Oct 2020 17:24:01 +0000 (19:24 +0200)] 
ftime.3: glibc 2.33 has removed ftime()

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agogetrusage.2: Starting in 2.33, glibc no longer provides vtimes()
Michael Kerrisk [Sat, 24 Oct 2020 17:16:17 +0000 (19:16 +0200)] 
getrusage.2: Starting in 2.33, glibc no longer provides vtimes()

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_attr_setsigmask_np.3: tfix
Michael Kerrisk [Mon, 21 Dec 2020 20:27:13 +0000 (21:27 +0100)] 
pthread_attr_setsigmask_np.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agonl_langinfo.3: tfix
Michael Kerrisk [Mon, 21 Dec 2020 20:25:05 +0000 (21:25 +0100)] 
nl_langinfo.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoisfdtype.3: tfix
Michael Kerrisk [Mon, 21 Dec 2020 20:23:10 +0000 (21:23 +0100)] 
isfdtype.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoaio_suspend.3: tfix
Michael Kerrisk [Mon, 21 Dec 2020 20:16:28 +0000 (21:16 +0100)] 
aio_suspend.3: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agosetns.2: tfix
Michael Kerrisk [Mon, 21 Dec 2020 20:14:52 +0000 (21:14 +0100)] 
setns.2: tfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoperf_event_open.2: wfix
Michael Kerrisk [Mon, 21 Dec 2020 20:13:31 +0000 (21:13 +0100)] 
perf_event_open.2: wfix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agostatfs.2: tfix (Section number)
Michael Kerrisk [Mon, 21 Dec 2020 20:03:56 +0000 (21:03 +0100)] 
statfs.2: tfix (Section number)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoChanges.old: Minor fixes to 5.10 changelog
Michael Kerrisk [Tue, 22 Dec 2020 10:05:58 +0000 (11:05 +0100)] 
Changes.old: Minor fixes to 5.10 changelog

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoStart of man-pages-5.11: updating Changes and Changes.old
Michael Kerrisk [Tue, 22 Dec 2020 08:30:12 +0000 (09:30 +0100)] 
Start of man-pages-5.11: updating Changes and Changes.old

4 years agoStart of man-pages-5.11: updating .Announce and .lsm files
Michael Kerrisk [Tue, 22 Dec 2020 08:30:12 +0000 (09:30 +0100)] 
Start of man-pages-5.11: updating .Announce and .lsm files

4 years agoStart of man-pages-5.11: renaming .Announce and .lsm files
Michael Kerrisk [Tue, 22 Dec 2020 08:30:12 +0000 (09:30 +0100)] 
Start of man-pages-5.11: renaming .Announce and .lsm files

4 years agoReady for 5.10 man-pages-5.10
Michael Kerrisk [Mon, 21 Dec 2020 15:20:35 +0000 (16:20 +0100)] 
Ready for 5.10

4 years agogetent.1, access.2, cacheflush.2, chroot.2, clock_getres.2, fcntl.2, getrusage.2...
Michael Kerrisk [Mon, 21 Dec 2020 15:19:35 +0000 (16:19 +0100)] 
getent.1, access.2, cacheflush.2, chroot.2, clock_getres.2, fcntl.2, getrusage.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, link.2, llseek.2, mmap.2, mount.2, readv.2, restart_syscall.2, semctl.2, set_mempolicy.2, set_tid_address.2, shmctl.2, sigaction.2, sigaltstack.2, spu_create.2, statfs.2, subpage_prot.2, syscalls.2, timer_getoverrun.2, uselib.2, INFINITY.3, __ppc_set_ppr_med.3, bstring.3, btree.3, ctime.3, fgetc.3, fopen.3, getcontext.3, gethostbyname.3, getnetent.3, getprotoent.3, getservent.3, inet.3, j0.3, list.3, makecontext.3, nextafter.3, posix_memalign.3, profil.3, pthread_tryjoin_np.3, puts.3, rcmd.3, resolver.3, rtime.3, sigsetops.3, strnlen.3, tailq.3, elf.5, filesystems.5, nscd.conf.5, proc.5, utmp.5, attributes.7, ipv6.7, packet.7, pthreads.7, signal-safety.7, signal.7, spufs.7, system_data_types.7, tcp.7: tstamp

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoChanges: Ready for 5.10
Michael Kerrisk [Mon, 21 Dec 2020 15:13:16 +0000 (16:13 +0100)] 
Changes: Ready for 5.10

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agorcmd.3: SEE ALSO: remove intro(2)
Michael Kerrisk [Mon, 21 Dec 2020 09:36:39 +0000 (10:36 +0100)] 
rcmd.3: SEE ALSO: remove intro(2)

There's no reason to link to intro(2)...

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agocacheflush.2: ffix
Michael Kerrisk [Sun, 20 Dec 2020 20:52:42 +0000 (21:52 +0100)] 
cacheflush.2: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agocacheflush.2: Document Architecture-specific variants
Alejandro Colomar [Mon, 14 Dec 2020 14:38:53 +0000 (15:38 +0100)] 
cacheflush.2: Document Architecture-specific variants

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agocacheflush.2: Document __builtin___clear_cache() as a more portable alternative
Alejandro Colomar [Tue, 15 Dec 2020 13:30:20 +0000 (14:30 +0100)] 
cacheflush.2: Document __builtin___clear_cache() as a more portable alternative

Reported-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Martin Sebor <msebor@redhat.com>
Cc: Dave Martin <Dave.Martin@arm.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopacket.7: Update references to kernel documentation
Baruch Siach [Tue, 15 Dec 2020 18:17:34 +0000 (19:17 +0100)] 
packet.7: Update references to kernel documentation

Files moved from .txt to .rst.

Also, drop / prefix from kernel source tree references.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agofilesystems.5: wfix: ntfs: remove FAT comparison
наб [Fri, 18 Dec 2020 15:30:37 +0000 (16:30 +0100)] 
filesystems.5: wfix: ntfs: remove FAT comparison

The main point I was driving at with this patch was to fix
"Microsoft Window's FAT filesystems" (i.e., FAT filesystems which
belong to Microsoft Windows, which is decidedly wrong).

FAT32 first shipped with MS-DOS 7.1, as part of Windows 95 OSR2,
but it's a (relatively) simple logical extension of the previous
FATx filesystems (16 and 12 as we know and love them today, I
don't think the PC ever saw 8), hence the "VFAT" driver name ‒
calling FAT-anything a Windows filesystem would be a flat-out lie,
calling it a Microsoft filesystem would be, uh, facetious.

NTFS (as part of Windows NT), on the other hand, is wholly
different WRT the scope and feature-set (it does borrow some
layouting from FAT, but reading NTFS as FAT doesn't get you very
far, or much).

The replacing bit is also questionable, especially in a.d. 2020:
while it is true that you cannot install NT on FAT (after a
certain point? my memory ain't what it used to be), and must
therefore replace your existing FAT partitions with NTFS during
upgrades; Windows NT 4.0, the last product to be NT-branded came
out in 1996, i.e. you could not install Windows on FAT (and,
therefore, upgrade it to NTFS, replacing it) during my entire
lifetime.

Indeed, in $(date +%Y) we live in a post-NTFS world ‒ putting NTFS
in the same class as FAT beyond "is a filesystem" is a joke.

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agofilesystems.5: Note ncpfs removal from kernel
Ahelenia Ziemiańska [Fri, 18 Dec 2020 15:30:36 +0000 (16:30 +0100)] 
filesystems.5: Note ncpfs removal from kernel

Relevant Linux commits:
 * moved to staging in 1bb8155080c652c4853e6228f8f0d262b3049699
   (describe: v4.15-rc1-129-g1bb8155080c6) in Nov 2017,
   described as "broken" and "obsolete"
 * purged in bd32895c750bcd2b511bf93917bf7ae723e3d0b6
   (describe: v4.17-rc3-1010-gbd32895c750b) in Jun 2018,
   "since no one has complained or even noticed it was gone"

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agofilesystems.5: Fix link to user space tooling for ncpfs
Ahelenia Ziemiańska [Fri, 18 Dec 2020 15:30:35 +0000 (16:30 +0100)] 
filesystems.5: Fix link to user space tooling for ncpfs

Corresponds to Linux commit 1b83df308f69a5a3cc59be03bd7fb23e4bcebd8e

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthreads.7: ffix
Michael Kerrisk [Sun, 20 Dec 2020 11:08:09 +0000 (12:08 +0100)] 
pthreads.7: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthreads.7: Rephrase function list in terms of POSIX rather than SUS
Michael Kerrisk [Sun, 20 Dec 2020 11:05:19 +0000 (12:05 +0100)] 
pthreads.7: Rephrase function list in terms of POSIX rather than SUS

The list was using an inconsistent mixture of "POSIX" and "SUS".

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agoregex.3: ffix
Michael Kerrisk [Sun, 20 Dec 2020 11:01:36 +0000 (12:01 +0100)] 
regex.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_attr_setguardsize.3: ffix
Michael Kerrisk [Sun, 20 Dec 2020 11:00:42 +0000 (12:00 +0100)] 
pthread_attr_setguardsize.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_attr_setstacksize.3: ffix
Michael Kerrisk [Sun, 20 Dec 2020 11:00:12 +0000 (12:00 +0100)] 
pthread_attr_setstacksize.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_mutexattr_setrobust.3: ffix
Michael Kerrisk [Sun, 20 Dec 2020 10:58:53 +0000 (11:58 +0100)] 
pthread_mutexattr_setrobust.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
4 years agopthread_attr_setstackaddr.3: ffix
Michael Kerrisk [Sun, 20 Dec 2020 10:56:47 +0000 (11:56 +0100)] 
pthread_attr_setstackaddr.3: ffix

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>