Debian Codegraph @

doc/README.avfs-fuse

raw
1 November 2005
2 May 2006 (updated)
3
4 This version of AVFS includes support for fuse (Filesystems in
5 userspace). AVFS can also be used as a (shared) library for programs
6 with dedicated support.
7
8 Fuse support consists of a single daemon file and startup
9 script. In order to compile fuse support, the avfs library must
10 be compiled. However, it does NOT have to be installed. The
11 following steps should be followed prior to building the fuse
12 daemon.
13
14 SETUP:
15 ------
16 Prior to using the fuse avfs daemon, fuse support MUST be compiled
17 into your 2.6 version kernel. In addition, the fuse library >= 2.4
18 must be installed.
19
20 Change to the cvs or snapshot download directory. You do NOT need
21 to be root. You DO need to have write permissions to the download
22 directory.
23
24 NEW: Beginning with the 0.97pre versions, the configure command
25 has a new option: --enable-fuse. Choosing this configure option
26 will allow only the fuse daemon to be compiled and installed.
27
28 user avfsdldir> ./autogen.sh
29 user avfsdldir> ./configure --enable-fuse
30 user avfsdldir> make
31
32 Now, you need to become root and execute
33
34 user avfsdldir> make install
35
36 This will install the daemon and startup and shutdown scripts.
37
38 IF THERE ARE ERRORS perhaps review the compile steps above and
39 determine what the errors are and correct. Perhaps a library
40 is missing?
41
42 IMPLEMENTATION:
43 ---------------
44 AVFS can entirely be implemented by any user. To do so requires
45 that:
46
47 1) fuse support is compiled into the kernel or is a kernel
48 module and loaded
49 2) the fuse package is installed (http://fuse.sf.net)
50 3) the user create a directory called .avfs in his/her home
51 directory (mkdir ~/.avfs).
52 4) the user run the program mountavfs
53
54 mountavfs loads the avfsd daemon and mounts the virtual
55 filesystem at ~/.avfs.
56
57 Once done, the user will be able to access all kinds of com-
58 pressed files via the pseudo-fs ~/.avfs.
59
60 Testing the installation:
61 -------------------------
62
63 1) type mountavfs
64 a message should appear that avfs is loaded.
65
66 The README docs indicate that testing can be done as
67 ls /#avfsstat. This will not work. Using this version of
68 AVFS, try:
69
70 ls ~/.avfs/#avfsstat
71
72 Anytime the docs say /#avfsstat or filename#, always prepend
73 ~/.avfs/, ex:
74
75 ls ~/.avfs/myzipfile.zip#
76 - or -
77 cat ~/.avfs/README.gz#
78
79 Using with ROX:
80 ---------------
81 Rox supports AVFS access, however, not with fuse. Trying to
82 open a compressed file with Ctrl+O will result in an error
83 since Rox still expects AVFS to use the preload method.
84
85 To get around this, the user can create a run action for any
86 type of compressed file as follows:
87
88 rox $HOME/.avfs/$@#
89
90 If you wish to use a Shell command within ROX, press BANG (!)
91 and type similar to the above except a $PWD needs to be inserted
92 before the $@ shell variable (don't know why, but with !, ROX
93 does not expand $@ to a full pathname/filename).
94
95 !rox $HOME/.avfs/$PWD/$@#
96
97 Of course, $HOME can be replaced with ~ if desired.
98
99 Thanks to Jonatan Liljedahl, rox developer, for the tip and
100 workaround AND for alerting me that fuse CAN work with AVFS.
101
102 Stopping AVFS:
103 --------------
104 Make sure no files are being accessed via AVFS. Then:
105
106 umountavfs
107
108 or
109
110 fusermount -u ~/.avfs
111
112 This will unmount the virtual filesystem AND unload the
113 avfsd daemon. The user can start AVFS anytime later.
114
115 ***** CAUTION *****
116 This code is CVS. It may change, it may not work! As with
117 all developmental code, the user is advised to exercise
118 proper caution and backup protocols.
119 ***** END CAUTION *****
120
121 More information can be obtained from:
122 http://sourceforge.net/projects/avf
123 http://sourceforge.net/projects/fuse or
124 http://fuse.sourceforge.net
125 http://rox.sourceforge.net
126
127 Documentation by
128 Peter Hyman
129 [email protected]
130