9p.txt 3.7 KB

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