aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/filesystems/9p.txt
diff options
context:
space:
mode:
authorEric Van Hensbergen <ericvh@hera.kernel.org>2006-03-25 06:07:29 -0500
committerLinus Torvalds <torvalds@g5.osdl.org>2006-03-25 11:22:54 -0500
commit67543e508d74ad1a8e80290580c9d1440beba4d9 (patch)
treef631dcbb0ea52075bad316b4c8b55ca6f78c7a71 /Documentation/filesystems/9p.txt
parent42e8c509cfa3d92b3dcbfe95edf6be00e5d4b0eb (diff)
[PATCH] 9p: fix name consistency problems
There were a number of conflicting naming schemes used in the v9fs project. The directory was fs/9p, but MAINTAINERS and Documentation referred to v9fs. The module name itself was 9p2000, and the file system type was 9P. This patch attempts to clean that up, changing all references to 9p in order to match the directory name. We'll also start using 9p instead of v9fs as our patch prefix. There is also a minor consistency cleanup in the options changing the name option to uname in order to more closely match the Plan 9 options. Signed-off-by: Eric Van Hensbergevan <ericvh@gmail.com> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation/filesystems/9p.txt')
-rw-r--r--Documentation/filesystems/9p.txt99
1 files changed, 99 insertions, 0 deletions
diff --git a/Documentation/filesystems/9p.txt b/Documentation/filesystems/9p.txt
new file mode 100644
index 000000000000..24c7a9c41f0d
--- /dev/null
+++ b/Documentation/filesystems/9p.txt
@@ -0,0 +1,99 @@
1 V9FS: 9P2000 for Linux
2 ======================
3
4ABOUT
5=====
6
7v9fs is a Unix implementation of the Plan 9 9p remote filesystem protocol.
8
9This software was originally developed by Ron Minnich <rminnich@lanl.gov>
10and Maya Gokhale <maya@lanl.gov>. Additional development by Greg Watson
11<gwatson@lanl.gov> and most recently Eric Van Hensbergen
12<ericvh@gmail.com> and Latchesar Ionkov <lucho@ionkov.net>.
13
14USAGE
15=====
16
17For remote file server:
18
19 mount -t 9P 10.10.1.2 /mnt/9
20
21For Plan 9 From User Space applications (http://swtch.com/plan9)
22
23 mount -t 9P `namespace`/acme /mnt/9 -o proto=unix,name=$USER
24
25OPTIONS
26=======
27
28 proto=name select an alternative transport. Valid options are
29 currently:
30 unix - specifying a named pipe mount point
31 tcp - specifying a normal TCP/IP connection
32 fd - used passed file descriptors for connection
33 (see rfdno and wfdno)
34
35 name=name user name to attempt mount as on the remote server. The
36 server may override or ignore this value. Certain user
37 names may require authentication.
38
39 aname=name aname specifies the file tree to access when the server is
40 offering several exported file systems.
41
42 debug=n specifies debug level. The debug level is a bitmask.
43 0x01 = display verbose error messages
44 0x02 = developer debug (DEBUG_CURRENT)
45 0x04 = display 9P trace
46 0x08 = display VFS trace
47 0x10 = display Marshalling debug
48 0x20 = display RPC debug
49 0x40 = display transport debug
50 0x80 = display allocation debug
51
52 rfdno=n the file descriptor for reading with proto=fd
53
54 wfdno=n the file descriptor for writing with proto=fd
55
56 maxdata=n the number of bytes to use for 9P packet payload (msize)
57
58 port=n port to connect to on the remote server
59
60 noextend force legacy mode (no 9P2000.u semantics)
61
62 uid attempt to mount as a particular uid
63
64 gid attempt to mount with a particular gid
65
66 afid security channel - used by Plan 9 authentication protocols
67
68 nodevmap do not map special files - represent them as normal files.
69 This can be used to share devices/named pipes/sockets between
70 hosts. This functionality will be expanded in later versions.
71
72RESOURCES
73=========
74
75The Linux version of the 9P server is now maintained under the npfs project
76on sourceforge (http://sourceforge.net/projects/npfs).
77
78There are user and developer mailing lists available through the v9fs project
79on sourceforge (http://sourceforge.net/projects/v9fs).
80
81News and other information is maintained on SWiK (http://swik.net/v9fs).
82
83Bug reports may be issued through the kernel.org bugzilla
84(http://bugzilla.kernel.org)
85
86For more information on the Plan 9 Operating System check out
87http://plan9.bell-labs.com/plan9
88
89For information on Plan 9 from User Space (Plan 9 applications and libraries
90ported to Linux/BSD/OSX/etc) check out http://swtch.com/plan9
91
92
93STATUS
94======
95
96The 2.6 kernel support is working on PPC and x86.
97
98PLEASE USE THE SOURCEFORGE BUG-TRACKER TO REPORT PROBLEMS.
99