Merge branch 'writeback' of git://git.kernel.dk/linux-2.6-block
[pandora-kernel.git] / Documentation / filesystems / 9p.txt
index cda6905..57e0b80 100644 (file)
@@ -18,11 +18,11 @@ the 9p client is available in the form of a USENIX paper:
 
 Other applications are described in the following papers:
        * XCPU & Clustering
-               http://www.xcpu.org/xcpu-talk.pdf
+               http://xcpu.org/papers/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
+               http://xcpu.org/papers/kvmfs.pdf
+       * CellFS: A New Programming Model for the Cell BE
+               http://xcpu.org/papers/cellfs-talk.pdf
        * PROSE I/O: Using 9p to enable Application Partitions
                http://plan9.escet.urjc.es/iwp9/cready/PROSE_iwp9_2006.pdf
 
@@ -35,17 +35,20 @@ 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
-                       fd   - used passed file descriptors for connection
+                       unix    - specifying a named pipe mount point
+                       tcp     - specifying a normal TCP/IP connection
+                       fd      - used passed file descriptors for connection
                                 (see rfdno and wfdno)
+                       virtio  - connect to the next virtio channel available
+                               (from lguest or KVM with trans_virtio module)
+                       rdma    - connect to a specified RDMA channel
 
   uname=name   user name to attempt mount as on the remote server.  The
                server may override or ignore this value.  Certain user
@@ -54,23 +57,29 @@ 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
+                       fscache = use FS-Cache for a persistent, read-only
+                               cache backend.
 
   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
-                       0x08 = display VFS trace
-                       0x10 = display Marshalling debug
-                       0x20 = display RPC debug
-                       0x40 = display transport debug
-                       0x80 = display allocation debug
-
-  rfdno=n      the file descriptor for reading with proto=fd
-
-  wfdno=n      the file descriptor for writing with proto=fd
+                       0x01  = display verbose error messages
+                       0x02  = developer debug (DEBUG_CURRENT)
+                       0x04  = display 9p trace
+                       0x08  = display VFS trace
+                       0x10  = display Marshalling debug
+                       0x20  = display RPC debug
+                       0x40  = display transport debug
+                       0x80  = display allocation debug
+                       0x100 = display protocol message debug
+                       0x200 = display Fid debug
+                       0x400 = display packet debug
+                       0x800 = display fscache tracing debug
+
+  rfdno=n      the file descriptor for reading with trans=fd
+
+  wfdno=n      the file descriptor for writing with trans=fd
 
   maxdata=n    the number of bytes to use for 9p packet payload (msize)
 
@@ -78,9 +87,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
 
@@ -88,6 +97,20 @@ 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
+
+  cachetag     cache tag to use the specified persistent cache.
+               cache tags for existing cache sessions can be listed at
+               /sys/fs/9p/caches. (applies only to cache=fscache)
+
 RESOURCES
 =========
 
@@ -106,12 +129,16 @@ and export.
 A Linux version of the 9p server is now maintained under the npfs project
 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.
+available from the same SVN repository.
 
 There are user and developer mailing lists available through the v9fs project
 on sourceforge (http://sourceforge.net/projects/v9fs).
 
-News and other information is maintained on SWiK (http://swik.net/v9fs).
+A stand-alone version of the module (which should build for any 2.6 kernel)
+is available via (http://github.com/ericvh/9p-sac/tree/master)
+
+News and other information is maintained on SWiK (http://swik.net/v9fs)
+and the Wiki (http://sf.net/apps/mediawiki/v9fs/index.php).
 
 Bug reports may be issued through the kernel.org bugzilla 
 (http://bugzilla.kernel.org)