summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Kaivo <jkk@ung.org>2020-07-15 16:48:23 -0400
committerJakob Kaivo <jkk@ung.org>2020-07-15 16:48:23 -0400
commitc4b21f6aeb45e5a0e3f8052117cae846ebbdae5e (patch)
treeec4b74960881f436651e39ed5714dad492da0966 /README.md
parent83e70e1b6c7abd0315dd8cd5a98a91c58e0cd8bd (diff)
document how to use the wrappermapalloc
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index fcfcded..59b53ff 100644
--- a/README.md
+++ b/README.md
@@ -56,3 +56,14 @@ provide macros:
Link your program with `-lmapalloc` (you may also need to specify
`-L` with the path to where `libmapalloc.a` is if you don't copy it to part
of your linker's default search path).
+
+Wrapper
+-------
+The dynamic library `libwrapalloc.so` is also built by default. This can
+be used to wrap the standard libc functions `malloc()`, `calloc()`, `realloc()`,
+and `free()` to their MapAlloc equivalents if your dynamic linker supports
+this. For example, on Linux systems with the GNU linker:
+
+```bash
+LD_PRELOAD=libwrapalloc.so command args...
+```