X-Git-Url: https://ruderich.org/simon/gitweb/?p=coloredstderr%2Fcoloredstderr.git;a=blobdiff_plain;f=README;h=967a6fd69a6c94d5c7be268c063b3ab418e1daad;hp=5e9917a5a059255ce067862bfad908c551b37e0d;hb=50a495887fd77be6e470e55a33a5effcc6319e21;hpb=04334418fcce94a1b528bd4c935d8126876bda04

diff --git a/README b/README
index 5e9917a..967a6fd 100644
--- a/README
+++ b/README
@@ -6,6 +6,8 @@ coloredstderr is a small library which uses 'LD_PRELOAD' to color stderr.
 
 Like all solutions using 'LD_PRELOAD' it only works with dynamically linked
 binaries. Statically linked binaries, for example valgrind, are not supported.
+setuid binaries are also not supported ('LD_PRELOAD' disabled for security
+reasons).
 
 
 It was inspired by stderred [2]. Similar solutions (using 'LD_PRELOAD')
@@ -51,6 +53,11 @@ inconsistent state causing a segmentation fault when using any functions of
 the library. Just remove the file first and then copy it. `make install`
 handles the install in this way and is therefore not affected.
 
+As a simple safeguard, `make` builds and installs the `libcoloredstderr.so`
+file non-writable to prevent accidental overwrites. Even if the overwrite is
+forced with `cp -f`, the file is unlinked and recreated by `cp` because the
+file is non-writable, preventing the problem.
+
 
 USAGE
 -----
@@ -89,6 +96,21 @@ The following additional environment variables are available:
   are colored.
 
 
+To set custom colors as pre/post strings you can use the `$''` feature of Bash
+and Zsh:
+
+    export COLORED_STDERR_PRE=$'\033[91m' # bright red
+    export COLORED_STDERR_POST=$'\033[0m' # default
+
+Or to be more compatible you can use the following which should work in any
+Bourne shell:
+
+    esc=`printf '\033'`
+    COLORED_STDERR_PRE="${esc}[91m" # red
+    COLORED_STDERR_POST="${esc}[0m" # default
+    export COLORED_STDERR_PRE COLORED_STDERR_POST
+
+
 DEBUG
 -----