xnu-3789.1.32.tar.gz

[apple/xnu.git] / bsd / man / man2 / shmat.2

diff --git a/bsd/man/man2/shmat.2 b/bsd/man/man2/shmat.2
index 7ed9d04490b76ee5b5c6750db1c0d5e8ce25bbbc..69cb5980fb48427084858ec277bb1337d7f0e2f2 100644 (file)
--- a/bsd/man/man2/shmat.2
+++ b/bsd/man/man2/shmat.2
@@ -38,13 +38,17 @@
 .Nm shmdt
 .Nd map/unmap shared memory
 .Sh SYNOPSIS
 .Nm shmdt
 .Nd map/unmap shared memory
 .Sh SYNOPSIS

-.Fd #include <sys/types.h>
-.Fd #include <sys/ipc.h>

 .Fd #include <sys/shm.h>
 .Ft void *
 .Fd #include <sys/shm.h>
 .Ft void *

-.Fn shmat "int shmid" "void *shmaddr" "int shmflg"
+.Fo shmat
+.Fa "int shmid"
+.Fa "const void *shmaddr"
+.Fa "int shmflg"
+.Fc

 .Ft int
 .Ft int

-.Fn shmdt "void *shmaddr"
+.Fo shmdt
+.Fa "const void *shmaddr"
+.Fc

 .Sh DESCRIPTION
 .Fn shmat
 maps the shared memory segment associated with the shared memory identifier
 .Sh DESCRIPTION
 .Fn shmat
 maps the shared memory segment associated with the shared memory identifier


@@ -62,11 +66,9 @@ the system will round the address down to a multiple of SHMLBA bytes
 (SHMLBA is defined in
 .Aq Pa sys/shm.h
 ).
 (SHMLBA is defined in
 .Aq Pa sys/shm.h
 ).

-

 A shared memory segment can be mapped read-only by specifying the
 SHM_RDONLY flag in
 .Fa shmflg .
 A shared memory segment can be mapped read-only by specifying the
 SHM_RDONLY flag in
 .Fa shmflg .

-

 .Fn shmdt
 unmaps the shared memory segment that is currently mapped at
 .Fa shmaddr
 .Fn shmdt
 unmaps the shared memory segment that is currently mapped at
 .Fa shmaddr


@@ -88,31 +90,48 @@ and the global variable
 .Va errno
 is set to indicate the error.
 .Sh ERRORS
 .Va errno
 is set to indicate the error.
 .Sh ERRORS

+The

 .Fn shmat
 .Fn shmat

-will fail if:
+system call will fail if:

 .Bl -tag -width Er
 .Bl -tag -width Er

-.It Bq Er EACCESS
+.\" ===========
+.It Bq Er EACCES

 The calling process has no permission to access this shared memory segment.
 The calling process has no permission to access this shared memory segment.

-.It Bq Er ENOMEM
-There is not enough available data space for the calling process to
-map the shared memory segment.
+.\" ===========

 .It Bq Er EINVAL
 .Fa shmid
 is not a valid shared memory identifier.
 .It Bq Er EINVAL
 .Fa shmid
 is not a valid shared memory identifier.

-

 .Fa shmaddr
 specifies an illegal address.
 .Fa shmaddr
 specifies an illegal address.

+.\" ===========

 .It Bq Er EMFILE
 The number of shared memory segments has reached the system-wide limit.
 .It Bq Er EMFILE
 The number of shared memory segments has reached the system-wide limit.

+.\" ===========
+.It Bq Er ENOMEM
+There is not enough available data space for the calling process to
+map the shared memory segment.
+.Pp

 .El
 .El

-
+The

 .Fn shmdt
 .Fn shmdt

-will fail if:
+system call will fail if:

 .Bl -tag -width Er
 .It Bq Er EINVAL
 .Fa shmaddr
 is not the start address of a mapped shared memory segment.
 .Bl -tag -width Er
 .It Bq Er EINVAL
 .Fa shmaddr
 is not the start address of a mapped shared memory segment.

+.El
+.Sh LEGACY SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/ipc.h>
+.Fd #include <sys/shm.h>
+.Pp
+The include files
+.In sys/types.h
+and
+.In sys/ipc.h
+are necessary for both functions.

 .Sh SEE ALSO
 .Sh SEE ALSO

+.Xr mmap 2 ,

 .Xr shmctl 2 ,
 .Xr shmget 2 ,
 .Xr shmctl 2 ,
 .Xr shmget 2 ,

-.Xr mmap 2
+.Xr compat 5