[WIN32] added nfsclient-sync to the solution. still manually linked with libnfs becau...
[deb_libnfs.git] / README
CommitLineData
84004dbf
RS
1LIBNFS is a client library for accessing NFS shares over a network.
2
3LIBNFS offers three different APIs, for different use :
41, RAW : A fully async low level rpc library for nfs protocols
5This API is described in include/libnfs-raw.h
6it offers a fully async interface to raw XDR encoded blobs.
7This api provides very flexible and precice control of the RPC issued.
8
9examples/nfsclient-raw.c provides examples on how to use the raw API
10
112, NFS ASYNC : A fully asynchronous library for high level vfs functions
12This API is described by the *_async() fucntions in include/libnfs.h.
13This API provides a fully async access to posix vfs like functions such as
14stat(), read(), ...
15
16examples/nfsclient-async.c provides examples on how to use this API
17
18
193, NFS SYNC : A synchronous library for high level vfs functions
20This API is described by the *_sync() fucntions in include/libnfs.h.
21This API provides access to posix vfs like functions such as
22stat(), read(), ...
23
24examples/nfsclient-sync.c provides examples on how to use this API
f7b81274
RS
25
26
27
28ROOT vs NON-ROOT
29================
30When running as root, libnfs tries to allocate a system port for its connection
31to the nfs server. When running as non-root it will use a normal
32ephemeral port.
33Many NFS servers default to a mode where they do not allow non-system
34ports from connecting.
35These servers require you use the "insecure" export option in /etc/exports
36in order to allow libnfs clients to be able to connect.
2461e211 37
9f88cb06 38PLATFORM support
2461e211
M
39=================
40As of now this is tested with linux, MacOSX and Apple iOS.
41
42Linux: - tested with Ubuntu 10.04 - should work with others aswell
c03a1e82 43Cygwin: - tested under 64bit win2k8.
2461e211
M
44MacOSX: - tested with SDK 10.4 (under Snow Leopard) - should also work with later SDKs and 64Bit
45iOS: - tested with iOS SDK 4.2 - running on iOS 4.3.x
9f88cb06 46FreeBSD:- tested with 8.2
647d2ea1 47OpenSolaris
c03a1e82
RS
48
49
50Cygwin
51------
52Configure with './configure --enable-tirpc' since cygwin only supports ti-rpc and not classic rpc.
53