add getopt_long

[libcext.git] / README.md

diff --git a/README.md b/README.md
index 59cf6d6de00bd3017b5006185debb460e5ec1628..46ea40c2336230ebc9219165f636fda5a8a6470e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,24 @@
-A (WIP) collection of portable, strict C99, single-header implementations of common libc extensions.
+A (WIP) collection of portable, (mostly) strict C99, single-header implementations of common libc extensions.
 
 ### How to
 
 Include the header in every file needed as usual:
 
 ```
-#include "<ext-func-name.h>"
+#include "<ext-func-name>.h"
 ```
 
 In the file chosen for the function implementation:
 
 ```
-#define <EXT-FUNC-NAME>_IMPLEMENTATION_
+#define <EXT-FUNC-NAME>_IMPLEMENTATION
 #include "<ext-func-name.h>"
 ```
 
-By default, the header won't have any includes, change that with:
+By default, the header won't have any stdlib includes, change that with:
 
 ```
-#define <EXT-FUNC-NAME>_INCLUDE_LIBC_
+#define <EXT-FUNC-NAME>_INCLUDE_LIBC
 ```
 
 Or disable function override with:
@@ -26,3 +26,16 @@ Or disable function override with:
 ```
 #define HAVE_<EXT-FUNC-NAME>
 ```
+
+## Specifics
+
+### getopt\_long
+
+`getopt_long.h` has additional macros related to argument
+permuting, defining those enables it (GNU behaviour):
+
+```
+#define GETOPT_PERMUTE_ARGS
+#define GETOPT_LONG_PERMUTE_ARGS
+#define GETOPT_LONG_ONLY_PERMUTE_ARGS
+```