X-Git-Url: https://git.saurik.com/apple/libc.git/blobdiff_plain/9385eb3d10ebe5eb398c52040ec3dbfba9b0cdcf..2acb89982f71719aec26ca16705bd2c0400a9550:/stdlib/FreeBSD/memory.3

diff --git a/stdlib/FreeBSD/memory.3 b/stdlib/FreeBSD/memory.3
index 25222d4..96cef24 100644
--- a/stdlib/FreeBSD/memory.3
+++ b/stdlib/FreeBSD/memory.3
@@ -9,10 +9,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"	This product includes software developed by the University of
-.\"	California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
@@ -30,48 +26,107 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)memory.3	8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/stdlib/memory.3,v 1.11 2001/09/07 14:46:35 asmodai Exp $
+.\" $FreeBSD: src/lib/libc/stdlib/memory.3,v 1.12 2007/01/09 00:28:10 imp Exp $
 .\"
 .Dd June 4, 1993
 .Dt MEMORY 3
 .Os
 .Sh NAME
-.Nm malloc ,
-.Nm free ,
-.Nm realloc ,
-.Nm calloc ,
 .Nm alloca ,
-.Nm mmap
+.Nm calloc ,
+.Nm free ,
+.Nm malloc ,
+.Nm mmap ,
+.Nm realloc
 .Nd general memory allocation operations
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft void *
-.Fn malloc "size_t size"
-.Ft void
-.Fn free "void *ptr"
+.Fo alloca
+.Fa "size_t size"
+.Fc
 .Ft void *
-.Fn realloc "void *ptr" "size_t size"
+.Fo calloc
+.Fa "size_t nelem"
+.Fa "size_t elsize"
+.Fc
+.Ft void
+.Fo free
+.Fa "void *ptr"
+.Fc
 .Ft void *
-.Fn calloc "size_t nelem" "size_t elsize"
+.Fo malloc
+.Fa "size_t size"
+.Fc
 .Ft void *
-.Fn alloca "size_t size"
-.In sys/types.h
+.Fo realloc
+.Fa "void *ptr"
+.Fa "size_t size"
+.Fc
 .In sys/mman.h
 .Ft void *
-.Fn mmap "void * addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
+.Fo mmap
+.Fa "void * addr"
+.Fa "size_t len"
+.Fa "int prot"
+.Fa "int flags"
+.Fa "int fildes"
+.Fa "off_t off"
+.Fc
 .Sh DESCRIPTION
 These functions allocate and free memory for the calling process.
 They are described in the
 individual manual pages.
+.Sh LEGACY SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/mman.h>
+.Pp
+.Ft void *
+.br
+.Fo mmap
+.Fa "void * addr"
+.Fa "size_t len"
+.Fa "int prot"
+.Fa "int flags"
+.Fa "int fildes"
+.Fa "off_t off"
+.Fc ;
+.Pp
+The include file
+.In sys/types.h
+is needed for this function.
+.Sh COMPATIBILITY
+.Fn mmap
+now returns with
+.Va errno
+set to EINVAL in places that historically succeeded.
+The rules have changed as follows:
+.Bl -bullet
+.It
+The
+.Fa flags
+parameter must specify either MAP_PRIVATE or MAP_SHARED.
+.It
+The
+.Fa size
+parameter must not be 0.
+.It
+The
+.Fa off
+parameter must be a multiple of pagesize,
+as returned by
+.Fn sysconf .
+.El
 .Sh SEE ALSO
 .Xr mmap 2 ,
 .Xr alloca 3 ,
 .Xr calloc 3 ,
 .Xr free 3 ,
 .Xr malloc 3 ,
-.Xr realloc 3
+.Xr realloc 3 ,
+.Xr compat 5
 .Sh STANDARDS
 These functions, with the exception of
 .Fn alloca