Denys Vlasenko e064bd60df De-inline a few functions which are large 15 years ago
..
extfs ad42905ecf Ticket #1477: incorrect detection of compressed patchfs 15 years ago
samba b09a107190 further include file fixups 15 years ago
.gitignore aad7c6c317 Added .svnignore files (same as .cvsignore) 16 years ago
COPYING.LGPL 1f60f44145 Update postal address of Free Software Foundation. 19 years ago
HACKING 6f9f431ae6 Initial version of technical documentation for VFS. 21 years ago
Makefile.am f0182a6969 Fix compile mcserv helper 15 years ago
README abcd23406d remove ChangeLog files from mc tree 15 years ago
README.fish 349d70c8cf Typos. 21 years ago
cpio.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
direntry.c fb51cb8241 Use TTY function names instead of #define's. 15 years ago
extfs.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
fish.c b933da347e vfs/fish.c: removed unused variable 15 years ago
fish.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
ftpfs.c f2e6817363 Ticket #1414: small refactoring before major modifications. 15 years ago
ftpfs.h b1b3be843c Ticket #121 (support IPv6). 15 years ago
gc.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
gc.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
local.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
local.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
mcfs.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
mcfs.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
mcfsutil.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
mcfsutil.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
mcserv.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
sfs.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
smbfs.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
smbfs.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
tar.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
tcputil.c 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
tcputil.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
undelfs.c 05b89b3bab VFS: removed unnedeed includes of tty/tty.h header. 15 years ago
utilvfs.c b1b3be843c Ticket #121 (support IPv6). 15 years ago
utilvfs.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago
vfs-impl.h 179e516c2a VFS: moved vfs_translate_url() declaration to the public scope. 15 years ago
vfs.c e064bd60df De-inline a few functions which are large 15 years ago
vfs.h 179e516c2a VFS: moved vfs_translate_url() declaration to the public scope. 15 years ago
xdirentry.h 0a7899709b Simple doxygen description for files in vfs (not subdirs) directory. 15 years ago

README

NOTE: Although vfs has been meant to be implemented as a separate
entity redistributable under the LGPL in its current implementation it
uses GPLed code from src/. So there are two possibilities if you want
to use vfs:

1. Distribute your copy of vfs under the GPL. Then you can freely
include the GPLed functions from the rest of the mc source code.

2. Distribute your copy of vfs under the LGPL. Then you cannot include
the functions outside the vfs subdirectory. You must then either
rewrite them or work around them in other ways.

========================================================================

Hi!

I'm midnight commander's vfs layer. Before you start hacking me,
please read this file. I'm integral part of midnight commander, but I
try to go out and live my life myself as a shared library, too. That
means that I should try to use as little functions from midnight as
possible (so I'm tiny, nice and people like me), that I should not
pollute name space by unnecessary symbols (so I do not crash fellow
programs) and that I should have a clean interface between myself and
midnight.

Because I'm rather close to midnight, try to:

* Keep the indentation as the rest of the code. Following could help
you with your friend emacs:

(defun mc-c-mode ()
"C mode with adjusted defaults for use with the Midnight commander."
(interactive)
(c-mode)
(c-set-style "K&R")
(setq c-indent-level 4
c-continued-statement-offset 4
c-brace-offset 0
c-argdecl-indent 4
c-label-offset -4
c-brace-imaginary-offset 0
c-continued-brace-offset 0
c-tab-always-indent nil
c-basic-offset 4
tab-width 8
comment-column 60))

(setq auto-mode-alist (cons '(".*/mc/.*\\.[ch]$" . mc-c-mode)
auto-mode-alist))

And because I'm trying to live life on my own as libvfs.so, try to:

* Make sure all exported symbols are defined in vfs.h and begin with
'vfs_'.

* Do not make any references from midnight into modules like tar. It
would probably pollute name space and midnight would depend on concrete
configuration of libvfs. mc_setctl() and mc_ctl() are your
friends. (And mine too :-).

Pavel Machek
pavel@ucw.cz

PS: If you'd like to use my features in whole operating system, you
might want to link me to rpc.nfsd. On
http://atrey.karlin.mff.cuni.cz/~pavel/podfuk/podfuk.html you'll find
how to do it.

PPS: I have a friend, shared library called avfs, which is LD_PRELOAD
capable. You can reach her at http://www.inf.bme.hu/~mszeredi/avfs.