From 0961765a56842b8dec504baea51f6eda1fc3224f Mon Sep 17 00:00:00 2001 From: Ronnie Sahlberg Date: Wed, 25 Dec 2013 16:27:10 -0800 Subject: [PATCH] Document the URL syntax --- README | 15 +++++++++++++++ include/nfsc/libnfs.h | 18 ++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/README b/README index 330aa5a..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:///path[?arg=val[&arg=val]*] + +Arguments supported by libnfs are : + tcp-syncnt= : Number of SYNs to send during the seccion establish + before failing settin up the tcp connection to the + server. + uid= : UID value to use when talking to the server. + default it 65534 on Windows and getuid() on unixen. + gid= : GID value to use when talking to the server. + default it 65534 on Windows and getgid() on unixen. ROOT vs NON-ROOT diff --git a/include/nfsc/libnfs.h b/include/nfsc/libnfs.h index 1ea7561..3ca48e4 100644 --- a/include/nfsc/libnfs.h +++ b/include/nfsc/libnfs.h @@ -111,6 +111,24 @@ EXTERN struct nfs_context *nfs_init_context(void); EXTERN void nfs_destroy_context(struct nfs_context *nfs); +/* + * URL parsing functions. + * These functions all parse a URL of the form + * nfs://server/path/file?argv=val[&arg=val]* + * and returns a nfs_url. + * + * Apart from parsing the URL the functions will also update + * the nfs context to reflect settings controlled via url arguments. + * + * Current URL arguments are : + * tcp-syncnt= : Number of SYNs to send during the seccion establish + * before failing settin up the tcp connection to the + * server. + * uid= : UID value to use when talking to the server. + * default it 65534 on Windows and getuid() on unixen. + * gid= : GID value to use when talking to the server. + * default it 65534 on Windows and getgid() on unixen. + */ /* * Parse a complete NFS URL including, server, path and * filename. Fail if any component is missing. -- 2.34.1