add strdup
[libcext.git] / README.md
index a506381c9a06eb3e0c9e0e73d1bd014082a641ff..a10245f5216bf49a464dd99263ef1e9695eed633 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-A (WIP) collection of portable, strict C99, single-header implementations of common libc extensions.
+A collection of portable, strict C99, single-header implementations of common libc extensions.
+
+All functions are implemented as macros expanding to an internal function reference, this allows to use the headers with no meta build system - it compiles even if the extensions are already present, see _How to_ on disabling this behaviour.
 
 ### How to
 
 
 ### How to
 
@@ -39,10 +41,10 @@ includes `vasprintf()` and `asprintf()`
 
 ### getopt\_long
 
 
 ### getopt\_long
 
-includes `getopt()`, `getsubopt()`, `getopt_long()` and `getopt_long_only`
+includes `getopt()`, `getsubopt()`, `getopt_long()` and `getopt_long_only()`
 
 `getopt_long.h` has additional macros related to argument
 
 `getopt_long.h` has additional macros related to argument
-permuting, defining those enables it (GNU behaviour, will still be disabled with `$POSIXLY_CORRECT` set):
+permuting, defining those enables it per function (GNU behaviour, can still be disabled at runtime by setting `$POSIXLY_CORRECT`):
 
 ```
 #define GETOPT_PERMUTE_ARGS
 
 ```
 #define GETOPT_PERMUTE_ARGS
@@ -52,3 +54,14 @@ permuting, defining those enables it (GNU behaviour, will still be disabled with
 
 ---
 
 
 ---
 
+### strlcat
+
+includes `strlcat()` and `strlcpy()`
+
+---
+
+### strdup
+
+includes `strdup()` and `strndup()`
+
+`strndup()` follows the latest standard, meaning that it copies at most _n_ chars, not _n_ + 1.