Commit | Line | Data |
---|---|---|
ed1f559b EVH |
1 | v9fs: Plan 9 Resource Sharing for Linux |
2 | ======================================= | |
93fa58cb EVH |
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 | |
ed1f559b EVH |
12 | <ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox |
13 | <rsc@swtch.com>. | |
93fa58cb EVH |
14 | |
15 | USAGE | |
16 | ===== | |
17 | ||
18 | For remote file server: | |
19 | ||
ed1f559b | 20 | mount -t 9p 10.10.1.2 /mnt/9 |
93fa58cb EVH |
21 | |
22 | For Plan 9 From User Space applications (http://swtch.com/plan9) | |
23 | ||
ed1f559b | 24 | mount -t 9p `namespace`/acme /mnt/9 -o proto=unix,uname=$USER |
93fa58cb EVH |
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 | ||
ed1f559b | 36 | uname=name user name to attempt mount as on the remote server. The |
93fa58cb EVH |
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 | ||
e03abc0c EVH |
43 | cache=mode specifies a cacheing policy. By default, no caches are used. |
44 | loose = no attempts are made at consistency, | |
45 | intended for exclusive, read-only mounts | |
46 | ||
93fa58cb EVH |
47 | debug=n specifies debug level. The debug level is a bitmask. |
48 | 0x01 = display verbose error messages | |
49 | 0x02 = developer debug (DEBUG_CURRENT) | |
ed1f559b | 50 | 0x04 = display 9p trace |
93fa58cb EVH |
51 | 0x08 = display VFS trace |
52 | 0x10 = display Marshalling debug | |
53 | 0x20 = display RPC debug | |
54 | 0x40 = display transport debug | |
55 | 0x80 = display allocation debug | |
56 | ||
57 | rfdno=n the file descriptor for reading with proto=fd | |
58 | ||
59 | wfdno=n the file descriptor for writing with proto=fd | |
60 | ||
ed1f559b | 61 | maxdata=n the number of bytes to use for 9p packet payload (msize) |
93fa58cb EVH |
62 | |
63 | port=n port to connect to on the remote server | |
64 | ||
ed1f559b | 65 | noextend force legacy mode (no 9p2000.u semantics) |
93fa58cb EVH |
66 | |
67 | uid attempt to mount as a particular uid | |
68 | ||
69 | gid attempt to mount with a particular gid | |
70 | ||
71 | afid security channel - used by Plan 9 authentication protocols | |
72 | ||
73 | nodevmap do not map special files - represent them as normal files. | |
74 | This can be used to share devices/named pipes/sockets between | |
75 | hosts. This functionality will be expanded in later versions. | |
76 | ||
77 | RESOURCES | |
78 | ========= | |
79 | ||
ff76e1df EVH |
80 | Our current recommendation is to use Inferno (http://www.vitanuova.com/inferno) |
81 | as the 9p server. You can start a 9p server under Inferno by issuing the | |
82 | following command: | |
83 | ; styxlisten -A tcp!*!564 export '#U*' | |
84 | ||
85 | The -A specifies an unauthenticated export. The 564 is the port # (you may | |
86 | have to choose a higher port number if running as a normal user). The '#U*' | |
87 | specifies exporting the root of the Linux name space. You may specify a | |
88 | subset of the namespace by extending the path: '#U*'/tmp would just export | |
89 | /tmp. For more information, see the Inferno manual pages covering styxlisten | |
90 | and export. | |
91 | ||
92 | A Linux version of the 9p server is now maintained under the npfs project | |
93 | on sourceforge (http://sourceforge.net/projects/npfs). There is also a | |
94 | more stable single-threaded version of the server (named spfs) available from | |
95 | the same CVS repository. | |
e1c92117 EVH |
96 | |
97 | There are user and developer mailing lists available through the v9fs project | |
98 | on sourceforge (http://sourceforge.net/projects/v9fs). | |
99 | ||
100 | News and other information is maintained on SWiK (http://swik.net/v9fs). | |
101 | ||
102 | Bug reports may be issued through the kernel.org bugzilla | |
103 | (http://bugzilla.kernel.org) | |
93fa58cb EVH |
104 | |
105 | For more information on the Plan 9 Operating System check out | |
106 | http://plan9.bell-labs.com/plan9 | |
107 | ||
108 | For information on Plan 9 from User Space (Plan 9 applications and libraries | |
109 | ported to Linux/BSD/OSX/etc) check out http://swtch.com/plan9 | |
110 | ||
111 | ||
112 | STATUS | |
113 | ====== | |
114 | ||
115 | The 2.6 kernel support is working on PPC and x86. | |
116 | ||
ff76e1df | 117 | PLEASE USE THE KERNEL BUGZILLA TO REPORT PROBLEMS. (http://bugzilla.kernel.org) |
93fa58cb | 118 |