Initial revision
[nfs-utils.git] / linux-nfs / README
1
2 This package contains a greatly revised NFS implementation for Linux
3 along with the necessary daemons and utilities. There are still several
4 features missing that I'd want to include, and there are some recent
5 improvements to the Linux NFS kernel client not reflected here (notably
6 the attrtimeo fix).
7
8 This thing has become much too large for me to handle all alone anymore.
9 Originally, I had planned to have most of the NFS implementation running
10 stably by August, so I could start to concentrate more on other jobs that
11 are currently in the queue (like updating the NAG). As it turned out, it
12 was much more work than I anticipated, and I fell short of my time goal.
13 I'm therefore looking for volunteers who would like to work with me on
14 finishing this package. Otherwise, this project could end up rusting in
15 the corner of some FTP site...
16
17 Ideally, I would want to hand over parts of the source tree to other
18 hackers to maintain/enhance/etc. But that's not a requirement; if you
19 feel you don't have that much time, you can also contribute by picking
20 up one of the loose ends and finish what needs to be done (take a look
21 at the TODO file...) And then, you can also be plainly a tester.
22
23 There's currently a mailing list for lockd development at NRAO
24 (lockd-statd@linux.nrao.edu --- mail majordomo@linux.nrao.edu to
25 subscribe). If Jeff agress, we could turn this into a general linux-nfs
26 mailing list.
27
28
29 Hope this covers about what I wanted to say,
30 Olaf
31
32 ------------------------------------------------------------------
33
34
35                         SOURCE TREE OVERVIEW
36
37
38
39 support/        Support libraries for user-space programs
40
41 support/nfs     Generic library for nfsd utilities
42 support/export  Manipulation of /etc/exports and /var/lib/nfs/{xtab,rmtab}
43
44 utils/          Code for various user-space programs.
45 utils/exportfs  Management of nfsd export table.
46 utils/mount     Modified mount command to support NFS over TCP.
47 utils/mountd    New rpc.mountd for kernel nfsd.
48 utils/nfsd      New nfsd (just starts kernel nfsd).
49 utils/nfsstat   Pretty-print NFS stats from /proc/net/rpc/nfs*
50 utils/rquotad   Marco van Wieringen's rquotad
51 utils/showmount Rick Sladkey's showmount client
52 utils/statd     Jeff Uphoff's rpc.statd.
53
54 tools/          Support tools for developers/debuggers/testers
55 tools/rpcdebug  This one sets/gets the debug flags for each of the kernel
56                 modules.