Fix a typo in Documentation/keys.txt
[cascardo/linux.git] / Documentation / filesystems / 9p.txt
index 24c7a9c..bbd8b28 100644 (file)
@@ -1,5 +1,5 @@
-                       V9FS: 9P2000 for Linux
-                       ======================
+                   v9fs: Plan 9 Resource Sharing for Linux
+                   =======================================
 
 ABOUT
 =====
@@ -9,18 +9,19 @@ 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
 <gwatson@lanl.gov> and most recently Eric Van Hensbergen
-<ericvh@gmail.com> and Latchesar Ionkov <lucho@ionkov.net>.
+<ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox
+<rsc@swtch.com>.
 
 USAGE
 =====
 
 For remote file server:
 
-       mount -t 9P 10.10.1.2 /mnt/9
+       mount -t 9p 10.10.1.2 /mnt/9
 
 For Plan 9 From User Space applications (http://swtch.com/plan9)
 
-       mount -t 9P `namespace`/acme /mnt/9 -o proto=unix,name=$USER
+       mount -t 9p `namespace`/acme /mnt/9 -o proto=unix,uname=$USER
 
 OPTIONS
 =======
@@ -32,17 +33,21 @@ OPTIONS
                        fd   - used passed file descriptors for connection
                                 (see rfdno and wfdno)
 
-  name=name    user name to attempt mount as on the remote server.  The
+  uname=name   user name to attempt mount as on the remote server.  The
                server may override or ignore this value.  Certain user
                names may require authentication.
 
   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.
+                       loose = no attempts are made at consistency,
+                                intended for exclusive, read-only mounts
+
   debug=n      specifies debug level.  The debug level is a bitmask.
                        0x01 = display verbose error messages
                        0x02 = developer debug (DEBUG_CURRENT)
-                       0x04 = display 9P trace
+                       0x04 = display 9p trace
                        0x08 = display VFS trace
                        0x10 = display Marshalling debug
                        0x20 = display RPC debug
@@ -53,11 +58,11 @@ OPTIONS
 
   wfdno=n      the file descriptor for writing with proto=fd
 
-  maxdata=n    the number of bytes to use for 9P packet payload (msize)
+  maxdata=n    the number of bytes to use for 9p packet payload (msize)
 
   port=n       port to connect to on the remote server
 
-  noextend     force legacy mode (no 9P2000.u semantics)
+  noextend     force legacy mode (no 9p2000.u semantics)
 
   uid          attempt to mount as a particular uid
 
@@ -72,8 +77,22 @@ OPTIONS
 RESOURCES
 =========
 
-The Linux version of the 9P server is now maintained under the npfs project
-on sourceforge (http://sourceforge.net/projects/npfs).
+Our current recommendation is to use Inferno (http://www.vitanuova.com/inferno)
+as the 9p server.  You can start a 9p server under Inferno by issuing the
+following command:
+   ; styxlisten -A tcp!*!564 export '#U*'
+
+The -A specifies an unauthenticated export.  The 564 is the port # (you may
+have to choose a higher port number if running as a normal user).  The '#U*'
+specifies exporting the root of the Linux name space.  You may specify a
+subset of the namespace by extending the path: '#U*'/tmp would just export
+/tmp.  For more information, see the Inferno manual pages covering styxlisten
+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.
 
 There are user and developer mailing lists available through the v9fs project
 on sourceforge (http://sourceforge.net/projects/v9fs).
@@ -95,5 +114,5 @@ STATUS
 
 The 2.6 kernel support is working on PPC and x86.
 
-PLEASE USE THE SOURCEFORGE BUG-TRACKER TO REPORT PROBLEMS.
+PLEASE USE THE KERNEL BUGZILLA TO REPORT PROBLEMS. (http://bugzilla.kernel.org)