X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;f=README;h=34cff3029bd41bdcdf99e6bec6631c8d5990d0cd;hb=dcaadb5f7c530d348d936bf642ada9ef1ea855d1;hp=6bedd742c33faf44818ec01e06029d20f8cc19ec;hpb=6d6ad4423ae87771bd44f90006a648ec03931961;p=coloredstderr%2Fcoloredstderr.git

diff --git a/README b/README
index 6bedd74..34cff30 100644
--- a/README
+++ b/README
@@ -31,6 +31,27 @@ DEPENDENCIES
 - dynamic linker/loader which supports 'LD_PRELOAD' (e.g. GNU/Linux's ld.so)
 
 
+INSTALLATION
+------------
+
+    ./configure && make && make check
+
+Then either install the library with `make install` or just copy it from
+`src/.libs/` to wherever you want to install it:
+
+    rm -f /destination/path/for/library/libcoloredstderr.so
+    cp -L src/.libs/libcoloredstderr.so /destination/path/for/library/
+
+*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'
+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
+the library. Just remove the file first and then copy it. `make install`
+handles the install in this way and is therefore not affected.
+
+
 USAGE
 -----
 
@@ -68,6 +89,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
 -----