signalfd.2: tfix

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

Changes.old

@@ -53581,7 +53581,7 @@ Various pages
             Generally, place '||' at start of a line, rather than the end of
             the previous line.
 
-            Rationale: this placement clearly indicates that that each piece
+            Rationale: this placement clearly indicates that each piece
             is an alternative.
 
 Various pages
@@ -54119,7 +54119,7 @@ system.3
 environ.7
     Bastien Roucariès
         Reorder the text
-            Move the the text describing how to set environment variable before
+            Move the text describing how to set environment variable before
             the list(s) of variables in order to improve readability.
     Bastien Roucariès
         Document convention of string in environ
@@ -54152,7 +54152,7 @@ man-pages.7
     Michael Kerrisk
         Add a FORMATTING AND WORDING CONVENTIONS section
             In man-pages-5.11, a large number of pages were edited to achieve
-            greater consistency in the SYNOPIS, RETURN VALUE and ATTRIBUTES
+            greater consistency in the SYNOPSIS, RETURN VALUE and ATTRIBUTES
             sections. To avoid future inconsistencies, try to capture some of
             the preferred conventions in text in man-pages(7).
     Michael Kerrisk

man2/clone.2

@@ -1418,7 +1418,7 @@ was an invalid.
 .TP
 .BR EINVAL " (AArch64 only, Linux 4.6 and earlier)"
 .I stack
-was not aligned to a 126-bit boundary.
+was not aligned to a 128-bit boundary.
 .TP
 .B ENOMEM
 Cannot allocate sufficient memory to allocate a task structure for the

man2/execve.2

@@ -141,7 +141,7 @@ similarly, the effective group ID is copied to the saved set-group-ID.
 This copying takes place after any effective ID changes that occur
 because of the set-user-ID and set-group-ID mode bits.
 .PP
-The process's real UID and real GID, as well its supplementary group IDs,
+The process's real UID and real GID, as well as its supplementary group IDs,
 are unchanged by a call to
 .BR execve ().
 .PP

man2/execveat.2

@@ -32,11 +32,10 @@ execveat \- execute program relative to a directory file descriptor
 .BR "#include <sys/syscall.h>" "      /* Definition of " SYS_* " constants */"
 .B #include <unistd.h>
 .PP
-.BI "int syscall(SYS_execveat, int " dirfd ", const char *" pathname ,
-.BI "            const char *const " argv "[], const char *const " envp [],
-.BI "            int " flags );
+.BI "int execveat(int " dirfd ", const char *" pathname ,
+.BI "             const char *const " argv "[], const char *const " envp [],
+.BI "             int " flags );
 .fi
-.\" FIXME . See https://sourceware.org/bugzilla/show_bug.cgi?id=27364
 .SH DESCRIPTION
 .\" commit 51f39a1f0cea1cacf8c787f652f26dfee9611874
 The
@@ -163,6 +162,7 @@ is a file descriptor referring to a file other than a directory.
 .SH VERSIONS
 .BR execveat ()
 was added to Linux in kernel 3.19.
+Library support was added to glibc in version 2.34.
 .SH CONFORMING TO
 The
 .BR execveat ()

man2/exit_group.2

@@ -28,7 +28,7 @@ exit_group \- exit all threads in a process
 .SH SYNOPSIS
 .nf
 .BR "#include <sys/syscall.h>" "       /* Definition of " SYS_* " constants */"
-.B #inlcude <unistd.h>
+.B #include <unistd.h>
 .PP
 .BI "noreturn void syscall(SYS_exit_group, int " status );
 .fi

man2/flock.2

@@ -239,6 +239,31 @@ see the discussion of the
 .I "local_lock"
 option in
 .BR nfs (5).
+.SS CIFS details
+In Linux kernels up to 5.4,
+.BR flock ()
+is not propagated over SMB.
+A file with such locks will not appear locked for remote clients.
+.PP
+Since Linux 5.5,
+.BR flock ()
+locks are emulated with SMB byte-range locks on the entire file.
+Similarly to NFS, this means that
+.BR fcntl (2)
+and
+.BR flock ()
+locks interact with one another.
+Another important side-effect is that the locks are not advisory anymore:
+any IO on a locked file will always fail with
+.BR EACCES
+when done from a separate file descriptor.
+This difference originates from the design of locks in the SMB protocol,
+which provides mandatory locking semantics.
+.PP
+Remote and mandatory locking semantics may vary with SMB protocol, mount options and server type.
+See
+.BR mount.cifs (8)
+for additional information.
 .SH SEE ALSO
 .BR flock (1),
 .BR close (2),

man2/getunwind.2

@@ -31,7 +31,7 @@ getunwind \- copy the unwind data to caller's buffer
 .nf
 .B #include <linux/unwind.h>
 .BR "#include <sys/syscall.h>" "      /* Definition of " SYS_* " constants */"
-.B #inlcude <unistd.h>
+.B #include <unistd.h>
 .PP
 .BI "long syscall(SYS_getunwind, void " *buf ", size_t " buf_size );
 .fi

man2/move_pages.2

@@ -24,7 +24,7 @@ move_pages \- move individual pages of a process to another node
 .nf
 .B #include <numaif.h>
 .PP
-.BI "long move_pages(int " pid ", unsigned long count, void **" pages ,
+.BI "long move_pages(int " pid ", unsigned long " count ", void **" pages ,
 .BI "                const int *" nodes ", int *" status ", int " flags );
 .fi
 .PP
@@ -180,6 +180,7 @@ The number of nonmigrated pages if they were the result of nonfatal
 reasons (since
 .\" commit a49bd4d7163707de377aee062f17befef6da891b
 Linux 4.17).
+.TP
 .B E2BIG
 Too many pages to move.
 Since Linux 2.6.29,

man2/msgctl.2

@@ -40,7 +40,6 @@
 msgctl \- System V message control operations
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/msg.h>
 .PP
 .BI "int msgctl(int " msqid ", int " cmd ", struct msqid_ds *" buf );
@@ -405,17 +404,6 @@ capability).
 POSIX.1-2001, POSIX.1-2008, SVr4.
 .\" SVID does not document the EIDRM error condition.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 The
 .BR IPC_INFO ,
 .BR MSG_STAT ,

man2/msgget.2

@@ -37,7 +37,6 @@
 msgget \- get a System V message queue identifier
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/msg.h>
 .PP
 .BI "int msgget(key_t " key ", int " msgflg );
@@ -188,17 +187,6 @@ would be exceeded.
 .SH CONFORMING TO
 POSIX.1-2001, POSIX.1-2008, SVr4.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 .B IPC_PRIVATE
 isn't a flag field but a
 .I key_t

man2/msgop.2

@@ -42,7 +42,6 @@
 msgrcv, msgsnd \- System V message queue operations
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/msg.h>
 .PP
 .BI "int msgsnd(int " msqid ", const void *" msgp ", size_t " msgsz \
@@ -480,17 +479,6 @@ their definitions can be obtained by defining the
 .\" MSG_COPY since glibc 2.18
 feature test macro.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 The
 .I msgp
 argument is declared as \fIstruct msgbuf\ *\fP in

man2/open_by_handle_at.2

@@ -29,7 +29,6 @@ for a pathname and open file via a handle
 .SH SYNOPSIS
 .nf
 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
-.B #include <sys/stat.h>
 .B #include <fcntl.h>
 .PP
 .BI "int name_to_handle_at(int " dirfd ", const char *" pathname ,

man2/perfmonctl.2

@@ -196,12 +196,18 @@ On error, \-1 is returned and
 is set to indicate the error.
 .SH VERSIONS
 .BR perfmonctl ()
-is available since Linux 2.4.
+was added in Linux 2.4;
+.\" commit ecf5b72d5f66af843f189dfe9ce31598c3e48ad7
+it was removed in Linux 5.10.
 .SH CONFORMING TO
 .BR perfmonctl ()
 is Linux-specific and is available only on the IA-64 architecture.
 .SH NOTES
-Glibc does not provide a wrapper for this system call; call it using
+This system call was broken for many years,
+and ultimately removed in Linux 5.10.
+.PP
+Glibc does not provide a wrapper for this system call;
+on kernels where it exists, call it using
 .BR syscall (2).
 .SH SEE ALSO
 .BR gprof (1)

man2/ptrace.2

@@ -2327,8 +2327,11 @@ On success, the
 requests return the requested data (but see NOTES),
 the
 .B PTRACE_SECCOMP_GET_FILTER
-request returns the number of instructions in the BPF program, and
-other requests return zero.
+request returns the number of instructions in the BPF program,
+the
+.B PTRACE_GET_SYSCALL_INFO
+request returns the number of bytes available to be written by the kernel,
+and other requests return zero.
 .PP
 On error, all requests return \-1, and
 .I errno

man2/semctl.2

@@ -44,7 +44,6 @@
 semctl \- System V semaphore control operations
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/sem.h>
 .PP
 .BI "int semctl(int " semid ", int " semnum ", int " cmd ", ...);"
@@ -378,7 +377,7 @@ the semaphore set.
 .TP
 .B SETVAL
 Set the semaphore value
-.BR ( semval )
+.RB ( semval )
 to
 .I arg.val
 for the
@@ -536,17 +535,6 @@ It was also so defined on Linux 2.2 and earlier,
 but, since Linux 2.4, the field has the type
 .IR "unsigned\ long" .
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of these header files.
-.PP
 The
 .BR IPC_INFO ,
 .BR SEM_STAT ,

man2/semget.2

@@ -39,7 +39,6 @@
 semget \- get a System V semaphore set identifier
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/sem.h>
 .fi
 .PP
@@ -219,17 +218,6 @@ SVr4, POSIX.1-2001.
 .\" SVr4 documents additional error conditions EFBIG, E2BIG, EAGAIN,
 .\" ERANGE, EFAULT.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 .B IPC_PRIVATE
 isn't a flag field but a
 .I key_t

man2/semop.2

@@ -37,7 +37,6 @@
 semop, semtimedop \- System V semaphore operations
 .SH SYNOPSIS
 .nf
-.B #include <sys/ipc.h>
 .B #include <sys/sem.h>
 .PP
 .BI "int semop(int " semid ", struct sembuf *" sops ", size_t " nsops );
@@ -383,17 +382,6 @@ first appeared in version 2.3.3.
 POSIX.1-2001, POSIX.1-2008, SVr4.
 .\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 The
 .I sem_undo
 structures of a process aren't inherited by the child produced by

man2/shmctl.2

@@ -49,7 +49,6 @@ shmctl \- System V shared memory control
 .SH SYNOPSIS
 .nf
 .ad l
-.B #include <sys/ipc.h>
 .B #include <sys/shm.h>
 .PP
 .BI "int shmctl(int " shmid ", int " cmd ", struct shmid_ds *" buf );
@@ -466,17 +465,6 @@ POSIX.1-2001, POSIX.1-2008, SVr4.
 .\" ENOENT, ENOSPC, ENOMEM, EEXIST.  Neither SVr4 nor SVID documents
 .\" an EIDRM error condition.
 .SH NOTES
-The inclusion of
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of this header file,
-and the SVID also documented its inclusion.
-Applications intended to be portable to such old systems may need
-to include this header file.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of this header file.
-.PP
 The
 .BR IPC_INFO ,
 .BR SHM_STAT ,

man2/shmget.2

@@ -41,7 +41,6 @@ shmget \- allocates a System V shared memory segment
 .SH SYNOPSIS
 .nf
 .ad l
-.B #include <sys/ipc.h>
 .B #include <sys/shm.h>
 .PP
 .BI "int shmget(key_t " key ", size_t " size ", int " shmflg );
@@ -284,19 +283,6 @@ and
 .B SHM_NORESERVE
 are Linux extensions.
 .SH NOTES
-The inclusion of
-.I <sys/types.h>
-and
-.I <sys/ipc.h>
-isn't required on Linux or by any version of POSIX.
-However,
-some old implementations required the inclusion of these header files,
-and the SVID also documented their inclusion.
-Applications intended to be portable to such old systems may need
-to include these header files.
-.\" Like Linux, the FreeBSD man pages still document
-.\" the inclusion of these header files.
-.PP
 .B IPC_PRIVATE
 isn't a flag field but a
 .I key_t

man2/shmop.2

@@ -387,8 +387,8 @@ main(int argc, char *argv[])
         errExit("shmget");
 
     semid = semget(IPC_PRIVATE, 1, IPC_CREAT | 0600);
-    if (shmid == \-1)
-        errExit("shmget");
+    if (semid == \-1)
+        errExit("semget");
 
     /* Attach shared memory into our address space. */
 

man2/sigaltstack.2

@@ -111,7 +111,7 @@ Clear the alternate signal stack settings on entry to the signal handler.
 When the signal handler returns,
 the previous alternate signal stack settings are restored.
 .IP
-This flag was added in order make it safe
+This flag was added in order to make it safe
 to switch away from the signal handler with
 .BR swapcontext (3).
 Without this flag, a subsequently handled signal will corrupt

man2/signalfd.2

@@ -196,7 +196,7 @@ struct signalfd_siginfo {
     uint64_t ssi_addr;     /* Address that generated signal
                               (for hardware\-generated signals) */
     uint16_t ssi_addr_lsb; /* Least significant bit of address
-                              (SIGBUS; since Linux 2.6.37)
+                              (SIGBUS; since Linux 2.6.37) */
 .\" ssi_addr_lsb: commit b8aeec34175fc8fe8b0d40efea4846dfc1ba663e
     uint8_t  pad[\fIX\fP];       /* Pad size to 128 bytes (allow for
                               additional fields in the future) */

man2/sigwaitinfo.2

@@ -120,7 +120,7 @@ set to indicate the error.
 .B EAGAIN
 No signal in
 .I set
-was became pending within the
+became pending within the
 .I timeout
 period specified to
 .BR sigtimedwait ().

man2/syscalls.2

@@ -528,7 +528,7 @@ T}
 SPARC only; removed in 2.6.34
 T}
 .\"	commit c7d5a0050773e98d1094eaa9f2a1a793fafac300 removed perfctr()
-\fBperfmonctl\fP(2)	2.4	IA-64 only
+\fBperfmonctl\fP(2)	2.4	IA-64 only; removed in 5.10
 \fBpidfd_getfd\fP(2)	5.6
 \fBpidfd_send_signal\fP(2)	5.1
 \fBpidfd_open\fP(2)	5.3
@@ -1175,6 +1175,7 @@ returns a pair of GID and effective GID via registers
 is used for configuring the Host Address Extension register on
 low-cost Alphas in order to access address space beyond first 27 bits.
 .SH SEE ALSO
+.BR ausyscall (1)
 .BR intro (2),
 .BR syscall (2),
 .BR unimplemented (2),

man3/ftok.3

@@ -31,7 +31,6 @@
 ftok \- convert a pathname and a project identifier to a System V IPC key
 .SH SYNOPSIS
 .nf
-.B #include <sys/types.h>
 .B #include <sys/ipc.h>
 .fi
 .PP

man3/getopt.3

@@ -126,6 +126,11 @@ Then \fIoptind\fP is the index in \fIargv\fP of the first
 .PP
 .I optstring
 is a string containing the legitimate option characters.
+A legitimate option character is any visible one byte
+.BR ascii (7)
+character (for which
+.BR isgraph (3)
+would return nonzero) that is not \(aq\-\(aq or \(aq:\(aq.
 If such a
 character is followed by a colon, the option requires an argument, so
 .BR getopt ()
@@ -402,6 +407,24 @@ routine that rechecks
 .B POSIXLY_CORRECT
 and checks for GNU extensions in
 .IR optstring .)
+.PP
+Command-line arguments are parsed in strict order
+meaning that an option requiring an argument will consume the next argument,
+regardless of whether that argument is the correctly specified option argument
+or simply the next option
+(in the scenario the user mis-specifies the command line).
+For example, if
+.I optstring
+is specified as "1n:"
+and the user specifies the command line arguments incorrectly as
+.IR "prog\ \-n\ \-1" ,
+the
+.I \-n
+option will be given the
+.B optarg
+value "\-1", and the
+.I \-1
+option will be considered to have not been specified.
 .SH EXAMPLES
 .SS getopt()
 The following trivial example program uses

man3/pthread_mutex_consistent.3

@@ -85,11 +85,12 @@ glibc defined the following equivalent nonstandard function if
 was defined:
 .PP
 .nf
-.BI "int pthread_mutex_consistent(const pthread_mutex_t *" mutex );
+.BI "int pthread_mutex_consistent_np(const pthread_mutex_t *" mutex );
 .fi
 .PP
 This GNU-specific API, which first appeared in glibc 2.4,
-is nowadays obsolete and should not be used in new programs.
+is nowadays obsolete and should not be used in new programs;
+since glibc 2.34 it has been marked as deprecated.
 .SH EXAMPLES
 See
 .BR pthread_mutexattr_setrobust (3).

man3/pthread_mutexattr_setrobust.3

@@ -181,7 +181,8 @@ and
 were also defined.
 .PP
 These GNU-specific APIs, which first appeared in glibc 2.4,
-are nowadays obsolete and should not be used in new programs.
+are nowadays obsolete and should not be used in new programs;
+since glibc 2.34 these APIs are marked as deprecated.
 .SH EXAMPLES
 The program below demonstrates the use of the robustness attribute of a
 mutex attributes object.

man3/pthread_yield.3

@@ -35,6 +35,9 @@ pthread_yield \- yield the processor
 .PP
 Compile and link with \fI\-pthread\fP.
 .SH DESCRIPTION
+.BR Note :
+This function is deprecated; see below.
+.PP
 .BR pthread_yield ()
 causes the calling thread to relinquish the CPU.
 The thread is placed at the end of the run queue for its static
@@ -50,6 +53,8 @@ on error, it returns an error number.
 On Linux, this call always succeeds
 (but portable and future-proof applications should nevertheless
 handle a possible error return).
+.SH VERSIONS
+Since glibc 2.34, this function is marked as deprecated.
 .SH ATTRIBUTES
 For an explanation of the terms used in this section, see
 .BR attributes (7).

man3/setbuf.3

@@ -229,7 +229,7 @@ int
 main(void)
 {
     char buf[BUFSIZ];
-    setbuf(stdin, buf);
+    setbuf(stdout, buf);
     printf("Hello, world!\en");
     return 0;
 }

man7/fanotify.7

@@ -147,7 +147,7 @@ influences what data structures are returned to the event listener for each
 event.
 Events reported to a group initialized with one of these flags will
 use file handles to identify filesystem objects instead of file descriptors.
-.TP
+.PP
 After a successful
 .BR read (2),
 the read buffer contains one or more of the following structures:

man7/shm_overview.7

@@ -92,7 +92,7 @@ to link against the real-time library,
 .IR librt .
 .SS Accessing shared memory objects via the filesystem
 On Linux, shared memory objects are created in a
-.RI ( tmpfs (5))
+.RB ( tmpfs (5))
 virtual filesystem, normally mounted under
 .IR /dev/shm .
 Since kernel 2.6.19, Linux supports the use of access control lists (ACLs)