summaryrefslogtreecommitdiff
path: root/doc/ux-mmap.rst
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2022-10-24 21:03:43 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2022-10-24 21:03:43 +0200
commitaab49e5a013c53ae812a143fe41add74e0677a61 (patch)
treef0c6e1ba7db9991f2bd38c9169f9921bfe5e61d8 /doc/ux-mmap.rst
parentdf5167db909a88fb8e16dd20b37442495a6ac059 (diff)
parent532d4a24e2013262dfa41fd85c06a9715c99abf7 (diff)
Update upstream source from tag 'upstream/4.7'
Update to upstream version '4.7' with Debian dir d3e11463c915e5c39507206197eb3acd42bb8f5f
Diffstat (limited to 'doc/ux-mmap.rst')
-rw-r--r--doc/ux-mmap.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/ux-mmap.rst b/doc/ux-mmap.rst
new file mode 100644
index 0000000..c59421c
--- /dev/null
+++ b/doc/ux-mmap.rst
@@ -0,0 +1,27 @@
+======================================
+ux-mmap - Unix compatibility functions
+======================================
+
+Date authored: 2006-02-25
+
+Description
+===========
+
+libHX provides a Linux-style ``mmap()`` function for Win32.
+
+Synopsis
+========
+
+.. code-block:: c
+
+ #include <libHX.h>
+
+ void *mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
+
+``mmap()``
+
+ See the Linux manual page ``mmap``(2) for details. Many flags described
+ in ``mmap``(2) do not work. What does work: ``PROT_NONE``,
+ ``PROT_READ``, ``PROT_WRITE``, ``PROT_EXEC`` (only WinXP SP2 or
+ WinServer2003 SP1 or up), ``MAP_SHARED`` and ``MAP_PRIVATE``.
+ ``MAP_SHARED`` is the default if no ``MAP_PRIVATE`` is given.