mc/lib/vfs
Slava Zanko cedad03833 Move vfs_get_encoding() to path.c and make as static function.
Signed-off-by: Slava Zanko <slavazanko@gmail.com>
2011-06-23 14:44:59 +03:00
..
COPYING.LGPL VFS structure changes: 2011-03-21 11:48:26 +02:00
HACKING VFS structure changes: 2011-03-21 11:48:26 +02:00
Makefile.am VFS: removed interface.h 2011-06-23 14:44:59 +03:00
README VFS structure changes: 2011-03-21 11:48:26 +02:00
direntry.c VFS: many changes for use vfs_path_t 2011-06-23 14:44:59 +03:00
gc.c VFS: Current directory handler now have type vfs_path_t 2011-06-23 14:44:59 +03:00
gc.h Following prototypes of functions was changed in VFS-module API: 2011-06-23 14:44:58 +03:00
interface.c Removed vfs_path_t->unparsed_encoding. 2011-06-23 14:44:59 +03:00
netutil.c VFS structure changes: 2011-03-21 11:48:26 +02:00
netutil.h VFS structure changes: 2011-03-21 11:48:26 +02:00
path.c Move vfs_get_encoding() to path.c and make as static function. 2011-06-23 14:44:59 +03:00
path.h Removed vfs_path_t->unparsed_encoding. 2011-06-23 14:44:59 +03:00
utilvfs.c Ticket #2361: VFS URI reimplementation 2011-06-23 14:44:57 +03:00
utilvfs.h VFS: many changes for use vfs_path_t 2011-06-23 14:44:59 +03:00
vfs.c Move vfs_get_encoding() to path.c and make as static function. 2011-06-23 14:44:59 +03:00
vfs.h Move vfs_get_encoding() to path.c and make as static function. 2011-06-23 14:44:59 +03:00
xdirentry.h VFS: many changes for use vfs_path_t 2011-06-23 14:44:59 +03:00

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.