X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README;h=6d3eb739a34ba22c26e337effaa265a80fa32acb;hb=b70567b62c3adc90cd5f52ad869963bb4bd14435;hp=4115911b561300fe03e2bcf00cdc49ac004ace45;hpb=e083c2a0900ae13191b62a30db34fc5b57ce621b;p=deb_libnfs.git

diff --git a/README b/README
index 4115911..6d3eb73 100644
--- 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
@@ -47,6 +62,14 @@ This is highly non-portable so IF this works on your linux system, count
 yourself lucky.
 
 
+FUSE
+====
+A simple FUSE filesystem built on libnfs can be found in
+examples/fuse_nfs.c
+
+Compile using : gcc fuse_nfs.c -o fuse_nfs -lfuse -lnfs
+Mount using : sudo ./fuse_nfs -n nfs://<server>/<export> -m <mountpoint>
+
 
 PLATFORM support
 =================