| 1 | LIBNFS is a client library for accessing NFS shares over a network. |
| 2 | |
| 3 | LIBNFS offers three different APIs, for different use : |
| 4 | 1, RAW : A fully async low level rpc library for nfs protocols |
| 5 | This API is described in include/libnfs-raw.h |
| 6 | it offers a fully async interface to raw XDR encoded blobs. |
| 7 | This api provides very flexible and precice control of the RPC issued. |
| 8 | |
| 9 | examples/nfsclient-raw.c provides examples on how to use the raw API |
| 10 | |
| 11 | 2, NFS ASYNC : A fully asynchronous library for high level vfs functions |
| 12 | This API is described by the *_async() fucntions in include/libnfs.h. |
| 13 | This API provides a fully async access to posix vfs like functions such as |
| 14 | stat(), read(), ... |
| 15 | |
| 16 | examples/nfsclient-async.c provides examples on how to use this API |
| 17 | |
| 18 | |
| 19 | 3, NFS SYNC : A synchronous library for high level vfs functions |
| 20 | This API is described by the *_sync() fucntions in include/libnfs.h. |
| 21 | This API provides access to posix vfs like functions such as |
| 22 | stat(), read(), ... |
| 23 | |
| 24 | examples/nfsclient-sync.c provides examples on how to use this API |
| 25 | |
| 26 | |
| 27 | |
| 28 | ROOT vs NON-ROOT |
| 29 | ================ |
| 30 | When running as root, libnfs tries to allocate a system port for its connection |
| 31 | to the nfs server. When running as non-root it will use a normal |
| 32 | ephemeral port. |
| 33 | Many NFS servers default to a mode where they do not allow non-system |
| 34 | ports from connecting. |
| 35 | These servers require you use the "insecure" export option in /etc/exports |
| 36 | in order to allow libnfs clients to be able to connect. |