Merge branch 'win32' into win32-3

[deb_libnfs.git] / README

diff --git a/README b/README
index c02b8ec2905bd08ab300b345153b094bf39fad67..cd1600f94d35ce7fff726ab540a1cda365bd437d 100644 (file)
--- a/README
+++ b/README
@@ -22,3 +22,32 @@ This API provides access to posix vfs like functions such as
 stat(), read(), ...
 
 examples/nfsclient-sync.c provides examples on how to use this API
+
+
+
+ROOT vs NON-ROOT
+================
+When running as root, libnfs tries to allocate a system port for its connection
+to the nfs server. When running as non-root it will use a normal 
+ephemeral port.
+Many NFS servers default to a mode where they do not allow non-system
+ports from connecting.
+These servers require you use the "insecure" export option in /etc/exports
+in order to allow libnfs clients to be able to connect.
+
+PLATFORM support
+=================
+As of now this is tested with linux, MacOSX and Apple iOS.
+
+Linux:  - tested with Ubuntu 10.04 - should work with others aswell
+Cygwin: - tested under 64bit win2k8.
+MacOSX: - tested with SDK 10.4 (under Snow Leopard) - should also work with later SDKs and 64Bit
+iOS:    - tested with iOS SDK 4.2 - running on iOS 4.3.x
+FreeBSD:- tested with 8.2
+OpenSolaris
+
+
+Cygwin
+------
+Configure with './configure --enable-tirpc' since cygwin only supports ti-rpc and not classic rpc.
+