Document the URL syntax

[deb_libnfs.git] / README

diff --git a/README b/README
index 330aa5aa7dcaaabd1066f9cf000b44b7cb4f7633..6d3eb739a34ba22c26e337effaa265a80fa32acb 100644 (file)
--- a/README
+++ b/README
@@ -23,6 +23,21 @@ stat(), read(), ...
 
 examples/nfsclient-sync.c provides examples on how to use this API
 
+URL-FORMAT:
+===========
+Libnfs uses RFC2224 style URLs extended with libnfs specific url arguments some minor extensions.
+The basic syntax of these URLs is :
+
+nfs://<server|ipv4>/path[?arg=val[&arg=val]*]
+
+Arguments supported by libnfs are :
+ tcp-syncnt=<int>  : Number of SYNs to send during the seccion establish
+                     before failing settin up the tcp connection to the
+                     server.
+ uid=<int>         : UID value to use when talking to the server.
+                     default it 65534 on Windows and getuid() on unixen.
+ gid=<int>         : GID value to use when talking to the server.
+                     default it 65534 on Windows and getgid() on unixen.
 
 
 ROOT vs NON-ROOT