Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[pandora-kernel.git] / Documentation / filesystems / 9p.txt
index bbd8b28..b90f537 100644 (file)
@@ -6,12 +6,26 @@ ABOUT
 
 v9fs is a Unix implementation of the Plan 9 9p remote filesystem protocol.
 
-This software was originally developed by Ron Minnich <rminnich@lanl.gov>
-and Maya Gokhale <maya@lanl.gov>.  Additional development by Greg Watson
+This software was originally developed by Ron Minnich <rminnich@sandia.gov>
+and Maya Gokhale.  Additional development by Greg Watson
 <gwatson@lanl.gov> and most recently Eric Van Hensbergen
 <ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox
 <rsc@swtch.com>.
 
+The best detailed explanation of the Linux implementation and applications of
+the 9p client is available in the form of a USENIX paper:
+   http://www.usenix.org/events/usenix05/tech/freenix/hensbergen.html
+
+Other applications are described in the following papers:
+       * XCPU & Clustering
+               http://www.xcpu.org/xcpu-talk.pdf
+       * KVMFS: control file system for KVM
+               http://www.xcpu.org/kvmfs.pdf
+       * CellFS: A New ProgrammingModel for the Cell BE
+               http://www.xcpu.org/cellfs-talk.pdf
+       * PROSE I/O: Using 9p to enable Application Partitions
+               http://plan9.escet.urjc.es/iwp9/cready/PROSE_iwp9_2006.pdf
+
 USAGE
 =====
 
@@ -21,12 +35,12 @@ For remote file server:
 
 For Plan 9 From User Space applications (http://swtch.com/plan9)
 
-       mount -t 9p `namespace`/acme /mnt/9 -o proto=unix,uname=$USER
+       mount -t 9p `namespace`/acme /mnt/9 -o trans=unix,uname=$USER
 
 OPTIONS
 =======
 
-  proto=name   select an alternative transport.  Valid options are
+  trans=name   select an alternative transport.  Valid options are
                currently:
                        unix - specifying a named pipe mount point
                        tcp  - specifying a normal TCP/IP connection
@@ -40,7 +54,7 @@ OPTIONS
   aname=name   aname specifies the file tree to access when the server is
                offering several exported file systems.
 
-  cache=mode   specifies a cacheing policy.  By default, no caches are used.
+  cache=mode   specifies a caching policy.  By default, no caches are used.
                        loose = no attempts are made at consistency,
                                 intended for exclusive, read-only mounts
 
@@ -54,9 +68,9 @@ OPTIONS
                        0x40 = display transport debug
                        0x80 = display allocation debug
 
-  rfdno=n      the file descriptor for reading with proto=fd
+  rfdno=n      the file descriptor for reading with trans=fd
 
-  wfdno=n      the file descriptor for writing with proto=fd
+  wfdno=n      the file descriptor for writing with trans=fd
 
   maxdata=n    the number of bytes to use for 9p packet payload (msize)
 
@@ -64,9 +78,9 @@ OPTIONS
 
   noextend     force legacy mode (no 9p2000.u semantics)
 
-  uid          attempt to mount as a particular uid
+  dfltuid      attempt to mount as a particular uid
 
-  gid          attempt to mount with a particular gid
+  dfltgid      attempt to mount with a particular gid
 
   afid         security channel - used by Plan 9 authentication protocols
 
@@ -74,6 +88,16 @@ OPTIONS
                This can be used to share devices/named pipes/sockets between
                hosts.  This functionality will be expanded in later versions.
 
+  access       there are three access modes.
+                       user  = if a user tries to access a file on v9fs
+                               filesystem for the first time, v9fs sends an
+                               attach command (Tattach) for that user.
+                               This is the default mode.
+                       <uid> = allows only user with uid=<uid> to access
+                               the files on the mounted filesystem
+                       any   = v9fs does single attach and performs all
+                               operations as one user
+
 RESOURCES
 =========
 
@@ -90,9 +114,9 @@ subset of the namespace by extending the path: '#U*'/tmp would just export
 and export.
 
 A Linux version of the 9p server is now maintained under the npfs project
-on sourceforge (http://sourceforge.net/projects/npfs).  There is also a
-more stable single-threaded version of the server (named spfs) available from
-the same CVS repository.
+on sourceforge (http://sourceforge.net/projects/npfs).  The currently
+maintained version is the single-threaded version of the server (named spfs)
+available from the same CVS repository.
 
 There are user and developer mailing lists available through the v9fs project
 on sourceforge (http://sourceforge.net/projects/v9fs).