| 1 |
What Is AVFS |
| 2 |
------------ |
| 3 |
|
| 4 |
AVFS is a system, which enables all programs to look inside archived |
| 5 |
or compressed files, or access remote files without recompiling the |
| 6 |
programs or changing the kernel. |
| 7 |
|
| 8 |
At the moment it supports floppies, tar and gzip files, zip, bzip2, ar |
| 9 |
and rar files, ftp sessions, http, webdav, rsh/rcp, ssh/scp. Quite a |
| 10 |
few other handlers are implemented with the Midnight Commander's |
| 11 |
external FS. |
| 12 |
|
| 13 |
AVFS is (C) under the GNU GPL (see the file COPYING). The shared |
| 14 |
library is (C) under the GNU LGPL (see the file COPYING.LIB). |
| 15 |
|
| 16 |
AVFS comes with ABSOLUTELY NO WARRANTY, for details see the file COPYING. |
| 17 |
|
| 18 |
Where Is The Latest Version |
| 19 |
--------------------------- |
| 20 |
|
| 21 |
Check out the page |
| 22 |
|
| 23 |
https://avf.sourceforge.net/ |
| 24 |
|
| 25 |
or |
| 26 |
|
| 27 |
http://sourceforge.net/projects/avf |
| 28 |
|
| 29 |
Forms of AVFS |
| 30 |
------------- |
| 31 |
|
| 32 |
AVFS can now be installed in four different ways. These are: |
| 33 |
|
| 34 |
- Fuse |
| 35 |
With fuse support, systems with 2.6 kernels are able to use avfs. |
| 36 |
The requirements are |
| 37 |
1) fuse support be compiled into the kernel or fuse modules |
| 38 |
loaded. |
| 39 |
2) the fuse package and library >= 2.4 be installed. |
| 40 |
|
| 41 |
- Library |
| 42 |
AVFS can be used as a shared library for programs written to |
| 43 |
utilize AVFS. This is a pure userspace library so it should |
| 44 |
work on any POSIX system. |
| 45 |
|
| 46 |
Using AVFS is very similar in all cases. Differences will be indicated. |
| 47 |
|
| 48 |
The installation method is different. For installation instructions |
| 49 |
see the files 'INSTALL.fuse' and 'INSTALL.library' respectively all |
| 50 |
located in the doc/ directory. |
| 51 |
|
| 52 |
Using AVFS |
| 53 |
---------- |
| 54 |
|
| 55 |
These instructions are not for the fuse installation. Please see the file |
| 56 |
README.avfs-fuse for details on how these commands are applied. |
| 57 |
|
| 58 |
It is quite simple, you just do everything with the virtual files, as |
| 59 |
you would do with real files. Here are some examples: |
| 60 |
|
| 61 |
Listing a tar archive: |
| 62 |
|
| 63 |
ls -l avfs-0.9.1.tgz#/ |
| 64 |
ls -l avfs-0.9.1.tgz#/avfs-0.9.1/ |
| 65 |
|
| 66 |
Obtaining information about avfs itself: |
| 67 |
|
| 68 |
cat /#avfsstat/copyright - prints copyright information and version |
| 69 |
cat /#avfsstat/modules - lists available handlers |
| 70 |
cat /#avfsstat/version - prints version information |
| 71 |
|
| 72 |
'cd' into an archive: |
| 73 |
|
| 74 |
cd avfs-0.9.1.tgz#/ |
| 75 |
less avfs-0.9.1/README |
| 76 |
|
| 77 |
Some more examples: (these are all shell commands, but of course you |
| 78 |
could use any program: file manager, browser, editor, etc.) |
| 79 |
|
| 80 |
Unpacking an archive: |
| 81 |
|
| 82 |
cp -a tarfile.tgz#/dir . |
| 83 |
cp -a zipfile.zip#/* . |
| 84 |
|
| 85 |
Creating an archive: |
| 86 |
|
| 87 |
mkdir tarfile.tgz#+ |
| 88 |
cp -a dir tarfile.tgz#+/ |
| 89 |
|
| 90 |
Note: The efficiency of this method is not yet the same as the |
| 91 |
'normal' archive creation method, but it should not be more than 2 |
| 92 |
times slower. |
| 93 |
|
| 94 |
|
| 95 |
If something doesn't work, then check the section 'Common Problems'. |
| 96 |
|
| 97 |
|
| 98 |
Format of an AVFS Path |
| 99 |
---------------------- |
| 100 |
|
| 101 |
(For a full explanation of the format see the file FORMAT) |
| 102 |
|
| 103 |
As you've seen, the '#' magic character makes a virtual file or |
| 104 |
directory from an ordinary file. Actually this is just a shorthand for |
| 105 |
the full specification of an AVFS path: |
| 106 |
|
| 107 |
'tarfile.tgz#' is the same as 'tarfile.tgz#ugz#utar' |
| 108 |
|
| 109 |
Note, the short version will only work if the file-extension is |
| 110 |
recognized (most are), but you can always tell exactly what should be |
| 111 |
done with the file by using the second method. |
| 112 |
|
| 113 |
There are handlers which do not have a "base" file. The following |
| 114 |
handlers are like this: floppy, ftp, rsh, ssh, http, dav, avfsstat, |
| 115 |
volatile, rpms, ucftp. |
| 116 |
|
| 117 |
Examples |
| 118 |
|
| 119 |
/#floppy:a - a: drive |
| 120 |
/#a - a: drive (alias for /#floppy:a) |
| 121 |
/#rsh:otherhost/foo/bar - /foo/bar on 'otherhost' |
| 122 |
/#ssh:user@host/dir - /dir on 'host', login as 'user' |
| 123 |
/#ftp:ftp.funet.fi/pub/Linux - anonymous ftp |
| 124 |
/#ftp:[email protected]/home/xyz/file - ftp with username 'user' |
| 125 |
/#ftp_ctl:[email protected]/password - write the password to this file |
| 126 |
(ftppass is a nice utility for this) |
| 127 |
/#http:www.inf.bme.hu|~mszeredi|avfs| - homepage of AVFS |
| 128 |
/#http:ftp:||ftp.funet.fi|pub|Linux - use HTTP to get an ftp URL |
| 129 |
(useful if you use a HTTP-only proxy) |
| 130 |
/#dav:http:host.domain.org/home/ - WebDAV |
| 131 |
|
| 132 |
The environment variable 'http_proxy' is used to set the default value |
| 133 |
of the proxy server. You can also set it's value by writing to the file |
| 134 |
|
| 135 |
/#avfsstat/http_proxy |
| 136 |
|
| 137 |
|
| 138 |
The following "handlers" are available now: |
| 139 |
|
| 140 |
name of handler type of operation notes |
| 141 |
--------------- ----------------- ----- |
| 142 |
#a first floppy drive alias for #floppy:a |
| 143 |
#avfsstat meta information builtin |
| 144 |
#bz2 bzip2 uses bzip2 |
| 145 |
#dav webdav builtin |
| 146 |
#dav_ctl control dav sessions |
| 147 |
#floppy floppy uses mtools (mdir, mcopy, ...) |
| 148 |
#ftp ftp builtin |
| 149 |
#ftp_ctl control ftp sessions |
| 150 |
#gz gzip uses gzip |
| 151 |
#iso9660 CD/DVD filesystem no need to use mount -t iso9660! |
| 152 |
#local local filesysem only for internal use |
| 153 |
#rsh rsh/rcp only works if rsh needs no password |
| 154 |
#ssh ssh/scp only works if ssh needs no password |
| 155 |
#uar un-ar builtin |
| 156 |
#ubz2 bunzip2 builtin |
| 157 |
#ubzip2 bunzip2 uses bzip2 |
| 158 |
#ucftp ftp builtin (write support, no file cache) |
| 159 |
#ucftp_ctl control ftp sessions |
| 160 |
#ugz gunzip builtin (1) |
| 161 |
#ugzip gunzip uses gzip |
| 162 |
#ulzip unlzip builtin |
| 163 |
#urar unrar builtin list + uses rar to extract |
| 164 |
#utar untar builtin |
| 165 |
#uxz unxz/unlzma builtin |
| 166 |
#uxze unxz/unlzma uses xz |
| 167 |
#uz uncompress uses gzip |
| 168 |
#uzip unzip builtin |
| 169 |
#uzstd uzstd builtin |
| 170 |
#uzstde uzstd uses zstd |
| 171 |
#volatile 'memory fs' mainly for testing |
| 172 |
|
| 173 |
|
| 174 |
(1) With the '-s' option (blala.gz#-s) the gunzip module will use the |
| 175 |
size stored at the end of the gzip file. This will make some |
| 176 |
operations on a .gz file much faster, but it isn't usable for huge |
| 177 |
(>=4GByte) files, since the size is stored in 32 bits :(. |
| 178 |
|
| 179 |
The following handlers are available through Midnight Commanders |
| 180 |
'extfs'. These were not written by me, and could contain security |
| 181 |
holes. Nonetheless some of them are quite useful. For documentation |
| 182 |
on these, see the files in /usr/lib/avfs/extfs. |
| 183 |
|
| 184 |
name of handler type of operation |
| 185 |
--------------- ----------------- |
| 186 |
#deb debian packages |
| 187 |
#ftplist ? |
| 188 |
#hp48 ? |
| 189 |
#lslR directory tree listings |
| 190 |
#mailfs ? |
| 191 |
#patchfs browse patch files |
| 192 |
#rpm rpm packages |
| 193 |
#rpms List of installed rpms |
| 194 |
#trpm Useful inside #rpms |
| 195 |
#ucpio cpio archives |
| 196 |
#ulha lha archives |
| 197 |
#uzoo zoo archives |
| 198 |
|
| 199 |
|
| 200 |
Special #avfsstat files |
| 201 |
----------------------- |
| 202 |
|
| 203 |
symlink_rewrite: write '1' to it to let it change absolute |
| 204 |
symlinks to relative ones |
| 205 |
xz_memlimit: the amount of bytes used for xz decoder |
| 206 |
xz_memlimit_hit: the number of occurrences the xz decoder hit |
| 207 |
its memory limit |
| 208 |
|
| 209 |
|
| 210 |
Writing new modules |
| 211 |
------------------- |
| 212 |
|
| 213 |
You want to write a handler module for XY? Great! Please contact me, |
| 214 |
and I can give you some advice regarding this. |
| 215 |
|
| 216 |
Credits |
| 217 |
------- |
| 218 |
|
| 219 |
David Hanak ([email protected]) has contibuted the "rar" and the |
| 220 |
"archive" modules, and lots of ideas to AVFS. |
| 221 |
|
| 222 |
The VFS in Midnight Commander, written by Jakub Jelinek and Miguel de |
| 223 |
Icaza <[email protected]>, has greatly helped me write this |
| 224 |
library, and will probably continue to do so in the future. |
| 225 |
|
| 226 |
Pavel Machek, who is the current maintainer of Midnight VFS, and who |
| 227 |
has contributed lots of ideas and the alien module (which |
| 228 |
unfortunately I did not have time to get into shape) to AVFS. The |
| 229 |
'avfscoda' solution grew out of Pavels 'podfuk'. Most of it has been |
| 230 |
changed, but the original idea is from Pavel. |
| 231 |
|
| 232 |
Justin Mason <[email protected]> contributed the dav module. |
| 233 |
|
| 234 |
Koblinger Egmont <[email protected]> has written the "recursive |
| 235 |
profile" scripts, set up the mailing list, and also sent me many good |
| 236 |
ideas. |
| 237 |
|
| 238 |
The zip and gzip file handler is based on the zlib compression and |
| 239 |
decompression library, written by Jean-loup Gailly and Mark Adler. |
| 240 |
|
| 241 |
The bzip2 handler uses the libbzip2 library written by Julian R |
| 242 |
Seward. |
| 243 |
|
| 244 |
The tar file handler is based on the GNU tar source, originally |
| 245 |
written by John Gilmore. |
| 246 |
|
| 247 |
People, who sent me ideas or bug-reports: |
| 248 |
Jan Niehusmann <[email protected]> |
| 249 |
Demon of the Known Universe <[email protected]> |
| 250 |
Duncan Pierce <[email protected]> |
| 251 |
Scott F. Johnston <[email protected]> |
| 252 |
Larry Riedel <[email protected]> |
| 253 |
|
| 254 |
The Future |
| 255 |
---------- |
| 256 |
|
| 257 |
I hope AVFS will grow up to be a standard virtual file library, for which |
| 258 |
people can write handler modules (or plugins, if you like) for whatever |
| 259 |
they want. |
| 260 |
|
| 261 |
If you think AVFS is a good idea, and you have any comments or suggestions, |
| 262 |
please send me an email about them. |
| 263 |
|
| 264 |
Have fun, |
| 265 |
|
| 266 |
Miklos Szeredi <[email protected]> |
| 267 |
|