vcs.maemo.org Git - unfs3/blob - unfs3/README

   1 UNFS3 (User-Space NFSv3 Server)
   2 (C) 2003-2006, Pascal Schmidt <unfs3-server@ewetel.net>
   3
   4
   5 INTRODUCTION
   6 ============
   7
   8 UNFS3 is a user-space implementation of the NFSv3 server
   9 specification.
  10
  11 UNFS3 supports all NFSv3 procedures with the exception of the
  12 READDIRPLUS procedure. It tries to provide as much information
  13 to NFS clients as possible, within the limits possible from
  14 user-space.
  15
  16 See the unfsd(8) manpage for restrictions imposed on NFS
  17 operations (section RESTRICTIONS) and for possible races
  18 with local file system activity (section BUGS).
  19
  20 It is not possible to export to netgroups or wildcard hostnames
  21 via /etc/exports, all other addressing methods should work. The
  22 following options are recognized in the exports file: ro, rw,
  23 root_squash, all_squash, no_root_squash, no_all_squash. If
  24 other options are present, they are ignored.
  25
  26 Cluster extensions compatible to the older ClusterNFS project
  27 are supported when the source is configured with --enable-cluster.
  28
  29
  30 SUPPORTED SYSTEMS
  31 =================
  32
  33 Linux:          compiles and runs, passes Connectathon 2003 NFS
  34                 testsuite's "basic" and "general" tests, survives
  35                 fsx stress testing
  36
  37 Solaris:        compiles and runs, survives light testing
  38
  39 NetBSD:         compiles and runs, but there are compatibility
  40                 problems with the in-kernel NFS client
  41
  42 AIX:            compiles
  43
  44 Irix:           compiles (with gcc and native compiler)
  45
  46 OS X:           compiles
  47
  48 Note that only Linux support is checked for all releases. If unfs3
  49 breaks on other platforms, a bug report is appreciated.
  50
  51
  52 INSTALLATION
  53 ============
  54
  55 You will need gcc, lex (flex), and yacc (bison) to compile UNFS3.
  56
  57         ./configure
  58         make
  59         make install
  60
  61 Please read the manpage for information about command-line
  62 options.
  63
  64         man 8 unfsd
  65
  66 If you decide to modify the code yourself, you can run
  67
  68         make dep
  69
  70 to append dependency information to the Makefile, so that make
  71 knows which files depend on each other and recompiles all the
  72 necessary files on changes.
  73
  74
  75 CVS REPOSITORY
  76 ==============
  77
  78 The unfs3 CVS repository is accessible via anonymous CVS. The source
  79 can be checked out with:
  80
  81   cvs -d:pserver:anonymous@cvs.lysator.liu.se:/cvsroot/unfs3 login
  82   cvs -d:pserver:anonymous@cvs.lysator.liu.se:/cvsroot/unfs3 co unfs3
  83
  84 You can also use the web-based CVS repository viewer at:
  85
  86   http://cvs.lysator.liu.se/viewcvs/viewcvs.cgi/?cvsroot=unfs3
  87
  88 In the HEAD branch, you will find a file called "BRANCHES", which
  89 describes the different branches in this repository.