UNFS3 (User-Space NFSv3 Server)
(C) 2003-2006, Pascal Schmidt <unfs3-server@ewetel.net>


INTRODUCTION
============

UNFS3 is a user-space implementation of the NFSv3 server
specification.

UNFS3 supports all NFSv3 procedures with the exception of the
READDIRPLUS procedure. It tries to provide as much information
to NFS clients as possible, within the limits possible from
user-space.

See the unfsd(8) manpage for restrictions imposed on NFS
operations (section RESTRICTIONS) and for possible races
with local file system activity (section BUGS).

It is not possible to export to netgroups or wildcard hostnames
via /etc/exports, all other addressing methods should work. The
following options are recognized in the exports file: ro, rw,
root_squash, all_squash, no_root_squash, no_all_squash. If
other options are present, they are ignored.

Cluster extensions compatible to the older ClusterNFS project
are supported when the source is configured with --enable-cluster.


SUPPORTED SYSTEMS
=================

Linux:		compiles and runs, passes Connectathon 2003 NFS
		testsuite's "basic" and "general" tests, survives
		fsx stress testing

Solaris: 	compiles and runs, survives light testing

NetBSD: 	compiles and runs, but there are compatibility
		problems with the in-kernel NFS client

AIX:		compiles

Irix:		compiles (with gcc and native compiler)

OS X:		compiles

Note that only Linux support is checked for all releases. If unfs3
breaks on other platforms, a bug report is appreciated.


INSTALLATION
============

You will need gcc, lex (flex), and yacc (bison) to compile UNFS3.

	./configure
	make
	make install

Please read the manpage for information about command-line
options.

	man 8 unfsd

If you decide to modify the code yourself, you can run

	make dep
	
to append dependency information to the Makefile, so that make
knows which files depend on each other and recompiles all the
necessary files on changes.


CVS REPOSITORY
==============

The unfs3 CVS repository is accessible via anonymous CVS. The source
can be checked out with:

  cvs -d:pserver:anonymous@cvs.lysator.liu.se:/cvsroot/unfs3 login
  cvs -d:pserver:anonymous@cvs.lysator.liu.se:/cvsroot/unfs3 co unfs3

You can also use the web-based CVS repository viewer at: 

  http://cvs.lysator.liu.se/viewcvs/viewcvs.cgi/?cvsroot=unfs3

In the HEAD branch, you will find a file called "BRANCHES", which
describes the different branches in this repository.