uwrap: Suppress fall through warnings
[uid_wrapper.git] / README
diff --git a/README b/README
index 9aa508b660d8e4cd4afaaf92705914f55a5c9087..764fd3689cf729eeacd7ab569e9ecc9d590d88a5 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,24 @@
-UID wrapper library
-====================
+UID_WRAPPER
+===========
 
-This library intercepts seteuid and related calls, and simulates them
-in a manner similar to the nss_wrapper and socket_wrapper libraries.
+This is a wrapper for the user, group and hosts NSS API.
 
-This allows you to do user switching when testing e.g. file servers.
+DESCRIPTION
+-----------
 
-To use it set the following environment variables:
+More details can be found in the manpage:
 
-LD_PRELOAD=libuid_wrapper.so
-UID_WRAPPER=1
+  man -l ./doc/uid_wrapper.1
 
-If you unset the variable or set it to 0 you can disable uwrap even if it is
-loaded. If you need the application to think it is root at startup you can set:
+or the raw text version:
 
-UID_WRAPPER_ROOT=1
+  less ./doc/uid_wrapper.1.txt
 
-If you set the environment variable to UID_WRAPPER_ROOT=2 before you call
-geteuid() then it will return the real uid.
+For installation instructions please take a look at the README.install file.
+
+MAILINGLIST
+-----------
+
+As the mailing list samba-technical is used and can be found here:
+
+https://lists.samba.org/mailman/listinfo/samba-technical