tests/example_exec.c: Sort environment variables.

[coloredstderr/coloredstderr.git] / README

diff --git a/README b/README
index 79a40843429a4c66f346cf893be42c29f4834cb3..5e2209efdd37a5c29813359150938da8f770e31f 100644 (file)
--- a/README
+++ b/README
@@ -46,7 +46,7 @@ Then either install the library with `make install` or just copy it from
 
 *Important:* If you install `libcoloredstderr.so` manually, make sure _not_ to
 use plain `cp` to overwrite an existing `libcoloredstderr.so` file which is in
-use! Doing so will crash all processes which were started with 'LD_PRELOAD'
+use! Doing so will crash most processes which were started with 'LD_PRELOAD'
 set to this file. This is not a bug in coloredstderr, but a general problem.
 `cp` truncates the file which causes the `mmap()` ed library to be in an
 inconsistent state causing a segmentation fault when using any functions of
@@ -85,8 +85,7 @@ A default setup could look like this:
 The following additional environment variables are available:
 
 - 'COLORED_STDERR_PRE'
-  String to write before each write to stderr, defaults to "\033[91m" (bright
-  red).
+  String to write before each write to stderr, defaults to "\033[31m" (red).
 - 'COLORED_STDERR_POST'
   String to write after each write to stderr, defaults to "\033[0m" (reset
   color).
@@ -121,15 +120,15 @@ DEBUG
 To enable debug mode, configure coloredstderr with '--enable-debug'.
 
 *Important:* Debug mode enables `assert()`s in the code which might abort the
-process if an error condition is detected!
+process using 'LD_PRELOAD' if an error condition is detected!
 
 Debug mode is slower than normal mode. To log only warnings without the
 overhead of debug mode use '--enable-warnings'. `assert()`s are not enabled
 with '--enable-warnings', so it's safe to use.
 
-Debug messages are written to the file `colored_stderr_debug_log.txt` in the
-current working directory _if_ it exists. If it exists debug messages are
-appended. Be careful, this file might grow very quickly.
+Debug messages are appended to the file `colored_stderr_debug_log.txt` in the
+current working directory _if_ it exists. Be careful, this file might grow
+very quickly.
 
 *Important:* Warnings are written to `$HOME/colored_stderr_warning_log.txt`
 even if it _does not_ exist (only if debug or warning mode is enabled)! If it
@@ -137,6 +136,14 @@ doesn't exist it's created. An existing file isn't overwritten, but the
 warnings are appended at the end.
 
 
+KNOWN ISSUES
+------------
+
+- `{fputc,putc,putchar}_unlocked()` are not hooked when writing to stdout
+  (which might be redirected to stderr). Can't be fixed as the compiler
+  inlines the code into the program without calling any function.
+
+
 BUGS
 ----