Add a simple LD_PRELOAD toy to make cat and cp nfs-aware

[deb_libnfs.git] / README

diff --git a/README b/README
index f717c07deb7f1a21007d18037c95859e81feb88d..4e312da9e70a8b65bf78da6c03dc8d21ddb7acca 100644 (file)
--- a/README
+++ b/README
@@ -86,6 +86,25 @@ Android:
 AROS: - Build with 'make -f aros/Makefile.AROS'
 
 
+LD_PRELOAD
+==========
+examples/ld_nfs.c contains a LD_PRELOADable module that can be used to make
+several standard utilities nfs aware.
+It is still very incomplete but can be used for basic things such as cat and cp.
+Patches to add more coverage is welcome.
+
+Compile with :
+gcc -fPIC -shared -o ld_nfs.so examples/ld_nfs.c -ldl -lnfs
+
+Then try things like
+LD_NFS_DEBUG=9 LD_PRELOAD=./ld_nfs.so cat nfs://127.0.0.1/data/tmp/foo123
+
+LD_NFS_DEBUG=9 LD_PRELOAD=./ld_nfs.so cp nfs://127.0.0.1/data/tmp/foo123 nfs://127.0.0.1/data/tmp/foo123.copy
+
+This is just a toy preload module. Don't open bugs if it does not work. Send
+patches to make it better instead.
+
+
 RELEASE TARBALLS
 ================
 Release tarballs are available at https://sites.google.com/site/libnfstarballs/li