msgctl.2, msgget.2, msgop.2, semctl.2, semget.2, semop.2, shmctl.2, shmget.2: NOTES: <sys/types.h> and <sys/ipc.h> aren't strictly needed

Add text to NOTES to say that the <sys/types.h> and <sys/ipc.h>
header files aren't required by Linux or the standards, but may
be needed for portability to old systems.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2012-06-01 00:55:28 +12:00
parent 26a85bf20e
commit f66524636d
8 changed files with 112 additions and 8 deletions

View File

@ -32,7 +32,7 @@
.\" Added msqid_ds and ipc_perm structure definitions .\" Added msqid_ds and ipc_perm structure definitions
.\" 2005-08-02, mtk: Added IPC_INFO, MSG_INFO, MSG_STAT descriptions .\" 2005-08-02, mtk: Added IPC_INFO, MSG_INFO, MSG_STAT descriptions
.\" .\"
.TH MSGCTL 2 2008-08-06 "Linux" "Linux Programmer's Manual" .TH MSGCTL 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
msgctl \- message control operations msgctl \- message control operations
.SH SYNOPSIS .SH SYNOPSIS
@ -310,6 +310,19 @@ capability).
SVr4, POSIX.1-2001. SVr4, POSIX.1-2001.
.\" SVID does not document the EIDRM error condition. .\" SVID does not document the EIDRM error condition.
.SH NOTES .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.
The The
.BR IPC_INFO , .BR IPC_INFO ,
.B MSG_STAT .B MSG_STAT

View File

@ -30,7 +30,7 @@
.\" Language and formatting clean-ups .\" Language and formatting clean-ups
.\" Added notes on /proc files .\" Added notes on /proc files
.\" .\"
.TH MSGGET 2 2004-05-27 "Linux" "Linux Programmer's Manual" .TH MSGGET 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
msgget \- get a message queue identifier msgget \- get a message queue identifier
.SH SYNOPSIS .SH SYNOPSIS
@ -181,6 +181,19 @@ would be exceeded.
.SH "CONFORMING TO" .SH "CONFORMING TO"
SVr4, POSIX.1-2001. SVr4, POSIX.1-2001.
.SH NOTES .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.
.B IPC_PRIVATE .B IPC_PRIVATE
isn't a flag field but a isn't a flag field but a
.I key_t .I key_t

View File

@ -35,7 +35,7 @@
.\" Added notes on /proc files .\" Added notes on /proc files
.\" FIXME . Add example programs to this page. .\" FIXME . Add example programs to this page.
.\" .\"
.TH MSGOP 2 2008-04-23 "Linux" "Linux Programmer's Manual" .TH MSGOP 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
msgrcv, msgsnd \- message operations msgrcv, msgsnd \- message operations
.SH SYNOPSIS .SH SYNOPSIS
@ -397,6 +397,19 @@ and no message of the requested type existed on the message queue.
.SH "CONFORMING TO" .SH "CONFORMING TO"
SVr4, POSIX.1-2001. SVr4, POSIX.1-2001.
.SH NOTES .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.
The The
.I msgp .I msgp
argument is declared as \fIstruct msgbuf *\fP with argument is declared as \fIstruct msgbuf *\fP with

View File

@ -36,7 +36,7 @@
.\" Added semid_ds and ipc_perm structure definitions .\" Added semid_ds and ipc_perm structure definitions
.\" 2005-08-02, mtk: Added IPC_INFO, SEM_INFO, SEM_STAT descriptions. .\" 2005-08-02, mtk: Added IPC_INFO, SEM_INFO, SEM_STAT descriptions.
.\" .\"
.TH SEMCTL 2 2009-09-27 "Linux" "Linux Programmer's Manual" .TH SEMCTL 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
semctl \- semaphore control operations semctl \- semaphore control operations
.SH SYNOPSIS .SH SYNOPSIS
@ -461,6 +461,19 @@ or greater than the implementation limit
SVr4, POSIX.1-2001. SVr4, POSIX.1-2001.
.\" SVr4 documents more error conditions EINVAL and EOVERFLOW. .\" SVr4 documents more error conditions EINVAL and EOVERFLOW.
.SH NOTES .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.
The The
.BR IPC_INFO , .BR IPC_INFO ,
.B SEM_STAT .B SEM_STAT

View File

@ -31,7 +31,7 @@
.\" Rewrote BUGS note about semget()'s failure to initialize .\" Rewrote BUGS note about semget()'s failure to initialize
.\" semaphore values .\" semaphore values
.\" .\"
.TH SEMGET 2 2004-05-27 "Linux" "Linux Programmer's Manual" .TH SEMGET 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
semget \- get a semaphore set identifier semget \- get a semaphore set identifier
.SH SYNOPSIS .SH SYNOPSIS
@ -219,6 +219,19 @@ SVr4, POSIX.1-2001.
.\" SVr4 documents additional error conditions EFBIG, E2BIG, EAGAIN, .\" SVr4 documents additional error conditions EFBIG, E2BIG, EAGAIN,
.\" ERANGE, EFAULT. .\" ERANGE, EFAULT.
.SH NOTES .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.
.B IPC_PRIVATE .B IPC_PRIVATE
isn't a flag field but a isn't a flag field but a
.I key_t .I key_t

View File

@ -30,7 +30,7 @@
.\" 2005-04-08, mtk, Noted kernel version numbers for semtimedop() .\" 2005-04-08, mtk, Noted kernel version numbers for semtimedop()
.\" 2007-07-09, mtk, Added an EXAMPLE code segment. .\" 2007-07-09, mtk, Added an EXAMPLE code segment.
.\" .\"
.TH SEMOP 2 2012-05-10 "Linux" "Linux Programmer's Manual" .TH SEMOP 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
semop, semtimedop \- semaphore operations semop, semtimedop \- semaphore operations
.SH SYNOPSIS .SH SYNOPSIS
@ -401,6 +401,19 @@ first appeared in version 2.3.3.
SVr4, POSIX.1-2001. SVr4, POSIX.1-2001.
.\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC. .\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC.
.SH NOTES .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.
The The
.I sem_undo .I sem_undo
structures of a process aren't inherited by the child produced by structures of a process aren't inherited by the child produced by

View File

@ -40,7 +40,7 @@
.\" attaches to a segment that has already been marked for deletion. .\" attaches to a segment that has already been marked for deletion.
.\" 2005-08-02, mtk: Added IPC_INFO, SHM_INFO, SHM_STAT descriptions. .\" 2005-08-02, mtk: Added IPC_INFO, SHM_INFO, SHM_STAT descriptions.
.\" .\"
.TH SHMCTL 2 2008-08-07 "Linux" "Linux Programmer's Manual" .TH SHMCTL 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
shmctl \- shared memory control shmctl \- shared memory control
.SH SYNOPSIS .SH SYNOPSIS
@ -369,6 +369,19 @@ SVr4, POSIX.1-2001.
.\" ENOENT, ENOSPC, ENOMEM, EEXIST. Neither SVr4 nor SVID documents .\" ENOENT, ENOSPC, ENOMEM, EEXIST. Neither SVr4 nor SVID documents
.\" an EIDRM error condition. .\" an EIDRM error condition.
.SH NOTES .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.
The The
.BR IPC_INFO , .BR IPC_INFO ,
.B SHM_STAT .B SHM_STAT

View File

@ -33,7 +33,7 @@
.\" Language and formatting clean-ups .\" Language and formatting clean-ups
.\" Added notes on /proc files .\" Added notes on /proc files
.\" .\"
.TH SHMGET 2 2006-05-02 "Linux" "Linux Programmer's Manual" .TH SHMGET 2 2012-05-31 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
shmget \- allocates a shared memory segment shmget \- allocates a shared memory segment
.SH SYNOPSIS .SH SYNOPSIS
@ -233,6 +233,19 @@ SVr4, POSIX.1-2001.
.B SHM_HUGETLB .B SHM_HUGETLB
is a nonportable Linux extension. is a nonportable Linux extension.
.SH NOTES .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.
.B IPC_PRIVATE .B IPC_PRIVATE
isn't a flag field but a isn't a flag field but a
.I key_t .I key_t