X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README;h=a86f3f7fdd7cb54260c9efccde76776a7f50c17e;hb=00748f36c57324ccc2cb21ac9af45d15821cf675;hp=c02b8ec2905bd08ab300b345153b094bf39fad67;hpb=84004dbf9bb2ab8a7f8b968affc53ee3065fa911;p=deb_libnfs.git

diff --git a/README b/README
index c02b8ec..a86f3f7 100644
--- a/README
+++ b/README
@@ -22,3 +22,55 @@ 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.
+
+Some versions of Linux support special capabilities that can be assigned to
+programs to allow non-root users to bind to system ports.
+This is set up by running 
+    sudo setcap 'cap_net_bind_service=+ep' /path/to/executable
+When libnfs is linked against an executable with this special capability
+assigned to it, libnfs may be able to use system ports even when executing
+under the privilege of a non-root user account.
+
+This is highly non-portable so IF this works on your linux system, count
+yourself lucky.
+
+
+
+PLATFORM support
+=================
+This is a truly multiplatform library.
+
+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
+Solaris
+Windows:- tested on Windows 7 64 and Windows XP 32 using Visual Studio 10 (see README.win32.txt for build instructions)
+Android:
+AROS: - Build with 'make -f aros/Makefile.AROS'
+
+
+RELEASE TARBALLS
+================
+Release tarballs are available at https://github.com/sahlberg/libnfs/downloads
+
+
+
+MAILINGLIST
+===========
+A libnfs mailinglist is available at http://groups.google.com/group/libnfs
+Announcements of new versions of libnfs will be posted to this list.
+