Documentation/filesystems/9p.txt

   1                     v9fs: Plan 9 Resource Sharing for Linux
   2                     =======================================
   3
   4 ABOUT
   5 =====
   6
   7 v9fs is a Unix implementation of the Plan 9 9p remote filesystem protocol.
   8
   9 This software was originally developed by Ron Minnich <rminnich@lanl.gov>
  10 and Maya Gokhale <maya@lanl.gov>.  Additional development by Greg Watson
  11 <gwatson@lanl.gov> and most recently Eric Van Hensbergen
  12 <ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox
  13 <rsc@swtch.com>.
  14
  15 USAGE
  16 =====
  17
  18 For remote file server:
  19
  20         mount -t 9p 10.10.1.2 /mnt/9
  21
  22 For Plan 9 From User Space applications (http://swtch.com/plan9)
  23
  24         mount -t 9p `namespace`/acme /mnt/9 -o proto=unix,uname=$USER
  25
  26 OPTIONS
  27 =======
  28
  29   proto=name    select an alternative transport.  Valid options are
  30                 currently:
  31                         unix - specifying a named pipe mount point
  32                         tcp  - specifying a normal TCP/IP connection
  33                         fd   - used passed file descriptors for connection
  34                                 (see rfdno and wfdno)
  35
  36   uname=name    user name to attempt mount as on the remote server.  The
  37                 server may override or ignore this value.  Certain user
  38                 names may require authentication.
  39
  40   aname=name    aname specifies the file tree to access when the server is
  41                 offering several exported file systems.
  42
  43   debug=n       specifies debug level.  The debug level is a bitmask.
  44                         0x01 = display verbose error messages
  45                         0x02 = developer debug (DEBUG_CURRENT)
  46                         0x04 = display 9p trace
  47                         0x08 = display VFS trace
  48                         0x10 = display Marshalling debug
  49                         0x20 = display RPC debug
  50                         0x40 = display transport debug
  51                         0x80 = display allocation debug
  52
  53   rfdno=n       the file descriptor for reading with proto=fd
  54
  55   wfdno=n       the file descriptor for writing with proto=fd
  56
  57   maxdata=n     the number of bytes to use for 9p packet payload (msize)
  58
  59   port=n        port to connect to on the remote server
  60
  61   noextend      force legacy mode (no 9p2000.u semantics)
  62
  63   uid           attempt to mount as a particular uid
  64
  65   gid           attempt to mount with a particular gid
  66
  67   afid          security channel - used by Plan 9 authentication protocols
  68
  69   nodevmap      do not map special files - represent them as normal files.
  70                 This can be used to share devices/named pipes/sockets between
  71                 hosts.  This functionality will be expanded in later versions.
  72
  73 RESOURCES
  74 =========
  75
  76 The Linux version of the 9p server is now maintained under the npfs project
  77 on sourceforge (http://sourceforge.net/projects/npfs).
  78
  79 There are user and developer mailing lists available through the v9fs project
  80 on sourceforge (http://sourceforge.net/projects/v9fs).
  81
  82 News and other information is maintained on SWiK (http://swik.net/v9fs).
  83
  84 Bug reports may be issued through the kernel.org bugzilla
  85 (http://bugzilla.kernel.org)
  86
  87 For more information on the Plan 9 Operating System check out
  88 http://plan9.bell-labs.com/plan9
  89
  90 For information on Plan 9 from User Space (Plan 9 applications and libraries
  91 ported to Linux/BSD/OSX/etc) check out http://swtch.com/plan9
  92
  93
  94 STATUS
  95 ======
  96
  97 The 2.6 kernel support is working on PPC and x86.
  98
  99 PLEASE USE THE SOURCEFORGE BUG-TRACKER TO REPORT PROBLEMS.
 100